Methods
Objects
Click-to-call service.
| Method | Description |
|---|---|
| clicktocall/calls.cancel | Cancel a scheduled call. You cannot cancel a call that has already sta... |
| (DEPRECATED) List calls for a specific Voice App. | |
| clicktocall/calls.get_status | Get a call status. |
| clicktocall/calls.start_2 | Start 2 calls (party A, party B). |
clicktocall/calls.cancel
Cancel a scheduled call. You cannot cancel a call that has already started (obviously).
method: clicktocall/calls.cancel
params: [string call]
| Parameter | Type | Description | NULL |
|---|---|---|---|
| call | string |
Call identifier. Format: hash (Unique object identifier) |
NO |
| Type | Description | Format/Object |
|---|---|---|
| bool | Always TRUE, throws an Exception otherwise. |
clicktocall/calls.get_list
(DEPRECATED) List calls for a specific Voice App.
This method is DEPRECATED and may be removed in the future.
Relying on this method is highly discouraged.
method: clicktocall/calls.get_list
params: [string app, string from, string to]
| Parameter | Type | Description | NULL |
|---|---|---|---|
| app | string |
Voice App ID. Format: hash (Unique object identifier) |
NO |
| from | string |
List calls between this date (inclusive). Format: datetime (YYYY-MM-DD HH:MM:SS in UTC timezone. Example: "2012-04-24 23:42:00") |
NO |
| to | string |
And this date (inclusive). Format: datetime (YYYY-MM-DD HH:MM:SS in UTC timezone. Example: "2012-04-24 23:42:00") |
NO |
| Type | Description | Format/Object |
|---|---|---|
| array | Calls. | Array of CLICKTOCALL.Call objects. |
clicktocall/calls.get_status
Get a call status.
method: clicktocall/calls.get_status
params: [string hash]
| Parameter | Type | Description | NULL |
|---|---|---|---|
| hash | string |
Call identifier. Format: hash (Unique object identifier) |
NO |
| Type | Description | Format/Object |
|---|---|---|
| object | Call status. | Object: CLICKTOCALL.Call |
clicktocall/calls.start_2
Start 2 calls (party A, party B).
method: clicktocall/calls.start_2
params: [string app, array a_targets, array b_targets, object options]
| Parameter | Type | Description | NULL |
|---|---|---|---|
| app | string | The Click-to-Call Voice App ID. | NO |
| a_targets | array |
Party A targets (called first). If multiple Targets are provided, they are called sequentially until someone takes the call. Array of objects: Target |
NO |
| b_targets | array |
Party B targets (called if someone in A answered). If multiple Targets are provided, they are called sequentially until someone takes the call. Array of objects: Target |
NO |
| options | object |
Click-to-Call Options Object: CLICKTOCALL.Start.Options |
YES |
| Type | Description | Format/Object |
|---|---|---|
| string | Call identifier. | Format: hash (Unique object identifier) |