Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,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
Expand Down Expand Up @@ -413,6 +415,8 @@ src/main/java/com/bandwidth/sdk/model/RecordingTranscriptionMetadata.java
src/main/java/com/bandwidth/sdk/model/RecordingTranscriptions.java
src/main/java/com/bandwidth/sdk/model/RedirectCallback.java
src/main/java/com/bandwidth/sdk/model/RedirectMethodEnum.java
src/main/java/com/bandwidth/sdk/model/ReferCallStatusEnum.java
src/main/java/com/bandwidth/sdk/model/ReferCompleteCallback.java
src/main/java/com/bandwidth/sdk/model/SipConnectionMetadata.java
src/main/java/com/bandwidth/sdk/model/SipCredentials.java
src/main/java/com/bandwidth/sdk/model/SmsMessageContent.java
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -345,6 +345,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)
Expand Down
193 changes: 149 additions & 44 deletions api/openapi.yaml

Large diffs are not rendered by default.

65 changes: 63 additions & 2 deletions bandwidth.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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 <Refer> 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: >-
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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: >-
Expand Down
2 changes: 1 addition & 1 deletion docs/AnswerCallback.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,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] |
|**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** | **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] |
Expand Down
2 changes: 1 addition & 1 deletion docs/BridgeCompleteCallback.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ If the target call leaves the <Bridge>, 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] |
|**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** | **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] |
Expand Down
2 changes: 1 addition & 1 deletion docs/BridgeTargetCompleteCallback.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ If the originating call leaves the <Bridge>, 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] |
|**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** | **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] |
Expand Down
2 changes: 1 addition & 1 deletion docs/ConferenceCompletedCallback.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,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] |
|**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** | **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] |
|**conferenceId** | **String** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] |
|**name** | **String** | The user-specified name of the conference that was recorded | [optional] |
Expand Down
2 changes: 1 addition & 1 deletion docs/ConferenceCreatedCallback.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,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] |
|**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** | **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] |
|**conferenceId** | **String** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] |
|**name** | **String** | The user-specified name of the conference that was recorded | [optional] |
Expand Down
2 changes: 1 addition & 1 deletion docs/ConferenceMemberExitCallback.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,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] |
|**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** | **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] |
|**conferenceId** | **String** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] |
|**name** | **String** | The user-specified name of the conference that was recorded | [optional] |
Expand Down
2 changes: 1 addition & 1 deletion docs/ConferenceMemberJoinCallback.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,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] |
|**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** | **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] |
|**conferenceId** | **String** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] |
|**name** | **String** | The user-specified name of the conference that was recorded | [optional] |
Expand Down
2 changes: 1 addition & 1 deletion docs/ConferenceRecordingAvailableCallback.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,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] |
|**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** | **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] |
|**conferenceId** | **String** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] |
|**name** | **String** | The user-specified name of the conference that was recorded | [optional] |
Expand Down
2 changes: 1 addition & 1 deletion docs/ConferenceRedirectCallback.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,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] |
|**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** | **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] |
|**conferenceId** | **String** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] |
|**name** | **String** | The user-specified name of the conference that was recorded | [optional] |
Expand Down
Loading