Skip to content

Latest commit

 

History

History
46 lines (37 loc) · 3.32 KB

DtmfCallback.md

File metadata and controls

46 lines (37 loc) · 3.32 KB
Raw

DtmfCallback

The DTMF event is sent for every digit detected after a verb is executed. You may not respond to this event with BXML.

Properties

Name Type Description Notes
event_type str 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]
event_time 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]
account_id str The user account associated with the call. [optional]
application_id str The id of the application associated with the call. [optional]
var_from str The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). [optional]
to str The phone number that received the call, in E.164 format (e.g. +15555555555). [optional]
call_id str The call id associated with the event. [optional]
direction CallDirectionEnum [optional]
digit str The digit collected in the call. [optional]
call_url str The URL of the call associated with the event. [optional]
enqueued_time datetime (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format. [optional]
start_time datetime Time the call was started, in ISO 8601 format. [optional]
answer_time datetime Time the call was answered, in ISO 8601 format. [optional]
parent_call_id str (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]
transfer_caller_id str The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). [optional]
transfer_to str The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). [optional]
tag str (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. [optional]

Example

from bandwidth.models.dtmf_callback import DtmfCallback

# TODO update the JSON string below
json = "{}"
# create an instance of DtmfCallback from a JSON string
dtmf_callback_instance = DtmfCallback.from_json(json)
# print the JSON string representation of the object
print(DtmfCallback.to_json())

# convert the object into a dict
dtmf_callback_dict = dtmf_callback_instance.to_dict()
# create an instance of DtmfCallback from a dict
dtmf_callback_from_dict = DtmfCallback.from_dict(dtmf_callback_dict)

[Back to Model list] [Back to API list] [Back to README]