diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index 3573294..52c0736 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -182,6 +182,8 @@ docs/RecordingTranscriptions.md docs/RecordingsApi.md docs/RedirectCallback.md docs/RedirectMethodEnum.md +docs/ReferCallStatusEnum.md +docs/ReferCompleteCallback.md docs/SipConnectionMetadata.md docs/SipCredentials.md docs/SmsMessageContent.md @@ -387,6 +389,8 @@ models/recording-transcription-metadata.ts models/recording-transcriptions.ts models/redirect-callback.ts models/redirect-method-enum.ts +models/refer-call-status-enum.ts +models/refer-complete-callback.ts models/sip-connection-metadata.ts models/sip-credentials.ts models/sms-message-content.ts diff --git a/.openapi-generator/VERSION b/.openapi-generator/VERSION index 6328c54..0783219 100644 --- a/.openapi-generator/VERSION +++ b/.openapi-generator/VERSION @@ -1 +1 @@ -7.17.0 +7.24.0 diff --git a/README.md b/README.md index 9f024b8..89740b4 100644 --- a/README.md +++ b/README.md @@ -322,6 +322,8 @@ Class | Method | HTTP request | Description - [RecordingTranscriptions](docs/RecordingTranscriptions.md) - [RedirectCallback](docs/RedirectCallback.md) - [RedirectMethodEnum](docs/RedirectMethodEnum.md) + - [ReferCallStatusEnum](docs/ReferCallStatusEnum.md) + - [ReferCompleteCallback](docs/ReferCompleteCallback.md) - [SipConnectionMetadata](docs/SipConnectionMetadata.md) - [SipCredentials](docs/SipCredentials.md) - [SmsMessageContent](docs/SmsMessageContent.md) diff --git a/bandwidth.yml b/bandwidth.yml index 8764a42..4b88b45 100644 --- a/bandwidth.yml +++ b/bandwidth.yml @@ -3184,6 +3184,13 @@ components: - outbound description: The direction of the call. example: inbound + referCallStatusEnum: + type: string + enum: + - success + - failure + description: The outcome of the REFER operation. + example: success fileFormatEnum: type: string enum: @@ -5134,6 +5141,45 @@ components: $ref: '#/components/schemas/transferCallerId' transferTo: $ref: '#/components/schemas/transferTo' + referCompleteCallback: + type: object + description: >- + 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. + properties: + eventType: + $ref: '#/components/schemas/eventType' + eventTime: + $ref: '#/components/schemas/eventTime' + accountId: + $ref: '#/components/schemas/accountId' + applicationId: + $ref: '#/components/schemas/applicationId1' + from: + $ref: '#/components/schemas/from' + to: + $ref: '#/components/schemas/to' + direction: + $ref: '#/components/schemas/callDirectionEnum' + callId: + $ref: '#/components/schemas/callId' + callUrl: + $ref: '#/components/schemas/callUrl' + startTime: + $ref: '#/components/schemas/startTime' + answerTime: + $ref: '#/components/schemas/answerTime' + tag: + $ref: '#/components/schemas/tag1' + referCallStatus: + $ref: '#/components/schemas/referCallStatusEnum' + referSipResponseCode: + $ref: '#/components/schemas/referSipResponseCode' + notifySipResponseCode: + $ref: '#/components/schemas/notifySipResponseCode' transcriptionAvailableCallback: type: object description: >- @@ -5326,8 +5372,8 @@ components: conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, - recordingAvailable, redirect, transcriptionAvailable, transferAnswer, - transferComplete, transferDisconnect. + recordingAvailable, redirect, referComplete, transcriptionAvailable, + transferAnswer, transferComplete, transferDisconnect. example: bridgeComplete eventTime: type: string @@ -5479,6 +5525,21 @@ components: or it was previously cleared, this field will not be present. example: exampleTag nullable: true + referSipResponseCode: + type: integer + description: >- + (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. + example: 202 + notifySipResponseCode: + type: integer + description: >- + (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. + example: 200 cause: type: string description: >- diff --git a/docs/AnswerCallback.md b/docs/AnswerCallback.md index e7aed98..d554cf3 100644 --- a/docs/AnswerCallback.md +++ b/docs/AnswerCallback.md @@ -6,7 +6,7 @@ The Answer event is sent to the answerUrl specified in the createCall request wh 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] +**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] [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] diff --git a/docs/BridgeCompleteCallback.md b/docs/BridgeCompleteCallback.md index 90299cd..5478694 100644 --- a/docs/BridgeCompleteCallback.md +++ b/docs/BridgeCompleteCallback.md @@ -6,7 +6,7 @@ If the target call leaves the , then this callback is sent to the bridge 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] +**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] [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] diff --git a/docs/BridgeTargetCompleteCallback.md b/docs/BridgeTargetCompleteCallback.md index e4cb645..2deda23 100644 --- a/docs/BridgeTargetCompleteCallback.md +++ b/docs/BridgeTargetCompleteCallback.md @@ -6,7 +6,7 @@ If the originating call leaves the , then this callback is sent to the b 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] +**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] [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] diff --git a/docs/ConferenceCompletedCallback.md b/docs/ConferenceCompletedCallback.md index 330acc8..f707d46 100644 --- a/docs/ConferenceCompletedCallback.md +++ b/docs/ConferenceCompletedCallback.md @@ -6,7 +6,7 @@ The Conference Completed event is fired when the last member leaves the conferen 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] +**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] [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] **conferenceId** | **string** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] [default to undefined] **name** | **string** | The user-specified name of the conference that was recorded | [optional] [default to undefined] diff --git a/docs/ConferenceCreatedCallback.md b/docs/ConferenceCreatedCallback.md index bb9c11e..3367aa6 100644 --- a/docs/ConferenceCreatedCallback.md +++ b/docs/ConferenceCreatedCallback.md @@ -6,7 +6,7 @@ The Conference Created event is fired whenever a new conference that specified a 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] +**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] [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] **conferenceId** | **string** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] [default to undefined] **name** | **string** | The user-specified name of the conference that was recorded | [optional] [default to undefined] diff --git a/docs/ConferenceMemberExitCallback.md b/docs/ConferenceMemberExitCallback.md index 5441552..17aec43 100644 --- a/docs/ConferenceMemberExitCallback.md +++ b/docs/ConferenceMemberExitCallback.md @@ -6,7 +6,7 @@ The Conference Member Exit event is fired whenever a caller exits a conference t 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] +**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] [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] **conferenceId** | **string** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] [default to undefined] **name** | **string** | The user-specified name of the conference that was recorded | [optional] [default to undefined] diff --git a/docs/ConferenceMemberJoinCallback.md b/docs/ConferenceMemberJoinCallback.md index c952039..57d1158 100644 --- a/docs/ConferenceMemberJoinCallback.md +++ b/docs/ConferenceMemberJoinCallback.md @@ -6,7 +6,7 @@ The Conference Member Join event is fired whenever a caller joins a conference t 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] +**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] [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] **conferenceId** | **string** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] [default to undefined] **name** | **string** | The user-specified name of the conference that was recorded | [optional] [default to undefined] diff --git a/docs/ConferenceRecordingAvailableCallback.md b/docs/ConferenceRecordingAvailableCallback.md index 3b40771..4b6e83d 100644 --- a/docs/ConferenceRecordingAvailableCallback.md +++ b/docs/ConferenceRecordingAvailableCallback.md @@ -6,7 +6,7 @@ The Conference Recording Available event is sent after a conference recording ha 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] +**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] [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] **conferenceId** | **string** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] [default to undefined] **name** | **string** | The user-specified name of the conference that was recorded | [optional] [default to undefined] diff --git a/docs/ConferenceRedirectCallback.md b/docs/ConferenceRedirectCallback.md index 321d30d..a3abd74 100644 --- a/docs/ConferenceRedirectCallback.md +++ b/docs/ConferenceRedirectCallback.md @@ -6,7 +6,7 @@ The Conference Redirect event is fired whenever an existing conference is modifi 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] +**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] [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] **conferenceId** | **string** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] [default to undefined] **name** | **string** | The user-specified name of the conference that was recorded | [optional] [default to undefined] diff --git a/docs/DisconnectCallback.md b/docs/DisconnectCallback.md index 44beeed..2ba585b 100644 --- a/docs/DisconnectCallback.md +++ b/docs/DisconnectCallback.md @@ -6,7 +6,7 @@ The Disconnect event is fired when a call ends, for any reason. 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] +**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] [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] diff --git a/docs/DtmfCallback.md b/docs/DtmfCallback.md index c7e7e8f..e09feae 100644 --- a/docs/DtmfCallback.md +++ b/docs/DtmfCallback.md @@ -6,7 +6,7 @@ The DTMF event is sent for every digit detected after a verb is ex 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] +**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] [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] diff --git a/docs/GatherCallback.md b/docs/GatherCallback.md index 1555aa1..fe55258 100644 --- a/docs/GatherCallback.md +++ b/docs/GatherCallback.md @@ -6,7 +6,7 @@ The gather event is sent after a verb is executed. Its purpose is to re 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] +**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] [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] diff --git a/docs/InitiateCallback.md b/docs/InitiateCallback.md index cf76fb6..9f53506 100644 --- a/docs/InitiateCallback.md +++ b/docs/InitiateCallback.md @@ -6,7 +6,7 @@ The Initiate event is fired when an inbound call is received for a Telephone Num 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] +**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] [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] diff --git a/docs/MachineDetectionCompleteCallback.md b/docs/MachineDetectionCompleteCallback.md index 1a28a49..8b66ae5 100644 --- a/docs/MachineDetectionCompleteCallback.md +++ b/docs/MachineDetectionCompleteCallback.md @@ -6,7 +6,7 @@ This event is sent to the url informed when requesting a machine detection opera 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] +**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] [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] diff --git a/docs/RecordingAvailableCallback.md b/docs/RecordingAvailableCallback.md index 3923875..71161e3 100644 --- a/docs/RecordingAvailableCallback.md +++ b/docs/RecordingAvailableCallback.md @@ -6,7 +6,7 @@ The Recording Available event is sent after a recording has been processed. It i 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] +**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] [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] diff --git a/docs/RecordingCompleteCallback.md b/docs/RecordingCompleteCallback.md index 8ea67e5..9ae0932 100644 --- a/docs/RecordingCompleteCallback.md +++ b/docs/RecordingCompleteCallback.md @@ -6,7 +6,7 @@ The Record Complete event is sent after a verb has executed if 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, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] [default to undefined] +**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] [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] diff --git a/docs/RedirectCallback.md b/docs/RedirectCallback.md index 1ef5497..14db413 100644 --- a/docs/RedirectCallback.md +++ b/docs/RedirectCallback.md @@ -6,7 +6,7 @@ The Redirect event is fired when a verb is executed. Its purpose is t 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] +**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] [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] diff --git a/docs/ReferCallStatusEnum.md b/docs/ReferCallStatusEnum.md new file mode 100644 index 0000000..b652a72 --- /dev/null +++ b/docs/ReferCallStatusEnum.md @@ -0,0 +1,11 @@ +# ReferCallStatusEnum + +The outcome of the REFER operation. + +## Enum + +* `Success` (value: `'success'`) + +* `Failure` (value: `'failure'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ReferCompleteCallback.md b/docs/ReferCompleteCallback.md new file mode 100644 index 0000000..de7f1fb --- /dev/null +++ b/docs/ReferCompleteCallback.md @@ -0,0 +1,49 @@ +# ReferCompleteCallback + +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. + +## 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, referComplete, 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**](CallDirectionEnum.md) | | [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] +**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] +**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] +**referCallStatus** | [**ReferCallStatusEnum**](ReferCallStatusEnum.md) | | [optional] [default to undefined] +**referSipResponseCode** | **number** | (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] [default to undefined] +**notifySipResponseCode** | **number** | (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] [default to undefined] + +## Example + +```typescript +import { ReferCompleteCallback } from 'bandwidth-sdk'; + +const instance: ReferCompleteCallback = { + eventType, + eventTime, + accountId, + applicationId, + from, + to, + direction, + callId, + callUrl, + startTime, + answerTime, + tag, + referCallStatus, + referSipResponseCode, + notifySipResponseCode, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TranscriptionAvailableCallback.md b/docs/TranscriptionAvailableCallback.md index c6aa331..d932030 100644 --- a/docs/TranscriptionAvailableCallback.md +++ b/docs/TranscriptionAvailableCallback.md @@ -6,7 +6,7 @@ The Transcription Available event is sent when the recording transcription is av 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] +**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] [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] diff --git a/docs/TransferAnswerCallback.md b/docs/TransferAnswerCallback.md index 86ce77b..ee33abe 100644 --- a/docs/TransferAnswerCallback.md +++ b/docs/TransferAnswerCallback.md @@ -6,7 +6,7 @@ When processing a verb, this event is sent when a called party (B-leg 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] +**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] [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] diff --git a/docs/TransferCompleteCallback.md b/docs/TransferCompleteCallback.md index 7de4230..bbb7c2a 100644 --- a/docs/TransferCompleteCallback.md +++ b/docs/TransferCompleteCallback.md @@ -6,7 +6,7 @@ This event is sent to the transferCompleteUrl of the A-leg\'s verb wh 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] +**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] [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] diff --git a/docs/TransferDisconnectCallback.md b/docs/TransferDisconnectCallback.md index ff644c5..b39dccd 100644 --- a/docs/TransferDisconnectCallback.md +++ b/docs/TransferDisconnectCallback.md @@ -6,7 +6,7 @@ This event is sent to the transferDisconnectUrl of each tag when i 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] +**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] [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] diff --git a/models/answer-callback.ts b/models/answer-callback.ts index 136cc9f..2141d96 100644 --- a/models/answer-callback.ts +++ b/models/answer-callback.ts @@ -25,7 +25,7 @@ import type { MachineDetectionResult } from './machine-detection-result'; */ export interface AnswerCallback { /** - * 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. + * 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. */ 'eventType'?: string; /** diff --git a/models/bridge-complete-callback.ts b/models/bridge-complete-callback.ts index 89c36b9..290c5bb 100644 --- a/models/bridge-complete-callback.ts +++ b/models/bridge-complete-callback.ts @@ -22,7 +22,7 @@ import type { CallDirectionEnum } from './call-direction-enum'; */ export interface BridgeCompleteCallback { /** - * 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. + * 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. */ 'eventType'?: string; /** diff --git a/models/bridge-target-complete-callback.ts b/models/bridge-target-complete-callback.ts index 54ca3f2..2ece08a 100644 --- a/models/bridge-target-complete-callback.ts +++ b/models/bridge-target-complete-callback.ts @@ -22,7 +22,7 @@ import type { CallDirectionEnum } from './call-direction-enum'; */ export interface BridgeTargetCompleteCallback { /** - * 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. + * 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. */ 'eventType'?: string; /** diff --git a/models/conference-completed-callback.ts b/models/conference-completed-callback.ts index 224ce2a..45e3c77 100644 --- a/models/conference-completed-callback.ts +++ b/models/conference-completed-callback.ts @@ -19,7 +19,7 @@ */ export interface ConferenceCompletedCallback { /** - * 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. + * 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. */ 'eventType'?: string; /** diff --git a/models/conference-created-callback.ts b/models/conference-created-callback.ts index 1a8cf8a..09de7a7 100644 --- a/models/conference-created-callback.ts +++ b/models/conference-created-callback.ts @@ -19,7 +19,7 @@ */ export interface ConferenceCreatedCallback { /** - * 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. + * 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. */ 'eventType'?: string; /** diff --git a/models/conference-member-exit-callback.ts b/models/conference-member-exit-callback.ts index 8f4636a..6ee52de 100644 --- a/models/conference-member-exit-callback.ts +++ b/models/conference-member-exit-callback.ts @@ -19,7 +19,7 @@ */ export interface ConferenceMemberExitCallback { /** - * 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. + * 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. */ 'eventType'?: string; /** diff --git a/models/conference-member-join-callback.ts b/models/conference-member-join-callback.ts index d14ab37..b5a222d 100644 --- a/models/conference-member-join-callback.ts +++ b/models/conference-member-join-callback.ts @@ -19,7 +19,7 @@ */ export interface ConferenceMemberJoinCallback { /** - * 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. + * 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. */ 'eventType'?: string; /** diff --git a/models/conference-recording-available-callback.ts b/models/conference-recording-available-callback.ts index 2c3fc42..40c1f60 100644 --- a/models/conference-recording-available-callback.ts +++ b/models/conference-recording-available-callback.ts @@ -22,7 +22,7 @@ import type { FileFormatEnum } from './file-format-enum'; */ export interface ConferenceRecordingAvailableCallback { /** - * 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. + * 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. */ 'eventType'?: string; /** diff --git a/models/conference-redirect-callback.ts b/models/conference-redirect-callback.ts index 975df6b..df26155 100644 --- a/models/conference-redirect-callback.ts +++ b/models/conference-redirect-callback.ts @@ -19,7 +19,7 @@ */ export interface ConferenceRedirectCallback { /** - * 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. + * 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. */ 'eventType'?: string; /** diff --git a/models/disconnect-callback.ts b/models/disconnect-callback.ts index 2985ea4..80790f8 100644 --- a/models/disconnect-callback.ts +++ b/models/disconnect-callback.ts @@ -22,7 +22,7 @@ import type { CallDirectionEnum } from './call-direction-enum'; */ export interface DisconnectCallback { /** - * 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. + * 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. */ 'eventType'?: string; /** diff --git a/models/dtmf-callback.ts b/models/dtmf-callback.ts index 48a57ac..9f84e20 100644 --- a/models/dtmf-callback.ts +++ b/models/dtmf-callback.ts @@ -22,7 +22,7 @@ import type { CallDirectionEnum } from './call-direction-enum'; */ export interface DtmfCallback { /** - * 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. + * 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. */ 'eventType'?: string; /** diff --git a/models/gather-callback.ts b/models/gather-callback.ts index 0af1b08..663b95b 100644 --- a/models/gather-callback.ts +++ b/models/gather-callback.ts @@ -22,7 +22,7 @@ import type { CallDirectionEnum } from './call-direction-enum'; */ export interface GatherCallback { /** - * 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. + * 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. */ 'eventType'?: string; /** diff --git a/models/index.ts b/models/index.ts index 2c25029..2a926de 100644 --- a/models/index.ts +++ b/models/index.ts @@ -155,6 +155,8 @@ export * from './recording-transcription-metadata'; export * from './recording-transcriptions'; export * from './redirect-callback'; export * from './redirect-method-enum'; +export * from './refer-call-status-enum'; +export * from './refer-complete-callback'; export * from './sip-connection-metadata'; export * from './sip-credentials'; export * from './sms-message-content'; diff --git a/models/initiate-callback.ts b/models/initiate-callback.ts index ce61c2d..72d031e 100644 --- a/models/initiate-callback.ts +++ b/models/initiate-callback.ts @@ -28,7 +28,7 @@ import type { StirShaken } from './stir-shaken'; */ export interface InitiateCallback { /** - * 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. + * 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. */ 'eventType'?: string; /** diff --git a/models/machine-detection-complete-callback.ts b/models/machine-detection-complete-callback.ts index 8212114..0cfc76e 100644 --- a/models/machine-detection-complete-callback.ts +++ b/models/machine-detection-complete-callback.ts @@ -25,7 +25,7 @@ import type { MachineDetectionResult } from './machine-detection-result'; */ export interface MachineDetectionCompleteCallback { /** - * 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. + * 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. */ 'eventType'?: string; /** diff --git a/models/recording-available-callback.ts b/models/recording-available-callback.ts index 0217e2d..c4d40bc 100644 --- a/models/recording-available-callback.ts +++ b/models/recording-available-callback.ts @@ -25,7 +25,7 @@ import type { FileFormatEnum } from './file-format-enum'; */ export interface RecordingAvailableCallback { /** - * 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. + * 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. */ 'eventType'?: string; /** diff --git a/models/recording-complete-callback.ts b/models/recording-complete-callback.ts index 569e7b1..1b283d8 100644 --- a/models/recording-complete-callback.ts +++ b/models/recording-complete-callback.ts @@ -25,7 +25,7 @@ import type { FileFormatEnum } from './file-format-enum'; */ export interface RecordingCompleteCallback { /** - * 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. + * 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. */ 'eventType'?: string; /** diff --git a/models/redirect-callback.ts b/models/redirect-callback.ts index 57dbe27..f0926c8 100644 --- a/models/redirect-callback.ts +++ b/models/redirect-callback.ts @@ -22,7 +22,7 @@ import type { CallDirectionEnum } from './call-direction-enum'; */ export interface RedirectCallback { /** - * 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. + * 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. */ 'eventType'?: string; /** diff --git a/models/refer-call-status-enum.ts b/models/refer-call-status-enum.ts new file mode 100644 index 0000000..87b5db5 --- /dev/null +++ b/models/refer-call-status-enum.ts @@ -0,0 +1,29 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Bandwidth + * Bandwidth\'s Communication APIs + * + * The version of the OpenAPI document: 1.0.0 + * Contact: letstalk@bandwidth.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + + +/** + * The outcome of the REFER operation. + */ + +export const ReferCallStatusEnum = { + Success: 'success', + Failure: 'failure', +} as const; + +export type ReferCallStatusEnum = typeof ReferCallStatusEnum[keyof typeof ReferCallStatusEnum]; + + + diff --git a/models/refer-complete-callback.ts b/models/refer-complete-callback.ts new file mode 100644 index 0000000..6613529 --- /dev/null +++ b/models/refer-complete-callback.ts @@ -0,0 +1,84 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Bandwidth + * Bandwidth\'s Communication APIs + * + * The version of the OpenAPI document: 1.0.0 + * Contact: letstalk@bandwidth.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +// May contain unused imports in some cases +// @ts-ignore +import type { CallDirectionEnum } from './call-direction-enum'; +// May contain unused imports in some cases +// @ts-ignore +import type { ReferCallStatusEnum } from './refer-call-status-enum'; + +/** + * 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. + */ +export interface ReferCompleteCallback { + /** + * 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. + */ + 'eventType'?: 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. + */ + 'eventTime'?: string; + /** + * The user account associated with the call. + */ + 'accountId'?: string; + /** + * The id of the application associated with the call. + */ + 'applicationId'?: string; + /** + * The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). + */ + 'from'?: string; + /** + * The phone number that received the call, in E.164 format (e.g. +15555555555). + */ + 'to'?: string; + 'direction'?: CallDirectionEnum; + /** + * The call id associated with the event. + */ + 'callId'?: string; + /** + * The URL of the call associated with the event. + */ + 'callUrl'?: string; + /** + * Time the call was started, in ISO 8601 format. + */ + 'startTime'?: string; + /** + * Time the call was answered, in ISO 8601 format. + */ + 'answerTime'?: string | null; + /** + * (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. + */ + 'tag'?: string | null; + 'referCallStatus'?: ReferCallStatusEnum; + /** + * (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. + */ + 'referSipResponseCode'?: number; + /** + * (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. + */ + 'notifySipResponseCode'?: number; +} + + + diff --git a/models/transcription-available-callback.ts b/models/transcription-available-callback.ts index 305ff65..dc031a4 100644 --- a/models/transcription-available-callback.ts +++ b/models/transcription-available-callback.ts @@ -28,7 +28,7 @@ import type { Transcription } from './transcription'; */ export interface TranscriptionAvailableCallback { /** - * 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. + * 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. */ 'eventType'?: string; /** diff --git a/models/transfer-answer-callback.ts b/models/transfer-answer-callback.ts index e484d5d..612293d 100644 --- a/models/transfer-answer-callback.ts +++ b/models/transfer-answer-callback.ts @@ -22,7 +22,7 @@ import type { CallDirectionEnum } from './call-direction-enum'; */ export interface TransferAnswerCallback { /** - * 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. + * 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. */ 'eventType'?: string; /** diff --git a/models/transfer-complete-callback.ts b/models/transfer-complete-callback.ts index 6712b24..c778c01 100644 --- a/models/transfer-complete-callback.ts +++ b/models/transfer-complete-callback.ts @@ -22,7 +22,7 @@ import type { CallDirectionEnum } from './call-direction-enum'; */ export interface TransferCompleteCallback { /** - * 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. + * 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. */ 'eventType'?: string; /** diff --git a/models/transfer-disconnect-callback.ts b/models/transfer-disconnect-callback.ts index b2fca5a..37b5827 100644 --- a/models/transfer-disconnect-callback.ts +++ b/models/transfer-disconnect-callback.ts @@ -22,7 +22,7 @@ import type { CallDirectionEnum } from './call-direction-enum'; */ export interface TransferDisconnectCallback { /** - * 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. + * 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. */ 'eventType'?: string; /**