Methods

Objects

clicktocall/calls

Click-to-Call. Start calls, get statuses, cancel scheduled calls, etc.

Method Description
clicktocall/calls.cancel Cancel a scheduled call. You cannot cancel a call that has already sta...
clicktocall/calls.get_list 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).

Methods

clicktocall/calls.cancel

Description

Cancel a scheduled call. You cannot cancel a call that has already started.

Signature

method: clicktocall/calls.cancel

params: [string call]

Parameters

Parameter Type Description NULL
call string Call identifier.
Format: hash (Unique object identifier)
NO

Result

Type Description Format/Object
bool Always TRUE, throws an Exception otherwise.

See Also

clicktocall/calls.get_list

Description

List calls for a specific Voice App.

Signature

method: clicktocall/calls.get_list

params: [string app, string from, string to]

Parameters

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

Result

Type Description Format/Object
array Calls. Array of CLICKTOCALL.Call objects.

clicktocall/calls.get_status

Description

Get a call status.

Signature

method: clicktocall/calls.get_status

params: [string hash]

Parameters

Parameter Type Description NULL
hash string Call identifier.
Format: hash (Unique object identifier)
NO

Result

Type Description Format/Object
object Call status. Object: CLICKTOCALL.Call

See Also

clicktocall/calls.start_2

Description

Start 2 calls (party A, party B).

Signature

method: clicktocall/calls.start_2

params: [string app, array a_targets, array b_targets, object options]

Parameters

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

Result

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

See Also