POST /api/v2/call/{id}/transfer
Transfers call to another recipient. Added on Sep 25, 2021 for API v2.
Rate limit: 1200 per minute.
Servers
- https://dialpad.com/
- https://sandbox.dialpad.com/
Path parameters
Name | Type | Required | Description |
---|---|---|---|
id |
Integer | Yes |
The call's id. |
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 |
---|---|---|---|
to |
No |
Destination of the call that will be transfer. It can be a single option between a number, an existing call or a target |
|
transfer_state |
String | No |
The state which the call should take when it's transferred to. Possible values:
|
custom_data |
String | No |
Extra data to associate with the call. This will be passed through to any subscribed call events. |
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.