Methods
Objects
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 with Call Real-time. Control... |
| calls.realtime_break | Break the current command of a real-time controlled call |
calls.broadcast_1
Broadcast messages to a target.
method: calls.broadcast_1
params: [object target, array messages, object options]
| 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 |
| Type | Description | Format/Object |
|---|---|---|
| string | Request ID |
calls.get_status_1
Returns the status of a broadcast_1 call.
method: calls.get_status_1
params: [string request_id]
| Parameter | Type | Description | NULL |
|---|---|---|---|
| request_id | string | Request ID | NO |
| Type | Description | Format/Object |
|---|---|---|
| string | Call status |
calls.hangup
Hangup a call
method: calls.hangup
params: [int callid, object options]
| Parameter | Type | Description | NULL |
|---|---|---|---|
| callid | int |
Call ID Format: callid (64-bit unsigned integer) |
NO |
| options | object | Reserved for future use | NO |
| Type | Description | Format/Object |
|---|---|---|
| bool | Did it work? |
calls.realtime
Start an outbound call on a single target with Call Real-time. Control the call with a callback URL.
method: calls.realtime
params: [string app, object target, object options]
| 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 |
| Type | Description | Format/Object |
|---|---|---|
| string | Call Request ID | Format: hash (Unique object identifier) |
calls.realtime_break
Break the current command of a real-time controlled call
method: calls.realtime_break
params: [int callid, object options]
| Parameter | Type | Description | NULL |
|---|---|---|---|
| callid | int |
Calld ID Format: callid (64-bit unsigned integer) |
NO |
| options | object | Reserved for future use | NO |
| Type | Description | Format/Object |
|---|---|---|
| bool | Did it work? |