Skip to content

List talk options

Receiving talk options list

Method list.talk_options
API version v4.0
Description Receiving a list of talk options set in the client area of your virtual PBX
Go back to list of methods

You can set talk options in your client area "Virtual PBX" -> "Talk options".

Parameters of a request

Title Type Required Description
access_token string yes Authentication session key

Parameters of a reply

Title Type Required Description
button string yes Button that is used to call talk options
mnemonic string yes Mnemonic name of a talk option Possible values:
  • finish_conversation - Finish conversation
  • tag_call - Tag call
  • record_talk - Voice recorder (recording calls)
  • transfer_call - Transfer
  • run_scenario - Run scenario
  • call_coach - Call coach
  • receive_fax - Receive fax
  • save_numa - Save AON to a group
name string yes Name of talk option
Option value
button_value object no Some options may contain names of tags, scenarios, etc. This object contains additional information on talk option
id number yes Unique ID of an object that is activated when calling a talk option. For example, ID of a scenario
value string yes Name of an object, that is activated when calling a talk option. For example, name of a scenario

Example of a request

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

Example of a reply

{
  "jsonrpc": "2.0",
  "id": "req1",
  "result": {
    "data": [
      {
        "button": "1",
        "mnemonic": "tag_call",
        "name": "Tag",
        "button_value": {
          "id": 254,
          "value": "Relevant"
        }
      }
    ]
  }
}