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.
| 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 | OffsetDateTime | 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 | URI | The URL of the call associated with the event. | [optional] |
| startTime | OffsetDateTime | Time the call was started, in ISO 8601 format. | [optional] |
| diversion | Diversion | [optional] | |
| stirShaken | 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] |
| sipCallId | 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] |
| sipHeaders | Map<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] |