SendDTMF

This operation is part of the Voice API section of the Web Services API.

Overview

Sends the provided DTMF digits. You can send DTMF digits individually with multiple requests or together with multiple digits in one request.

Important

If your solution uses SIP Server, you might need to set the sip-dtmf-send-rtp option to true for this request to succeed. Consult the SIP Server documentation for details.

Request URL	/api/v2/me/calls/{id}
HTTP method	POST
Required features	api-voice

Parameters

Parameter	Value
operationName	SendDtmf
digits	A string consisting of one or more digits (0-9).

Sample

Request

POST api/v2/me/calls/012PUFMMS0ASNAK48O7GK2LAES00000J
{
  "operationName": "SendDtmf",
  "digits": "5"
}

HTTP response

{
  "statusCode": 0
}

CometD notification

{  
   "data":{  
      "notificationType":"DtmfSent",
      "call":{  
         "id":"012PUFMMS0ASNAK48O7GK2LAES00000J",
         "state":"Established",
         "callUuid":"012PUFMMS0ASNAK48O7GK2LAES00000J",
         "connId":"007102719260b013",
         "deviceUri":"http://127.0.0.1:8080/api/v2/devices/631608b3-ceb1-472b-ba05-2ae39555b0d1",
         "participants":[  
            {  
               "e164Number":"",
               "formattedPhoneNumber":"15001",
               "phoneNumber":"15001",
               "digits":"15001"
            }
         ],
         "dnis":"15000",
         "callType":"Internal",
         "capabilities":[  
            "SingleStepTransfer",
            "InitiateConference",
            "Hold",
            "SingleStepConference",
            "InitiateTransfer",
            "SendDtmf",
            "DeleteUserData",
            "AttachUserData",
            "DeleteUserDataPair",
            "Hangup",
            "UpdateUserData"
         ],
         "duration":"27",
         "mute":"Off",
         "supervisorListeningIn":false,
         "monitoredUserMuted":false,
         "monitoring":false,
         "uri":"http://127.0.0.1:8080/api/v2/me/calls/012PUFMMS0ASNAK48O7GK2LAES00000J",
         "path":"/calls/012PUFMMS0ASNAK48O7GK2LAES00000J"
      },
      "phoneNumber":"15000",
      "extensions":{  
         "BusinessCall":0
      },
      "messageType":"CallStateChangeMessage"
   },
   "channel":"/v2/me/calls"
}