PATCH /api/v2/users/{id}/activecall
Turns call recording on or off for a user's active call.
Added on Nov 18, 2019 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 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 |
|---|---|---|---|
is_recording |
Boolean | No |
Whether or not recording should be enabled. |
recording_type |
String | No |
Whether or not to toggle recording for the operator call (personal recording), the group call (department recording), or both. Only applicable for group calls (call centers, departments, etc.) Possible values:
Default value: "user" |
play_message |
Boolean | No |
Whether or not to play a message to indicate the call is being recorded (or recording has stopped). Default value: true |
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.