TransferDisconnectCallback.md

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] [default to undefined]
eventTime	string	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] [default to undefined]
accountId	string	The user account associated with the call.	[optional] [default to undefined]
applicationId	string	The id of the application associated with the call.	[optional] [default to undefined]
from	string	The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555).	[optional] [default to undefined]
to	string	The phone number that received the call, in E.164 format (e.g. +15555555555).	[optional] [default to undefined]
direction	CallDirectionEnum		[optional] [default to undefined]
callId	string	The call id associated with the event.	[optional] [default to undefined]
callUrl	string	The URL of the call associated with the event.	[optional] [default to undefined]
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] [default to undefined]
enqueuedTime	string	(optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format.	[optional] [default to undefined]
startTime	string	Time the call was started, in ISO 8601 format.	[optional] [default to undefined]
answerTime	string	Time the call was answered, in ISO 8601 format.	[optional] [default to undefined]
endTime	string	The time that the recording ended in ISO-8601 format	[optional] [default to undefined]
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] [default to undefined]
transferCallerId	string	The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555).	[optional] [default to undefined]
transferTo	string	The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555).	[optional] [default to undefined]
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] [default to undefined]
errorMessage	string	Text explaining the reason that caused the call to fail in case of errors.	[optional] [default to undefined]
errorId	string	Bandwidth&#39;s internal id that references the error event.	[optional] [default to undefined]

Example

import { TransferDisconnectCallback } from 'bandwidth-sdk';

const instance: TransferDisconnectCallback = {
    eventType,
    eventTime,
    accountId,
    applicationId,
    from,
    to,
    direction,
    callId,
    callUrl,
    parentCallId,
    enqueuedTime,
    startTime,
    answerTime,
    endTime,
    tag,
    transferCallerId,
    transferTo,
    cause,
    errorMessage,
    errorId,
};

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