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.
| 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, referComplete, 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] |
| StartTime | DateTime | Time the call was started, in ISO 8601 format. | [optional] |
| AnswerTime | DateTime? | Time the call was answered, 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] |
| ReferCallStatus | ReferCallStatusEnum | [optional] | |
| ReferSipResponseCode | 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] |
| NotifySipResponseCode | 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] |