Record call

Managing call recording

Method	record.call
API version	v4.0
Description	Managing call recording. You can not switch off the recording of a call set via your client area.
Go back to list of methods

Method allows you to manage recording of an active call. You can not switch off universal recording of calls.

Parameters of a request

Title	Type	Required	Valid value	Description
access_token	string	yes		Authentication session key
call_session_id	number	yes		Unique ID of a call session, that you can get in a reply message after calling the methods start.informer_call, start.vnumber_call, start.scenario_call, start.employee_call, via a notification server or REST API.
action	string	yes	on, off	Operation on a call recording. on - switching on the recording, off - switching off the recording

Example of a request

{
  "jsonrpc": "2.0",
  "method": "record.call",
  "id": "req1",
  "params": {
    "access_token": "2fRN4g217ca0b4224a67988aff3e584f91964a692045415f36fa66146f5a3c1ae1f6093d",
    "call_session_id": 235496,
    "action": "on"
  }
}

Example of a reply

{
  "jsonrpc": "2.0",
  "id": "req1",
  "result": {
    "data": {
      "success": "true"
    }
  }
}

List of returning errors

Text of error	Code of error	Mnemonics of error	Description
Permission denied	-32003	forbidden	You can not switch off universal recording of call. Universal recording of call is an employee level setting.
The call record is already started	-32602	record_already_started	Recording already started
The call record is not enabled	-32602	record_already_stopped	Recording has not been started

Refer to List of errors common for all methods