Call talk option

Using talk options

Talk options are configured in your personal account, "Virtual PBX" -> "Conversation Options". Calling an individual talk option again disables it. Examples of such options are Voice recorder and Call the coach (see the list.talk_options method).

Method	call.talk_option
API version	v4.0
Description	Calling a talk option configured in the client area of the virtual PBX
Return to list of methods

Request parameters

Name	Type	Required	Description
access_token	string	yes	Authentication session key
call_session_id	number	yes	A unique call session identifier that can be obtained in the response of the start.informer_call, start.vnumber_call, start.scenario_call, and start.employee_call methods, using the notification server or the DATA API.
button	string	yes	Key that calls up the talk option. Note: keys and actions are configured in your personal account.

Example request

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

Example response

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

List of returned errors

Error text	Error code	Mnemonics	Description
This method cannot be called in this state	-32004	invalid_state
Internal error, contact the support service	-32603	internal_error
Permission denied	-32003	forbidden	Cannot disable global call recording at the employee level
Call session not found	-32602	call_session_not_found
Talk option was not found	-32602	talk_option_not_found	Key not assigned

See also the section "List of errors common for all methods".