Send dtmf

Sending DTMF by an employee

Method	send.dtmf
API version	v4.0
Description	Sending DTMF by an employee. The method is used if there is an IVR on the client side and you need to select a menu item in it.
Return to list of methods

Request parameters

Name	Type	Required	Valid values	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.
dtmf_string	string	yes	0-9, *, #	Specifies the DTMF that will be sent to the subscriber specified in the contact parameter, in the case of an outgoing call from a virtual PBX to the called subscriber. Note: DTMF sending is only possible with single characters. It is also possible to call configured talk options. For outgoing calls, talk options become available after 30 seconds.

Example request

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

Example response

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