The DTMF event is sent for every digit detected after a verb is executed. You may not respond to this event with BXML.
Name | Type | Description | Notes |
---|---|---|---|
EventType | string | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
EventTime | DateTime | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. | [optional] |
AccountId | string | The user account associated with the call. | [optional] |
ApplicationId | string | The id of the application associated with the call. | [optional] |
From | string | The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). | [optional] |
To | string | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] |
CallId | string | The call id associated with the event. | [optional] |
Direction | CallDirectionEnum | [optional] | |
Digit | string | The digit collected in the call. | [optional] |
CallUrl | string | The URL of the call associated with the event. | [optional] |
EnqueuedTime | DateTime? | (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format. | [optional] |
StartTime | DateTime | Time the call was started, in ISO 8601 format. | [optional] |
AnswerTime | DateTime? | Time the call was answered, in ISO 8601 format. | [optional] |
ParentCallId | string | (optional) If the event is related to the B leg of a <Transfer>, the call id of the original call leg that executed the <Transfer>. Otherwise, this field will not be present. | [optional] |
TransferCallerId | string | The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] |
TransferTo | string | The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] |
Tag | string | (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. | [optional] |