Voice Application
For the impatient
You may explore this data model via the API Playground, by clicking here
Endpoints
/domains/{domain}/applications[/{application-name}](alias to/customers/self/domains/{domain}/applications)/customers/{customer}/domains/{domain}/applications[/{application-name}]
The Cloudonix application model represents deployment of voice applications into a domain. Each application object refers to either:
- An application installed on customer's servers.
- A Container Application installed in the customer's account.
- A Cloudonix built-in application.
An application object contains the configuration required by the Cloudonix voice application runtime engine (APP.Core) to execute the application.
Properties
| Property | Type | Editable | Description |
|---|---|---|---|
domain | Object | No | The Cloudonix Domain object that this application belnogs to |
name | String | Create | The application configuration name |
profile | Object | Create, Update | A set of metadata properties that can be assigned to the application. The customer may also update the profile with whatever metadata they wish to store in Cloudonix. |
type | String | Create, Update | The application protocol. Currently supported values are twiml for TwiML compatible applications or cxml for Cloudonix XML applications (backwards compatible to TwiML and supports some Cloudonix specific capabilities). |
url | String | Create, Update | The application start URL. This can be either a standard HTTP or HTTPS URL for customer Container Applications, or a cx: URL for Cloudonix hosted and built-in applications. |
method | String | Create, Update | The HTTP method used to call the application, can be either GET or POST. Default: GET |
active | Boolean | Update | Whether the application is enabled and will be executed. Default: true |
Application Profile Properties
The following properties are recognized by Cloudonix when set in the application's profile field:
| Property | Type | Editable | Description |
|---|---|---|---|
status-start-ringing | Boolean | Create, Update | Requires that CXML application requests sent to the application before the call is answered will always have the CallStatus field set to ringing regardless of the actual status. |
send-progress | Boolean | Create, Update | Control whether the voice application engine sends ring tone to the caller before starting to run the application. Default: true |
auto-answer | Boolean | Create, Update | Control whether the voice application engine will automatically answer the incoming call before starting to run the application. Default false |