POST /api/v2/users/{id}/initiate_call
Causes a user's native Dialpad application to initiate an outbound call. Added on Nov 18, 2019 for API v2.
Rate limit: 5 per minute.
Servers
- https://dialpad.com/
- https://sandbox.dialpad.com/
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | Yes |
The user's id. ('me' can be used if you are using a user level API key) |
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 |
String | No |
Extra data to associate with the call. This will be passed through to any subscribed call events. |
outbound_caller_id |
String | 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 |
String | No |
The type of a group that will be used to initiate the call. Possible values:
|
phone_number |
String | No |
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.