Application Callout
Introduction
The Application Callout method creates a new outbound call request for a specified application. This could be used to make multiple calls from the application through a simple API.
Parameters
| Name | Type | Description |
|---|---|---|
| SubscriptionID | string | The subscription ID to be used |
| ID | string | The ID of the Application |
| Model | Callout Model | The Callout details |
Model
The model is passed through as a JSON body. The fields to fill out for the model are below:
| Name | Description |
|---|---|
| CallerID | What should appear as the Caller ID |
| Destination | The number to be called |
| Provider | The call provider (more info - Setting up a provider) |
| Timeout | The amount of time to wait before timing out (seconds) |
| Webhook | The URL to be used for HTTP callback. optional |
| MessageGroup | The group of messages the call belongs to. optional |
Usage
Swagger
To use the callout feature in Swagger, enter your SubscriptionID and the ID of the application you wish to use.
Click the 'Model Schema' and enter the necessary values into the model fields.
Click the 'Try it out! button and check the response or webhook to see if it worked.
Webhook
The webhook can be used to enter a URL that will accept the HTTP callback, allowing you to see the details of the call. MessageID, Status and Message will be returned.
Webhook Model
| Name | Type | Description |
|---|---|---|
| MessageId | Guid/string | The unique ID of this request, available in the apps platform during a call too |
| Status | Status | Current status of the call request. See below |
| Message | string | Associated message of current status |
| CallDetails | DetailsModel | Additional information about the call. See below |
Status
These are the possible status values:
| Name | Integer | Description |
|---|---|---|
| Received | 0 | The call was received. |
| Connecting | 1 | The call is connecting. |
| Busy | 2 | The line was busy when the call was made. |
| Connected | 3 | The call is connected. |
| Hangup | 4 | The call was hung up. |
| Failed | 5 | The call failed. |
IP Addresses
Your firewall may block the Webhook, more information can be found on white listing IP Addresses on the general Webhooks page