Skip to content

Latest commit

 

History

History
44 lines (35 loc) · 3.49 KB

File metadata and controls

44 lines (35 loc) · 3.49 KB

ReferCompleteCallback

This event is sent to the referCompleteUrl of a call's verb when the SIP REFER flow completes. On success, the call has been torn down and the BXML returned from this callback is ignored. On failure, the call remains active and the BXML returned from this callback is executed on the call.

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, referComplete, 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]
direction CallDirectionEnum [optional]
call_id str The call id associated with the event. [optional]
call_url str The URL of the call associated with the event. [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]
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]
refer_call_status ReferCallStatusEnum [optional]
refer_sip_response_code int (optional) The SIP response code returned for the REFER request itself (e.g. 202, 405, 603). Present when a SIP response was received for the REFER. [optional]
notify_sip_response_code int (optional) The final SIP response code reported via NOTIFY (message/sipfrag body). Present only when the caller's endpoint sent a final NOTIFY (e.g. 200, 404, 486, 503). Not present on NOTIFY timeout or when the REFER was rejected before a subscription was established. [optional]

Example

from bandwidth.models.refer_complete_callback import ReferCompleteCallback

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

# convert the object into a dict
refer_complete_callback_dict = refer_complete_callback_instance.to_dict()
# create an instance of ReferCompleteCallback from a dict
refer_complete_callback_from_dict = ReferCompleteCallback.from_dict(refer_complete_callback_dict)

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