Managing call recording
| Method | record.call |
|---|---|
| API version | v4.0 |
| Description | Conversation recording management. It is impossible to disable the recording of a conversation configured through your personal account. |
| Return to list of methods | |
The method allows you to manage the recording of an active conversation. Global conversation recording cannot be turned off.
Request parameters
| Title | Type | Required | Valid values | Description |
|---|---|---|---|---|
| access_token | string | yes | Authentication session key | |
| call_session_id | number | yes | A unique call session identifier that can be received in a response message when calling the start.informer_call, start.vnumber_call, start.scenario_call, start.employee_call methods using the notification server or DATA API. | |
| action | string | yes | on, off | Action on a conversation recording. on - enable conversation recording, off - disable conversation recording |
Example request```json
{ "jsonrpc": "2.0", "method": "record.call", "id": "req1", "params": { "access_token": "2fRN4g217ca0b4224a67988aff3e584f91964a692045415f36fa66146f5a3c1ae1f6093d", "call_session_id": 235496, "action": "on" } }
#### Sample answer```json
{
"jsonrpc": "2.0",
"id": "req1",
"result": {
"data": {
"success": "true"
}
}
}
List of returned errors
| Error text | Error code | Error mnemonics | Description |
|---|---|---|---|
| Permission denied | -32003 | forbidden |
It is not possible to disable global call recording. Global call recording is a setting at the employee setting level. |
| The call record is already started | -32602 | record_already_started |
Call recording is already enabled |
| The call record is not enabled | -32602 | record_already_stopped |
Call recording was not enabled |
See also section "List of errors common to all methods"