Skip to content

Latest commit

 

History

History
32 lines (24 loc) · 3.17 KB

File metadata and controls

32 lines (24 loc) · 3.17 KB

DisconnectCallback

The Disconnect event is fired when a call ends, for any reason.

Properties

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 OffsetDateTime 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]
callUrl URI The URL of the call associated with the event. [optional]
enqueuedTime OffsetDateTime (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format. [optional]
startTime OffsetDateTime Time the call was started, in ISO 8601 format. [optional]
answerTime OffsetDateTime Time the call was answered, in ISO 8601 format. [optional]
endTime OffsetDateTime The time that the recording ended in ISO-8601 format [optional]
cause String Reason the call failed - hangup, busy, timeout, cancel, rejected, callback-error, invalid-bxml, application-error, account-limit, node-capacity-exceeded, error, or unknown. [optional]
errorMessage String Text explaining the reason that caused the call to fail in case of errors. [optional]
errorId String Bandwidth's internal id that references the error event. [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]
sipCallId String (optional) The SIP Call-ID of the call's current SIP dialog with Bandwidth's SBC. Used to correlate dialogs and trace calls. Present on any call, inbound or outbound, once that dialog has been established; may be absent very early in a call before the dialog exists. [optional]
sipResponseCode Integer (optional) The SIP status code returned by Bandwidth's SBC when it rejected an outbound call's INVITE (e.g. 486 for busy, 603 for decline). Present only when an outbound call was rejected by the SBC. [optional]