Receive DTMF

Dual Tone Multi Frequency (DTMF) refers to the sounds or tones generated by a telephone when the digits 0-9 and the * and # characters are pressed. Equipment at the other end of the phone line listens to the specific sounds and decodes them into commands.

DTMF is used both for dialling a destination on a landline telephone and also for signalling to the remote end once a call is answered. Typically this is used to implement an Interactive Voice Response (IVR) system, or to enter information like a PIN number or a conference call pin. The EnableX Voice API collects information from callers which is then dispatched to the application for further processing.

DTMFs are asynchronous events, and EnableX expects API developers to provide a webhook, which will be invoked by the EnableX platform on the application server in the DTMF event. DTMFs are conveyed in plain text, but encrypted by the webhook security provided by the platform.

A sample DTMF event is shown below.

"voice_Id": "f1aa71c0-8f2a-4fe8-b5ef-9a330454ef58", // Call_Id
"channel_id":" fdgdfg451c0-8f2a-4fe8-b5ef-9addawrttfh",
"state": "dtmfcollected",
"digit": 12345,
"timestamp": "2017-02-16T10:52:00Z"

Note: DTMF events are different from digitcollected events, which are related to the voice menu. A DTMF event is received only after a call is bridged.

voice_idUnique call identifier.
channel_idUnique channel Id for which the DTMF is received.
digitValue of received DTMF.
stateState of received DTMF.
timestampUTC timestamp at which the event was generated.