Methods
Objects
Voice Apps manipulation. Manage Call Tracking, Click-to-Call, 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. |
| DO NOT USE. Please use did.search instead. | |
| (DEPRECATED) List your Voice Apps. Please use search instead. | |
| List of authorized CLIs on your account. Please use cli.list | |
| apps.remove_did | Unassign a DID from its Voice App. |
| apps.search | Search apps |
apps.assign_did
Assign a DID to a Voice App. Only Call Tracking and Real-Time Apps can be assigned DIDs.
method: apps.assign_did
params: [string app, string did]
| Parameter | Type | Description | NULL |
|---|---|---|---|
| app | string |
App ID. Format: hash (Unique object identifier) |
NO |
| did | string |
DID ID. Format: hash (Unique object identifier) |
NO |
| Type | Description | Format/Object |
|---|---|---|
| bool | Always TRUE (throws an Exception otherwise). |
apps.create
Create a new Voice App, and optionally configure it at the same time.
method: apps.create
params: [string type, string name, object params]
| Parameter | Type | Description | NULL |
|---|---|---|---|
| type | string |
Voice App type. Values: "ACTIONS10", "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 |
| Type | Description | Format/Object |
|---|---|---|
| object | The just created Voice App. | Object: App |
apps.delete
Delete Voice App. If a DID is assigned to the Voice App, it is freed first.
method: apps.delete
params: [string hash]
| Parameter | Type | Description | NULL |
|---|---|---|---|
| hash | string |
App ID. Format: hash (Unique object identifier) |
NO |
| Type | Description | Format/Object |
|---|---|---|
| bool | Always TRUE (throws an Exception otherwise). |
apps.edit
Edit a Voice App.
method: apps.edit
params: [string hash, string name, object params]
| 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, ACTIONS10 |
YES |
| Type | Description | Format/Object |
|---|---|---|
| object | The edited Voice App. | Object: App |
apps.get
Get a Voice App.
method: apps.get
params: [string hash]
| Parameter | Type | Description | NULL |
|---|---|---|---|
| hash | string |
App ID. Format: hash (Unique object identifier) |
NO |
| Type | Description | Format/Object |
|---|---|---|
| object | The Voice App. | Object: App |
apps.get_dids
DO NOT USE. Please use did.search instead.
This method is DEPRECATED and may be removed in the future.
Relying on this method is highly discouraged.
method: apps.get_dids
params: [bool only_available]
| Parameter | Type | Description | NULL |
|---|---|---|---|
| only_available | bool | if TRUE, return only available DIDs. | NO |
| Type | Description | Format/Object |
|---|---|---|
| array | List of DIDs assigned to your account. | Array of DID objects. |
apps.get_list
(DEPRECATED) List your Voice Apps. Please use search instead.
This method is DEPRECATED and may be removed in the future.
Relying on this method is highly discouraged.
method: apps.get_list
params: [bool with_numbers]
| Parameter | Type | Description | NULL |
|---|---|---|---|
| with_numbers | bool | if TRUE, also returns the list of DIDs associated with each app. | NO |
| Type | Description | Format/Object |
|---|---|---|
| array | List of Voice Apps. | Array of App objects. |
apps.getAuthorizedCLIs
List of authorized CLIs on your account. Please use cli.list instead.
This method is DEPRECATED and may be removed in the future.
Relying on this method is highly discouraged.
method: apps.getAuthorizedCLIs
params: [string type]
| Parameter | Type | Description | NULL |
|---|---|---|---|
| type | string |
CLI type. Values: "CALL", "SMS" |
NO |
| Type | Description | Format/Object |
|---|---|---|
| array | Authorized CLIs. | Array of Customer.CLI objects. |
apps.remove_did
Unassign a DID from its Voice App.
method: apps.remove_did
params: [string did]
| Parameter | Type | Description | NULL |
|---|---|---|---|
| did | string |
DID ID. Format: hash (Unique object identifier) |
NO |
| Type | Description | Format/Object |
|---|---|---|
| bool | Always TRUE (throws an Exception otherwise). |
apps.search
Search apps
method: apps.search
params: [object filters, object options]
| Parameter | Type | Description | NULL |
|---|---|---|---|
| filters | object |
Search filters Object: App.SearchFilters |
NO |
| options | object |
Search options Object: Search.Options |
NO |
| Type | Description | Format/Object |
|---|---|---|
| object | Search results | Object: Search.Results |