Skip to content

InitiateCallback.md

Latest commit

 

History

History
46 lines (40 loc) · 3.7 KB

InitiateCallback.md

File metadata and controls

46 lines (40 loc) · 3.7 KB
Raw

Bandwidth::InitiateCallback

Properties

Name Type Description Notes
event_type 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]
event_time Time 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 String The user account associated with the call. [optional]
application_id 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]
call_id String The call id associated with the event. [optional]
call_url String The URL of the call associated with the event. [optional]
start_time Time Time the call was started, in ISO 8601 format. [optional]
diversion Diversion [optional]
stir_shaken StirShaken [optional]
uui String The value of the `User-To-User` header to send within the initial `INVITE`. Must include the encoding parameter as specified in RFC 7433. Only `base64`, `jwt` and `hex` encoding are currently allowed. This value, including the encoding specifier, may not exceed 256 characters. [optional]
sip_call_id 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]
sip_headers Hash<String, String> (optional) Map of customer-supplied X-* headers from the original INVITE. Keys are lowercase (SIP headers are case-insensitive). Present only for inbound SIP URI calls with custom headers. Note - keys preserve the original SIP header name in lowercase rather than Bandwidth's usual camelCase JSON convention, since these are passthrough values from the caller's SIP INVITE, not Bandwidth-defined fields. If the same header name is sent more than once in the INVITE, only the last value is kept. [optional]

Example

require 'bandwidth-sdk'

instance = Bandwidth::InitiateCallback.new(
  event_type: bridgeComplete,
  event_time: 2022-06-17T22:19:40.375Z,
  account_id: 9900000,
  application_id: 04e88489-df02-4e34-a0ee-27a91849555f,
  from: +15555555555,
  to: +15555555555,
  direction: null,
  call_id: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
  call_url: https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
  start_time: 2022-06-17T22:19:40.375Z,
  diversion: null,
  stir_shaken: null,
  uui: bXktdXVp,
  sip_call_id: c95ac8d6e1a31c52eb38f419893c151633ec68f8d@sbc.bandwidth.com,
  sip_headers: {&quot;x-custom-header&quot;:&quot;customer-value&quot;,&quot;x-session-id&quot;:&quot;sess-12345&quot;}
)