POST /api/v2/call/initiate_ivr_call
Initiates an outbound call to ring an IVR Workflow.
Added on Aug 14, 2023 for API v2.
Rate limit: 10 per minute per IVR.
Rate limit: 1200 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 |
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"). |
target_id |
Integer | Yes |
The ID of a group that will be used to initiate the call. |
target_type |
String | Yes |
The type of a group that will be used to initiate the call. Possible values:
|
phone_number |
String | 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.