Skip to content

Latest commit

 

History

History
30 lines (26 loc) · 3.51 KB

TransferDisconnectCallback.md

File metadata and controls

30 lines (26 loc) · 3.51 KB
Raw

Bandwidth.Standard.Model.TransferDisconnectCallback

This event is sent to the transferDisconnectUrl of each tag when its respective call leg ends for any reason. The event is sent in the normal case, when the transferred leg is answered and later hung up, but is also sent if the new leg was never answered in the first place, if it was rejected, and if the original call leg hung up before the transferred leg.

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 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]
Direction CallDirectionEnum [optional]
CallId string The call id associated with the event. [optional]
CallUrl string The URL of the call associated with the event. [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]
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]
EndTime DateTime The time that the recording ended in ISO-8601 format [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]
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]
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]

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