List talk options

Get a list of talk options

Method	list.talk_options
API version	v4.0
Description	Getting a list of talk options configured in the client area of the virtual PBX
Return to list of methods

Talk options are configured in your personal account "Virtual PBX" -> "Conversation Options".

Request parameters

Name	Type	Required	Description
access_token	string	yes	Authentication session key

Response parameters

Name		Type	Required	Description
button		string	yes	Key that calls up the talk option
mnemonic		string	yes	Talk option mnemonic name. Possible values: finish_conversation - End the conversation tag_call - Add a tag record_talk - Voice recorder (conversation recording) transfer_call - Transfer run_scenario - Run a scenario call_coach - Call the coach receive_fax - Receive a fax save_numa - Save caller ID to group.
name		string	yes	Talk option name
Option value
button_value		object	no	Some options may contain a tag name, scenario name, and so on. This object contains additional information about the talk option.
	id	number	yes	A unique object identifier activated when the talk option is called. For example, a scenario ID.
	value	string	yes	The name of the object activated when the talk option is called. For example, the scenario name.

Example request

{
  "jsonrpc": "2.0",
  "method": "list.talk_options",
  "id": "req1",
  "params": {
    "access_token": "2fRN4g217ca0b4224a67988aff3e584f91964a692045415f36fa66146f5a3c1ae1f6093d"
  }
}

Example response

{
  "jsonrpc": "2.0",
  "id": "req1",
  "result": {
    "data": [
      {
        "button": "1",
        "mnemonic": "tag_call",
        "name": "Add tag",
        "button_value": {
          "id": 254,
          "value": "Hot lead"
        }
      }
    ]
  }
}