Skip to content

Send dtmf

Sending DTMF by an employee

Method send.dtmf
API version v4.0
Description Sending DTMF by an employee. The method is used when client side has IVR and it requires for you to choose a menu option.
Go back to List of methods

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.
dtmf_string string yes 0-9, *, # Defines DTMF, that will be sent to a contact. In case of an outgoing call from a virtual PBX to a subscriber,
Sending DTMF is possible only via single symbols.
You can also call preset talk options. For incoming calls, talk options become available 30 seconds after the call.

Example of a request

{
  "jsonrpc": "2.0",
  "method": "send.dtmf",
  "id": "req1",
  "params": {
    "access_token": "2fRN4g217ca0b4224a67988aff3e584f91964a692045415f36fa66146f5a3c1ae1f6093d",
    "call_session_id": 27934036,
    "dtmf_string": "1"
  }
}

Example of a reply

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