Skip to content

Latest commit

 

History

History
44 lines (35 loc) · 3.82 KB

File metadata and controls

44 lines (35 loc) · 3.82 KB

InitiateCallback

The Initiate event is fired when an inbound call is received for a Telephone Number on your Account. It is sent to the URL specified in the application associated with the location (sip-peer) that the called telephone number belongs to.

Properties

Name Type Description Notes
event_type str 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]
event_time 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]
account_id str The user account associated with the call. [optional]
application_id str The id of the application associated with the call. [optional]
var_from str The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). [optional]
to str The phone number that received the call, in E.164 format (e.g. +15555555555). [optional]
direction CallDirectionEnum [optional]
call_id str The call id associated with the event. [optional]
call_url str The URL of the call associated with the event. [optional]
start_time datetime Time the call was started, in ISO 8601 format. [optional]
diversion Diversion [optional]
stir_shaken StirShaken [optional]
uui str 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 str (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 Dict[str, str] (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

from bandwidth.models.initiate_callback import InitiateCallback

# TODO update the JSON string below
json = "{}"
# create an instance of InitiateCallback from a JSON string
initiate_callback_instance = InitiateCallback.from_json(json)
# print the JSON string representation of the object
print(InitiateCallback.to_json())

# convert the object into a dict
initiate_callback_dict = initiate_callback_instance.to_dict()
# create an instance of InitiateCallback from a dict
initiate_callback_from_dict = InitiateCallback.from_dict(initiate_callback_dict)

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