Methods

Objects

calls

Outbound calls service.

Method Description
calls.broadcast_1 Broadcast messages to a target.
calls.get_status_1 Returns the status of a broadcast_1 call.
calls.hangup Hangup a call
calls.realtime Start an outbound call on a single target. Control the call in real-ti...

Methods

calls.broadcast_1

Description

Broadcast messages to a target.

Signature

method: calls.broadcast_1

params: [object target, array messages, object options]

Parameters

Parameter Type Description NULL
target object The target phone number
Object: Target
NO
messages array The list of messages to play
Format: rt_media (Media ID (int) or Text-to-Speech "TTS|TTS_EN-GB_DANIEL|Text to say")
NO
options object Options (CLI, etc.)
Object: Calls.Broadcast1.Options
YES

Result

Type Description Format/Object
string Request ID

calls.get_status_1

Description

Returns the status of a broadcast_1 call.

Signature

method: calls.get_status_1

params: [string request_id]

Parameters

Parameter Type Description NULL
request_id string Request ID NO

Result

Type Description Format/Object
string Call status

calls.hangup

Description

Hangup a call

Signature

method: calls.hangup

params: [int callid, object options]

Parameters

Parameter Type Description NULL
callid int Call ID
Format: callid (64-bit unsigned integer)
NO
options object Reserved for future use NO

Result

Type Description Format/Object
bool Did it work?

calls.realtime

Description

Start an outbound call on a single target. Control the call in real-time with a callback URL.
This method is an alias of : dialr/call.realtime

Signature

method: calls.realtime

params: [string app, object target, object options]

Parameters

Parameter Type Description NULL
app string Voice App ID. Must be of type REALTIME10.
Format: hash (Unique object identifier)
NO
target object The phone number to call.
Object: Target
NO
options object Call options (CLI, CDR field...).
Object: REALTIME10.Call.Options
YES

Result

Type Description Format/Object
string Call Request ID Format: hash (Unique object identifier)

See Also