Skip to content

Call talk option

Using talk options

You can manage talk options in your client area "Virtual PBX" -> "Talk options". Recall of certain talk options disables them. For example, Voice recorder, Call coach (refer to list.talk_options)

Method call.talk_option
API version v4.0
Description Calling talk option set in the client area of your virtual PBX
Go back to List of methods

Parameters of a request

Title Type Required 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.
button string yes Button, calling talk option.
Buttons and actions are set in your client area.

Example of a request

{
  "jsonrpc": "2.0",
  "method": "call.talk_option",
  "id": "req1",
  "params": {
    "access_token": "2fRN4g217ca0b4224a67988aff3e584f91964a692045415f36fa66146f5a3c1ae1f6093d",
    "call_session_id": 246578,
    "button": "1"
  }
}

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
This method can not be called in this state -32004 invalid_state
Internal error, contact the support service -32603 internal_error
Permission denied -32003 forbidden You can not switch off universal recording of calls at the level of employee settings
Call session not found -32602 call_session_not_found
Talk option not found -32602 talk_option_not_found Button is not set

Refer to List of errors common for all methods