Methods

Objects

apps

Voice Apps manipulation. Manage Call Tracking, Click-to-Call, DIALR and Real-Time Apps.

Method Description
apps.assign_did Assign a DID to a Voice App. Only Call Tracking and Real-Time Apps can...
apps.create Create a new Voice App, and optionally configure it at the same time.
apps.delete Delete Voice App. If a DID is assigned to the Voice App, it is freed f...
apps.edit Edit a Voice App.
apps.get Get a Voice App.
apps.get_authorized_clis List of authorized CLIs on your account.
apps.get_dids List of (available) DIDs assigned to your account.
apps.get_list List your Voice Apps.
apps.remove_did Unassign a DID from its Voice App.

Methods

apps.assign_did

Description

Assign a DID to a Voice App. Only Call Tracking and Real-Time Apps can be assigned DIDs.

Signature

method: apps.assign_did

params: [string app, string did]

Parameters

Parameter Type Description NULL
app string App ID.
Format: hash (Unique object identifier)
NO
did string DID ID.
Format: hash (Unique object identifier)
NO

Result

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

See Also

apps.create

Description

Create a new Voice App, and optionally configure it at the same time.

Signature

method: apps.create

params: [string type, string name, object params]

Parameters

Parameter Type Description NULL
type string Voice App type.
Values: "CALLTRACKING10", "CLICKTOCALL10", "REALTIME10"
NO
name string Voice App name.
Format: app_name (Limited to Unicode letters, numbers, parenthesis, space, dash and underscore)
NO
params object Voice App parameters (optional).
Objects: CALLTRACKING10, CLICKTOCALL10, REALTIME10
YES

Result

Type Description Format/Object
object The just created Voice App. Object: App

apps.delete

Description

Delete Voice App. If a DID is assigned to the Voice App, it is freed first.

Signature

method: apps.delete

params: [string hash]

Parameters

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

Result

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

apps.edit

Description

Edit a Voice App.

Signature

method: apps.edit

params: [string hash, string name, object params]

Parameters

Parameter Type Description NULL
hash string Voice App ID.
Format: hash (Unique object identifier)
NO
name string The App name. Send NULL if you do not want to edit the name. YES
params object Voice App parameters. You can send only the parameters you want to change.
Objects: CALLTRACKING10, CLICKTOCALL10, REALTIME10
YES

Result

Type Description Format/Object
object The edited Voice App. Object: App

apps.get

Description

Get a Voice App.

Signature

method: apps.get

params: [string hash]

Parameters

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

Result

Type Description Format/Object
object The Voice App. Object: App

apps.get_authorized_clis

Description

List of authorized CLIs on your account.

Signature

method: apps.get_authorized_clis

params: [string type]

Parameters

Parameter Type Description NULL
type string CLI type.
Values: "CALL", "SMS"
NO

Result

Type Description Format/Object
array Authorized CLIs. Array of Customer.CLI objects.

apps.get_dids

Description

List of (available) DIDs assigned to your account.

Signature

method: apps.get_dids

params: [bool only_available]

Parameters

Parameter Type Description NULL
only_available bool if TRUE, return only available DIDs. NO

Result

Type Description Format/Object
array List of DIDs assigned to your account. Array of DID objects.

apps.get_list

Description

List your Voice Apps.

Signature

method: apps.get_list

params: [bool with_numbers]

Parameters

Parameter Type Description NULL
with_numbers bool if TRUE, also returns the list of DIDs associated with each app. NO

Result

Type Description Format/Object
array List of Voice Apps. Array of App objects.

apps.remove_did

Description

Unassign a DID from its Voice App.

Signature

method: apps.remove_did

params: [string did]

Parameters

Parameter Type Description NULL
did string DID ID.
Format: hash (Unique object identifier)
NO

Result

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