POST /api/v2/call
Initiates an outbound call to ring all devices (or a single specified device).
Note that the user must have at least one active device (a web, desktop or mobile Dialpad app; a CTI application; or a physical deskphone).
Added on Feb 20, 2020 for API v2.
Rate limit: 5 per minute.
Servers
- https://dialpad.com/
- https://sandbox.dialpad.com/
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
custom_data |
Null | No |
Extra data to associate with the call. This will be passed through to any subscribed call events. |
device_id |
Null | No |
The device's id. |
outbound_caller_id |
Null | No |
The e164-formatted number shown to the call recipient (or "blocked"). If set to "blocked", the recipient will receive a call from "unknown caller". The number can be the caller's number, or the caller's group number if the group is provided, or the caller's company reserved number. |
group_id |
Integer | No |
The ID of a group that will be used to initiate the call. |
group_type |
Null | No |
The type of a group that will be used to initiate the call. Valid values:
|
user_id |
Integer | Yes |
The id of the user who should make the outbound call. |
is_consult |
Boolean | No |
Enables the creation of a second call. If there is an ongoing call, it puts it on hold. Default value: false |
phone_number |
Null | Yes |
The e164-formatted number to call. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.