POST /api/v2/subscriptions/call
Creates a call event subscription. A webhook_id is required so that we know to which url the events shall be sent. Call states can be used to limit the states for which call events are sent. A target_type and target_id may optionally be provided to scope the events only to the calls to/from that target.
See https://developers.dialpad.com/docs/call-events-logging for details on how call events work, including the payload structure, the meaning of different call states, and payload examples.
Note: To include the recording url in call events, your API key needs to have the "recordings_export" OAuth scope. For Dialpad Meetings call events, your API key needs to have the "conference:all" OAuth scope.
Added on April 23rd, 2021 for API v2.
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 |
|---|---|---|---|
group_calls_only |
Boolean | No |
Call event subscription for group calls only. |
endpoint_id |
Integer | No |
The logging endpoint's ID, which is generated after creating a webhook or websocket successfully. |
call_states[] |
Array | No |
The call event subscription's list of call states. |
enabled |
Boolean | No |
Whether or not the call event subscription is enabled. Default value: true |
target_id |
Integer | No |
The ID of the specific target for which events should be sent. |
target_type |
String | No |
The target type. Possible values:
|
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.