bandwidth-sdk 8.3.1 → 9.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/workflows/deploy.yml +0 -19
- package/.github/workflows/test-pr.yml +0 -20
- package/.github/workflows/test-smoke.yml +0 -4
- package/.openapi-generator/FILES +2 -0
- package/README.md +1 -5
- package/api/calls-api.ts +0 -20
- package/api/conferences-api.ts +0 -36
- package/api/endpoints-api.ts +0 -20
- package/api/media-api.ts +0 -16
- package/api/messages-api.ts +0 -8
- package/api/mfaapi.ts +0 -12
- package/api/multi-channel-api.ts +0 -4
- package/api/phone-number-lookup-api.ts +0 -12
- package/api/recordings-api.ts +0 -40
- package/api/statistics-api.ts +0 -4
- package/api/toll-free-verification-api.ts +0 -36
- package/api/transcriptions-api.ts +0 -12
- package/bandwidth.yml +285 -109
- package/common.ts +2 -5
- package/configuration.ts +4 -13
- package/coverage/clover.xml +1249 -1293
- package/coverage/coverage-final.json +17 -16
- package/coverage/lcov-report/index.html +41 -26
- package/coverage/lcov-report/node-sdk/api/calls-api.ts.html +6 -66
- package/coverage/lcov-report/node-sdk/api/conferences-api.ts.html +6 -114
- package/coverage/lcov-report/node-sdk/api/endpoints-api.ts.html +6 -66
- package/coverage/lcov-report/node-sdk/api/index.html +69 -69
- package/coverage/lcov-report/node-sdk/api/media-api.ts.html +6 -54
- package/coverage/lcov-report/node-sdk/api/messages-api.ts.html +6 -30
- package/coverage/lcov-report/node-sdk/api/mfaapi.ts.html +6 -42
- package/coverage/lcov-report/node-sdk/api/multi-channel-api.ts.html +6 -18
- package/coverage/lcov-report/node-sdk/api/phone-number-lookup-api.ts.html +6 -42
- package/coverage/lcov-report/node-sdk/api/recordings-api.ts.html +6 -126
- package/coverage/lcov-report/node-sdk/api/statistics-api.ts.html +6 -18
- package/coverage/lcov-report/node-sdk/api/toll-free-verification-api.ts.html +6 -114
- package/coverage/lcov-report/node-sdk/api/transcriptions-api.ts.html +6 -42
- package/coverage/lcov-report/node-sdk/api.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/base.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/common.ts.html +13 -22
- package/coverage/lcov-report/node-sdk/configuration.ts.html +11 -38
- package/coverage/lcov-report/node-sdk/index.html +20 -20
- package/coverage/lcov-report/node-sdk/models/business-entity-type-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/business-registration-type-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/Bxml.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/NestableVerb.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/Response.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/Root.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/Verb.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/index.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/index.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Bridge.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Conference.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Connect.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/CustomParam.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Endpoint.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Forward.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Gather.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Hangup.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Pause.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/PauseRecording.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/PhoneNumber.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/PlayAudio.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Record.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Redirect.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Refer.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/ResumeRecording.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Ring.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/SendDtmf.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/SipUri.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/SpeakSentence.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartGather.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartRecording.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartStream.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartTranscription.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopGather.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopRecording.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopStream.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopTranscription.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StreamParam.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Tag.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Transfer.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.html +1 -1
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/call-direction-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/call-state-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/call-transcription-detected-language-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/call-transcription-track-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/callback-method-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/card-width-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/completed-lookup-status-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/conference-state-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/deactivation-event-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/device-status-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/endpoint-direction-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/endpoint-event-type-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/endpoint-status-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/endpoint-type-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/file-format-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/in-progress-lookup-status-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/inbound-callback-type-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/index.html +5 -5
- package/coverage/lcov-report/node-sdk/models/index.ts.html +7 -4
- package/coverage/lcov-report/node-sdk/models/latest-message-delivery-status-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/line-type-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/list-message-direction-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/machine-detection-mode-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/message-direction-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/message-status-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/message-type-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/multi-channel-message-channel-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/priority-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/product-type-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/rbm-action-type-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/rbm-media-height-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/rbm-open-url-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/rbm-web-view-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/recording-state-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/redirect-method-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/refer-call-status-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/standalone-card-orientation-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/status-callback-type-enum.ts.html +6 -3
- package/coverage/lcov-report/node-sdk/models/tfv-callback-status-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/tfv-status-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/thumbnail-alignment-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/webhook-subscription-type-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/tests/unit/constants.ts.html +103 -0
- package/coverage/lcov-report/node-sdk/tests/unit/index.html +116 -0
- package/coverage/lcov.info +3073 -3115
- package/custom_templates/common.mustache +2 -5
- package/custom_templates/configuration.mustache +3 -12
- package/dist/api/calls-api.js +0 -15
- package/dist/api/conferences-api.js +0 -27
- package/dist/api/endpoints-api.js +0 -15
- package/dist/api/media-api.js +0 -12
- package/dist/api/messages-api.js +0 -6
- package/dist/api/mfaapi.js +0 -9
- package/dist/api/multi-channel-api.js +0 -3
- package/dist/api/phone-number-lookup-api.js +0 -9
- package/dist/api/recordings-api.js +0 -30
- package/dist/api/statistics-api.js +0 -3
- package/dist/api/toll-free-verification-api.js +0 -27
- package/dist/api/transcriptions-api.js +0 -9
- package/dist/common.js +2 -5
- package/dist/configuration.d.ts +0 -10
- package/dist/configuration.js +4 -3
- package/dist/models/callback.d.ts +2 -0
- package/dist/models/disconnect-callback.d.ts +11 -1
- package/dist/models/inbound-callback-message.d.ts +2 -0
- package/dist/models/index.d.ts +1 -0
- package/dist/models/index.js +1 -0
- package/dist/models/initiate-callback.d.ts +1 -1
- package/dist/models/list-message-item.d.ts +1 -1
- package/dist/models/multi-channel-action-calendar-event.d.ts +1 -1
- package/dist/models/multi-channel-action.d.ts +1 -1
- package/dist/models/rbm-action-base.d.ts +1 -1
- package/dist/models/rbm-action-dial.d.ts +1 -1
- package/dist/models/rbm-action-open-url.d.ts +1 -1
- package/dist/models/rbm-action-view-location.d.ts +1 -1
- package/dist/models/rbm-session.d.ts +36 -0
- package/dist/models/rbm-session.js +15 -0
- package/dist/models/rbm-suggestion-response.d.ts +2 -2
- package/dist/models/status-callback-message.d.ts +2 -0
- package/dist/models/status-callback-type-enum.d.ts +2 -1
- package/dist/models/status-callback-type-enum.js +2 -1
- package/dist/models/transfer-disconnect-callback.d.ts +14 -0
- package/docs/CallsApi.md +5 -5
- package/docs/ConferencesApi.md +9 -9
- package/docs/DisconnectCallback.md +5 -1
- package/docs/EndpointsApi.md +5 -5
- package/docs/InboundCallbackMessage.md +2 -0
- package/docs/InitiateCallback.md +1 -1
- package/docs/MFAApi.md +3 -3
- package/docs/MediaApi.md +4 -4
- package/docs/MessagesApi.md +2 -2
- package/docs/MultiChannelAction.md +1 -1
- package/docs/MultiChannelActionCalendarEvent.md +1 -1
- package/docs/MultiChannelApi.md +1 -1
- package/docs/PhoneNumberLookupApi.md +3 -3
- package/docs/RbmActionBase.md +1 -1
- package/docs/RbmActionDial.md +1 -1
- package/docs/RbmActionOpenUrl.md +1 -1
- package/docs/RbmActionViewLocation.md +1 -1
- package/docs/RbmSession.md +29 -0
- package/docs/RbmSuggestionResponse.md +2 -2
- package/docs/RecordingsApi.md +10 -10
- package/docs/StatisticsApi.md +1 -1
- package/docs/StatusCallbackMessage.md +2 -0
- package/docs/StatusCallbackTypeEnum.md +3 -1
- package/docs/TollFreeVerificationApi.md +9 -9
- package/docs/TranscriptionsApi.md +3 -3
- package/docs/TransferDisconnectCallback.md +6 -0
- package/jest.config.js +0 -6
- package/models/callback.ts +1 -1
- package/models/disconnect-callback.ts +9 -1
- package/models/inbound-callback-message.ts +4 -0
- package/models/index.ts +1 -0
- package/models/initiate-callback.ts +1 -1
- package/models/list-message-item.ts +1 -1
- package/models/multi-channel-action-calendar-event.ts +1 -1
- package/models/multi-channel-action.ts +1 -1
- package/models/rbm-action-base.ts +1 -1
- package/models/rbm-action-dial.ts +1 -1
- package/models/rbm-action-open-url.ts +1 -1
- package/models/rbm-action-view-location.ts +1 -1
- package/models/rbm-session.ts +42 -0
- package/models/rbm-suggestion-response.ts +2 -2
- package/models/status-callback-message.ts +4 -0
- package/models/status-callback-type-enum.ts +2 -1
- package/models/transfer-disconnect-callback.ts +12 -0
- package/package.json +1 -1
- package/tests/globals.d.ts +0 -6
- package/tests/smoke/calls-api.test.ts +1 -23
- package/tests/smoke/conferences-api.test.ts +2 -2
- package/tests/smoke/media-api.test.ts +4 -1
- package/tests/smoke/messages-api.test.ts +4 -19
- package/tests/smoke/mfaapi.test.ts +4 -20
- package/tests/smoke/multi-channel-api.test.ts +2 -2
- package/tests/smoke/statistics-api.test.ts +0 -24
- package/tests/unit/api/calls-api.test.ts +2 -1
- package/tests/unit/api/conferences-api.test.ts +3 -2
- package/tests/unit/api/media-api.test.ts +1 -0
- package/tests/unit/api/messages-api.test.ts +1 -0
- package/tests/unit/api/mfaapi.test.ts +1 -0
- package/tests/unit/api/multi-channel-api.test.ts +1 -0
- package/tests/unit/api/phone-number-lookup-api.test.ts +1 -0
- package/tests/unit/api/recordings-api.test.ts +2 -1
- package/tests/unit/api/statistics-api.test.ts +1 -0
- package/tests/unit/api/toll-free-verification-api.test.ts +1 -0
- package/tests/unit/api/transcriptions-api.test.ts +1 -0
- package/tests/unit/configuration.test.ts +19 -0
- package/tests/unit/constants.ts +6 -0
- package/tests/unit/models/disconnect-callback.test.ts +4 -0
- package/tests/unit/models/inbound-callback-message.test.ts +3 -0
- package/tests/unit/models/rbm-session.test.ts +19 -0
- package/tests/unit/models/status-callback-message.test.ts +3 -0
- package/tests/unit/models/status-callback-type-enum.test.ts +3 -1
- package/tests/unit/models/transfer-disconnect-callback.test.ts +6 -0
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**type** | [**RbmActionTypeEnum**](RbmActionTypeEnum.md) | | [default to undefined]
|
|
9
9
|
**text** | **string** | Displayed text for user to click | [default to undefined]
|
|
10
|
-
**postbackData** | **string** |
|
|
10
|
+
**postbackData** | **string** | Payload the customer receives when the reply is clicked. | [default to undefined]
|
|
11
11
|
**phoneNumber** | **string** | The phone number to dial. Must be E164 format. | [default to undefined]
|
|
12
12
|
**latitude** | **number** | The latitude of the location. Must be in range [-90.000000, 90.000000]. | [default to undefined]
|
|
13
13
|
**longitude** | **number** | The longitude of the location. Must be in range [-180.000000, 180.000000]. | [default to undefined]
|
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**type** | [**RbmActionTypeEnum**](RbmActionTypeEnum.md) | | [default to undefined]
|
|
9
9
|
**text** | **string** | Displayed text for user to click | [default to undefined]
|
|
10
|
-
**postbackData** | **string** |
|
|
10
|
+
**postbackData** | **string** | Payload the customer receives when the reply is clicked. | [default to undefined]
|
|
11
11
|
**title** | **string** | The title of the event. | [default to undefined]
|
|
12
12
|
**startTime** | **string** | The start time of the event. Must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. | [default to undefined]
|
|
13
13
|
**endTime** | **string** | The end time of the event. Must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. | [default to undefined]
|
package/docs/MultiChannelApi.md
CHANGED
|
@@ -48,7 +48,7 @@ const { status, data } = await apiInstance.createAsyncBulkLookup(
|
|
|
48
48
|
|
|
49
49
|
### Authorization
|
|
50
50
|
|
|
51
|
-
[
|
|
51
|
+
[OAuth2](../README.md#OAuth2)
|
|
52
52
|
|
|
53
53
|
### HTTP request headers
|
|
54
54
|
|
|
@@ -104,7 +104,7 @@ const { status, data } = await apiInstance.createSyncLookup(
|
|
|
104
104
|
|
|
105
105
|
### Authorization
|
|
106
106
|
|
|
107
|
-
[
|
|
107
|
+
[OAuth2](../README.md#OAuth2)
|
|
108
108
|
|
|
109
109
|
### HTTP request headers
|
|
110
110
|
|
|
@@ -159,7 +159,7 @@ const { status, data } = await apiInstance.getAsyncBulkLookup(
|
|
|
159
159
|
|
|
160
160
|
### Authorization
|
|
161
161
|
|
|
162
|
-
[
|
|
162
|
+
[OAuth2](../README.md#OAuth2)
|
|
163
163
|
|
|
164
164
|
### HTTP request headers
|
|
165
165
|
|
package/docs/RbmActionBase.md
CHANGED
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**type** | [**RbmActionTypeEnum**](RbmActionTypeEnum.md) | | [default to undefined]
|
|
9
9
|
**text** | **string** | Displayed text for user to click | [default to undefined]
|
|
10
|
-
**postbackData** | **string** |
|
|
10
|
+
**postbackData** | **string** | Payload the customer receives when the reply is clicked. | [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
package/docs/RbmActionDial.md
CHANGED
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**type** | [**RbmActionTypeEnum**](RbmActionTypeEnum.md) | | [default to undefined]
|
|
9
9
|
**text** | **string** | Displayed text for user to click | [default to undefined]
|
|
10
|
-
**postbackData** | **string** |
|
|
10
|
+
**postbackData** | **string** | Payload the customer receives when the reply is clicked. | [default to undefined]
|
|
11
11
|
**phoneNumber** | **string** | The phone number to dial. Must be E164 format. | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
package/docs/RbmActionOpenUrl.md
CHANGED
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**type** | [**RbmActionTypeEnum**](RbmActionTypeEnum.md) | | [default to undefined]
|
|
9
9
|
**text** | **string** | Displayed text for user to click | [default to undefined]
|
|
10
|
-
**postbackData** | **string** |
|
|
10
|
+
**postbackData** | **string** | Payload the customer receives when the reply is clicked. | [default to undefined]
|
|
11
11
|
**url** | **string** | The URL to open in browser. Must use http:// or https:// scheme. | [default to undefined]
|
|
12
12
|
**application** | [**RbmOpenUrlEnum**](RbmOpenUrlEnum.md) | | [optional] [default to undefined]
|
|
13
13
|
**webviewViewMode** | [**RbmWebViewEnum**](RbmWebViewEnum.md) | | [optional] [default to undefined]
|
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**type** | [**RbmActionTypeEnum**](RbmActionTypeEnum.md) | | [default to undefined]
|
|
9
9
|
**text** | **string** | Displayed text for user to click | [default to undefined]
|
|
10
|
-
**postbackData** | **string** |
|
|
10
|
+
**postbackData** | **string** | Payload the customer receives when the reply is clicked. | [default to undefined]
|
|
11
11
|
**latitude** | **number** | The latitude of the location. Must be in range [-90.000000, 90.000000]. | [default to undefined]
|
|
12
12
|
**longitude** | **number** | The longitude of the location. Must be in range [-180.000000, 180.000000]. | [default to undefined]
|
|
13
13
|
**label** | **string** | The label of the location. | [optional] [default to undefined]
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# RbmSession
|
|
2
|
+
|
|
3
|
+
RCS interactive session information for the message. An interactive session is a 24-hour window covering all Rich and Rich Media messages exchanged between an RCS agent and a specific end user mobile number. It is triggered when at least 4 messages are exchanged within 24 hours, at least 2 of them mobile-originated and at least 1 mobile-terminated. Only present on `message-delivered`, `message-received` and `session-started` callbacks for RBM messages of US agents with the Conversational billing category. Omitted for all other messages.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**canInitiate** | **boolean** | Whether the message can start an interactive session. `false` if the message is already part of an active session, or if the agent is not eligible for interactive session billing. | [default to undefined]
|
|
10
|
+
**id** | **string** | The unique identifier of the interactive session the message is part of. This is not a message ID. Omitted if the message is not part of a session. | [optional] [default to undefined]
|
|
11
|
+
**type** | **string** | The type of the interactive session. Only present on `session-started` callbacks. | [optional] [default to undefined]
|
|
12
|
+
**startTime** | **string** | The time the 24-hour session window opened. Only present on `session-started` callbacks. | [optional] [default to undefined]
|
|
13
|
+
**endTime** | **string** | The time the 24-hour session window closes. Only present on `session-started` callbacks. | [optional] [default to undefined]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { RbmSession } from 'bandwidth-sdk';
|
|
19
|
+
|
|
20
|
+
const instance: RbmSession = {
|
|
21
|
+
canInitiate,
|
|
22
|
+
id,
|
|
23
|
+
type,
|
|
24
|
+
startTime,
|
|
25
|
+
endTime,
|
|
26
|
+
};
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -5,8 +5,8 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**text** | **string** | The text
|
|
9
|
-
**postbackData** | **string** |
|
|
8
|
+
**text** | **string** | The text of the suggestion the user tapped. | [optional] [default to undefined]
|
|
9
|
+
**postbackData** | **string** | Payload the customer receives when the reply is clicked. | [optional] [default to undefined]
|
|
10
10
|
**pairedMessageId** | **string** | Corresponding parent message ID (MT). | [optional] [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
package/docs/RecordingsApi.md
CHANGED
|
@@ -57,7 +57,7 @@ void (empty response body)
|
|
|
57
57
|
|
|
58
58
|
### Authorization
|
|
59
59
|
|
|
60
|
-
[
|
|
60
|
+
[OAuth2](../README.md#OAuth2)
|
|
61
61
|
|
|
62
62
|
### HTTP request headers
|
|
63
63
|
|
|
@@ -122,7 +122,7 @@ void (empty response body)
|
|
|
122
122
|
|
|
123
123
|
### Authorization
|
|
124
124
|
|
|
125
|
-
[
|
|
125
|
+
[OAuth2](../README.md#OAuth2)
|
|
126
126
|
|
|
127
127
|
### HTTP request headers
|
|
128
128
|
|
|
@@ -187,7 +187,7 @@ void (empty response body)
|
|
|
187
187
|
|
|
188
188
|
### Authorization
|
|
189
189
|
|
|
190
|
-
[
|
|
190
|
+
[OAuth2](../README.md#OAuth2)
|
|
191
191
|
|
|
192
192
|
### HTTP request headers
|
|
193
193
|
|
|
@@ -252,7 +252,7 @@ const { status, data } = await apiInstance.downloadCallRecording(
|
|
|
252
252
|
|
|
253
253
|
### Authorization
|
|
254
254
|
|
|
255
|
-
[
|
|
255
|
+
[OAuth2](../README.md#OAuth2)
|
|
256
256
|
|
|
257
257
|
### HTTP request headers
|
|
258
258
|
|
|
@@ -317,7 +317,7 @@ const { status, data } = await apiInstance.getCallRecording(
|
|
|
317
317
|
|
|
318
318
|
### Authorization
|
|
319
319
|
|
|
320
|
-
[
|
|
320
|
+
[OAuth2](../README.md#OAuth2)
|
|
321
321
|
|
|
322
322
|
### HTTP request headers
|
|
323
323
|
|
|
@@ -382,7 +382,7 @@ const { status, data } = await apiInstance.getRecordingTranscription(
|
|
|
382
382
|
|
|
383
383
|
### Authorization
|
|
384
384
|
|
|
385
|
-
[
|
|
385
|
+
[OAuth2](../README.md#OAuth2)
|
|
386
386
|
|
|
387
387
|
### HTTP request headers
|
|
388
388
|
|
|
@@ -453,7 +453,7 @@ const { status, data } = await apiInstance.listAccountCallRecordings(
|
|
|
453
453
|
|
|
454
454
|
### Authorization
|
|
455
455
|
|
|
456
|
-
[
|
|
456
|
+
[OAuth2](../README.md#OAuth2)
|
|
457
457
|
|
|
458
458
|
### HTTP request headers
|
|
459
459
|
|
|
@@ -515,7 +515,7 @@ const { status, data } = await apiInstance.listCallRecordings(
|
|
|
515
515
|
|
|
516
516
|
### Authorization
|
|
517
517
|
|
|
518
|
-
[
|
|
518
|
+
[OAuth2](../README.md#OAuth2)
|
|
519
519
|
|
|
520
520
|
### HTTP request headers
|
|
521
521
|
|
|
@@ -584,7 +584,7 @@ void (empty response body)
|
|
|
584
584
|
|
|
585
585
|
### Authorization
|
|
586
586
|
|
|
587
|
-
[
|
|
587
|
+
[OAuth2](../README.md#OAuth2)
|
|
588
588
|
|
|
589
589
|
### HTTP request headers
|
|
590
590
|
|
|
@@ -650,7 +650,7 @@ void (empty response body)
|
|
|
650
650
|
|
|
651
651
|
### Authorization
|
|
652
652
|
|
|
653
|
-
[
|
|
653
|
+
[OAuth2](../README.md#OAuth2)
|
|
654
654
|
|
|
655
655
|
### HTTP request headers
|
|
656
656
|
|
package/docs/StatisticsApi.md
CHANGED
|
@@ -19,6 +19,7 @@ Name | Type | Description | Notes
|
|
|
19
19
|
**media** | **Array<string>** | Optional media, not applicable for sms | [optional] [default to undefined]
|
|
20
20
|
**priority** | [**PriorityEnum**](PriorityEnum.md) | | [optional] [default to undefined]
|
|
21
21
|
**channel** | [**MultiChannelMessageChannelEnum**](MultiChannelMessageChannelEnum.md) | | [optional] [default to undefined]
|
|
22
|
+
**session** | [**RbmSession**](RbmSession.md) | | [optional] [default to undefined]
|
|
22
23
|
|
|
23
24
|
## Example
|
|
24
25
|
|
|
@@ -39,6 +40,7 @@ const instance: StatusCallbackMessage = {
|
|
|
39
40
|
media,
|
|
40
41
|
priority,
|
|
41
42
|
channel,
|
|
43
|
+
session,
|
|
42
44
|
};
|
|
43
45
|
```
|
|
44
46
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# StatusCallbackTypeEnum
|
|
2
2
|
|
|
3
|
-
The possible status callbacks when sending an MT SMS or MMS or RBM message: - `message-sending` indicates that Bandwidth is sending the message to the upstream provider. - `message-sent` indicates that the message has left the Bandwidth network and is in transit to the provider. - `message-delivered` indicates that the message was successfully delivered to handset. - `message-failed` indicates that the message could not be sent to the intended recipient. - `message-read` indicates that the RBM message was read by the recipient.
|
|
3
|
+
The possible status callbacks when sending an MT SMS or MMS or RBM message: - `message-sending` indicates that Bandwidth is sending the message to the upstream provider. - `message-sent` indicates that the message has left the Bandwidth network and is in transit to the provider. - `message-delivered` indicates that the message was successfully delivered to handset. - `message-failed` indicates that the message could not be sent to the intended recipient. - `message-read` indicates that the RBM message was read by the recipient. - `session-started` indicates that a previously exchanged RBM message is now part of an RCS interactive session and is no longer billed individually.
|
|
4
4
|
|
|
5
5
|
## Enum
|
|
6
6
|
|
|
@@ -14,4 +14,6 @@ The possible status callbacks when sending an MT SMS or MMS or RBM message: - `m
|
|
|
14
14
|
|
|
15
15
|
* `MessageRead` (value: `'message-read'`)
|
|
16
16
|
|
|
17
|
+
* `SessionStarted` (value: `'session-started'`)
|
|
18
|
+
|
|
17
19
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -54,7 +54,7 @@ const { status, data } = await apiInstance.createWebhookSubscription(
|
|
|
54
54
|
|
|
55
55
|
### Authorization
|
|
56
56
|
|
|
57
|
-
[
|
|
57
|
+
[OAuth2](../README.md#OAuth2)
|
|
58
58
|
|
|
59
59
|
### HTTP request headers
|
|
60
60
|
|
|
@@ -116,7 +116,7 @@ void (empty response body)
|
|
|
116
116
|
|
|
117
117
|
### Authorization
|
|
118
118
|
|
|
119
|
-
[
|
|
119
|
+
[OAuth2](../README.md#OAuth2)
|
|
120
120
|
|
|
121
121
|
### HTTP request headers
|
|
122
122
|
|
|
@@ -178,7 +178,7 @@ void (empty response body)
|
|
|
178
178
|
|
|
179
179
|
### Authorization
|
|
180
180
|
|
|
181
|
-
[
|
|
181
|
+
[OAuth2](../README.md#OAuth2)
|
|
182
182
|
|
|
183
183
|
### HTTP request headers
|
|
184
184
|
|
|
@@ -240,7 +240,7 @@ const { status, data } = await apiInstance.getTollFreeVerificationStatus(
|
|
|
240
240
|
|
|
241
241
|
### Authorization
|
|
242
242
|
|
|
243
|
-
[
|
|
243
|
+
[OAuth2](../README.md#OAuth2)
|
|
244
244
|
|
|
245
245
|
### HTTP request headers
|
|
246
246
|
|
|
@@ -292,7 +292,7 @@ This endpoint does not have any parameters.
|
|
|
292
292
|
|
|
293
293
|
### Authorization
|
|
294
294
|
|
|
295
|
-
[
|
|
295
|
+
[OAuth2](../README.md#OAuth2)
|
|
296
296
|
|
|
297
297
|
### HTTP request headers
|
|
298
298
|
|
|
@@ -351,7 +351,7 @@ const { status, data } = await apiInstance.listWebhookSubscriptions(
|
|
|
351
351
|
|
|
352
352
|
### Authorization
|
|
353
353
|
|
|
354
|
-
[
|
|
354
|
+
[OAuth2](../README.md#OAuth2)
|
|
355
355
|
|
|
356
356
|
### HTTP request headers
|
|
357
357
|
|
|
@@ -413,7 +413,7 @@ void (empty response body)
|
|
|
413
413
|
|
|
414
414
|
### Authorization
|
|
415
415
|
|
|
416
|
-
[
|
|
416
|
+
[OAuth2](../README.md#OAuth2)
|
|
417
417
|
|
|
418
418
|
### HTTP request headers
|
|
419
419
|
|
|
@@ -479,7 +479,7 @@ void (empty response body)
|
|
|
479
479
|
|
|
480
480
|
### Authorization
|
|
481
481
|
|
|
482
|
-
[
|
|
482
|
+
[OAuth2](../README.md#OAuth2)
|
|
483
483
|
|
|
484
484
|
### HTTP request headers
|
|
485
485
|
|
|
@@ -546,7 +546,7 @@ const { status, data } = await apiInstance.updateWebhookSubscription(
|
|
|
546
546
|
|
|
547
547
|
### Authorization
|
|
548
548
|
|
|
549
|
-
[
|
|
549
|
+
[OAuth2](../README.md#OAuth2)
|
|
550
550
|
|
|
551
551
|
### HTTP request headers
|
|
552
552
|
|
|
@@ -50,7 +50,7 @@ void (empty response body)
|
|
|
50
50
|
|
|
51
51
|
### Authorization
|
|
52
52
|
|
|
53
|
-
[
|
|
53
|
+
[OAuth2](../README.md#OAuth2)
|
|
54
54
|
|
|
55
55
|
### HTTP request headers
|
|
56
56
|
|
|
@@ -115,7 +115,7 @@ const { status, data } = await apiInstance.getRealTimeTranscription(
|
|
|
115
115
|
|
|
116
116
|
### Authorization
|
|
117
117
|
|
|
118
|
-
[
|
|
118
|
+
[OAuth2](../README.md#OAuth2)
|
|
119
119
|
|
|
120
120
|
### HTTP request headers
|
|
121
121
|
|
|
@@ -177,7 +177,7 @@ const { status, data } = await apiInstance.listRealTimeTranscriptions(
|
|
|
177
177
|
|
|
178
178
|
### Authorization
|
|
179
179
|
|
|
180
|
-
[
|
|
180
|
+
[OAuth2](../README.md#OAuth2)
|
|
181
181
|
|
|
182
182
|
### HTTP request headers
|
|
183
183
|
|
|
@@ -26,6 +26,9 @@ Name | Type | Description | Notes
|
|
|
26
26
|
**cause** | **string** | Reason the call failed - hangup, busy, timeout, cancel, rejected, callback-error, invalid-bxml, application-error, account-limit, node-capacity-exceeded, error, or unknown. | [optional] [default to undefined]
|
|
27
27
|
**errorMessage** | **string** | Text explaining the reason that caused the call to fail in case of errors. | [optional] [default to undefined]
|
|
28
28
|
**errorId** | **string** | Bandwidth\'s internal id that references the error event. | [optional] [default to undefined]
|
|
29
|
+
**sipResponseCode** | **number** | (optional) The SIP status code of the final response that rejected an outbound call\'s (or transferred leg\'s) INVITE (e.g. 486 for busy, 603 for decline). Present only when the call was rejected with a SIP response. | [optional] [default to undefined]
|
|
30
|
+
**sipStatusLine** | **string** | (optional) The full SIP status line, exactly as received, of the final response that rejected an outbound call\'s INVITE. The reason phrase can help distinguish outcomes that share a status code, such as `603 Network Blocked` and `603 Decline`. Present only when an outbound call was rejected with a SIP response. | [optional] [default to undefined]
|
|
31
|
+
**sipHeaders** | **{ [key: string]: string; }** | (optional) Map of SIP headers, with lowercase keys (SIP headers are case-insensitive). On the Initiate callback, contains the customer-supplied X-* headers from the original INVITE; present only for inbound SIP URI calls with custom headers. On the Disconnect and Transfer Disconnect callbacks, contains a single `reason` key holding the raw, unmodified `Reason` header value from the final SIP response that rejected an outbound call (or transferred leg); present only when that response included a `Reason` header (for example, `v=analytics1` call-analytics block information from a terminating carrier). If the response carries more than one `Reason` header, all values are returned in the order received, separated by `, `. Note - on the Initiate callback, keys preserve the original SIP header name in lowercase rather than Bandwidth\'s usual camelCase JSON convention, since these are passthrough values from the caller\'s SIP INVITE, not Bandwidth-defined fields. If the same header name is sent more than once in the INVITE, only the last value is kept. The example shown is for the Initiate callback; on the Disconnect and Transfer Disconnect callbacks the only key is `reason`. | [optional] [default to undefined]
|
|
29
32
|
|
|
30
33
|
## Example
|
|
31
34
|
|
|
@@ -53,6 +56,9 @@ const instance: TransferDisconnectCallback = {
|
|
|
53
56
|
cause,
|
|
54
57
|
errorMessage,
|
|
55
58
|
errorId,
|
|
59
|
+
sipResponseCode,
|
|
60
|
+
sipStatusLine,
|
|
61
|
+
sipHeaders,
|
|
56
62
|
};
|
|
57
63
|
```
|
|
58
64
|
|
package/jest.config.js
CHANGED
|
@@ -7,8 +7,6 @@ module.exports = {
|
|
|
7
7
|
'^.+\\.tsx?$': ['ts-jest', { tsconfig: 'tests/tsconfig.json' }]
|
|
8
8
|
},
|
|
9
9
|
globals: {
|
|
10
|
-
'BW_USERNAME': process.env.BW_USERNAME,
|
|
11
|
-
'BW_PASSWORD': process.env.BW_PASSWORD,
|
|
12
10
|
'BW_CLIENT_ID': process.env.BW_CLIENT_ID,
|
|
13
11
|
'BW_CLIENT_SECRET': process.env.BW_CLIENT_SECRET,
|
|
14
12
|
'BW_ACCOUNT_ID': process.env.BW_ACCOUNT_ID,
|
|
@@ -22,10 +20,6 @@ module.exports = {
|
|
|
22
20
|
'MANTECA_IDLE_NUMBER': process.env.MANTECA_IDLE_NUMBER,
|
|
23
21
|
'MANTECA_ACTIVE_NUMBER': process.env.MANTECA_ACTIVE_NUMBER,
|
|
24
22
|
'MANTECA_BASE_URL': process.env.MANTECA_BASE_URL,
|
|
25
|
-
'FORBIDDEN_USERNAME': process.env.BW_USERNAME_FORBIDDEN,
|
|
26
|
-
'FORBIDDEN_PASSWORD': process.env.BW_PASSWORD_FORBIDDEN,
|
|
27
|
-
'UNAUTHORIZED_USERNAME': 'bad_username',
|
|
28
|
-
'UNAUTHORIZED_PASSWORD': 'bad_password',
|
|
29
23
|
'MAX_RETRIES': 40,
|
|
30
24
|
'SLEEP_TIME_S': 3
|
|
31
25
|
}
|
package/models/callback.ts
CHANGED
|
@@ -30,6 +30,6 @@ import type { StatusCallback } from './status-callback';
|
|
|
30
30
|
* @type Callback
|
|
31
31
|
* Callbacks are divided into two types based on direction of the related message: - `statusCallback` indicates status of an outbound MT SMS, MMS, or RBM message. - `inboundCallback` indicates an inbound MO message or a multichannel message client\'s response to a suggestion or location request.
|
|
32
32
|
*/
|
|
33
|
-
export type Callback = { type: 'message-delivered' } & StatusCallback | { type: 'message-failed' } & StatusCallback | { type: 'message-read' } & StatusCallback | { type: 'message-received' } & InboundCallback | { type: 'message-sending' } & StatusCallback | { type: 'message-sent' } & StatusCallback | { type: 'requested-location-response' } & InboundCallback | { type: 'suggestion-response' } & InboundCallback;
|
|
33
|
+
export type Callback = { type: 'message-delivered' } & StatusCallback | { type: 'message-failed' } & StatusCallback | { type: 'message-read' } & StatusCallback | { type: 'message-received' } & InboundCallback | { type: 'message-sending' } & StatusCallback | { type: 'message-sent' } & StatusCallback | { type: 'requested-location-response' } & InboundCallback | { type: 'session-started' } & StatusCallback | { type: 'suggestion-response' } & InboundCallback;
|
|
34
34
|
|
|
35
35
|
|
|
@@ -91,9 +91,17 @@ export interface DisconnectCallback {
|
|
|
91
91
|
*/
|
|
92
92
|
'sipCallId'?: string;
|
|
93
93
|
/**
|
|
94
|
-
* (optional) The SIP status code
|
|
94
|
+
* (optional) The SIP status code of the final response that rejected an outbound call\'s (or transferred leg\'s) INVITE (e.g. 486 for busy, 603 for decline). Present only when the call was rejected with a SIP response.
|
|
95
95
|
*/
|
|
96
96
|
'sipResponseCode'?: number;
|
|
97
|
+
/**
|
|
98
|
+
* (optional) The full SIP status line, exactly as received, of the final response that rejected an outbound call\'s INVITE. The reason phrase can help distinguish outcomes that share a status code, such as `603 Network Blocked` and `603 Decline`. Present only when an outbound call was rejected with a SIP response.
|
|
99
|
+
*/
|
|
100
|
+
'sipStatusLine'?: string;
|
|
101
|
+
/**
|
|
102
|
+
* (optional) Map of SIP headers, with lowercase keys (SIP headers are case-insensitive). On the Initiate callback, contains the customer-supplied X-* headers from the original INVITE; present only for inbound SIP URI calls with custom headers. On the Disconnect and Transfer Disconnect callbacks, contains a single `reason` key holding the raw, unmodified `Reason` header value from the final SIP response that rejected an outbound call (or transferred leg); present only when that response included a `Reason` header (for example, `v=analytics1` call-analytics block information from a terminating carrier). If the response carries more than one `Reason` header, all values are returned in the order received, separated by `, `. Note - on the Initiate callback, keys preserve the original SIP header name in lowercase rather than Bandwidth\'s usual camelCase JSON convention, since these are passthrough values from the caller\'s SIP INVITE, not Bandwidth-defined fields. If the same header name is sent more than once in the INVITE, only the last value is kept. The example shown is for the Initiate callback; on the Disconnect and Transfer Disconnect callbacks the only key is `reason`.
|
|
103
|
+
*/
|
|
104
|
+
'sipHeaders'?: { [key: string]: string; };
|
|
97
105
|
}
|
|
98
106
|
|
|
99
107
|
|
|
@@ -30,6 +30,9 @@ import type { PriorityEnum } from './priority-enum';
|
|
|
30
30
|
import type { RbmLocationResponse } from './rbm-location-response';
|
|
31
31
|
// May contain unused imports in some cases
|
|
32
32
|
// @ts-ignore
|
|
33
|
+
import type { RbmSession } from './rbm-session';
|
|
34
|
+
// May contain unused imports in some cases
|
|
35
|
+
// @ts-ignore
|
|
33
36
|
import type { RbmSuggestionResponse } from './rbm-suggestion-response';
|
|
34
37
|
// May contain unused imports in some cases
|
|
35
38
|
// @ts-ignore
|
|
@@ -76,6 +79,7 @@ export interface InboundCallbackMessage {
|
|
|
76
79
|
'media'?: Array<string>;
|
|
77
80
|
'priority'?: PriorityEnum;
|
|
78
81
|
'channel'?: MultiChannelMessageChannelEnum;
|
|
82
|
+
'session'?: RbmSession;
|
|
79
83
|
'content'?: MultiChannelMessageContent;
|
|
80
84
|
'suggestionResponse'?: RbmSuggestionResponse;
|
|
81
85
|
'locationResponse'?: RbmLocationResponse;
|
package/models/index.ts
CHANGED
|
@@ -144,6 +144,7 @@ export * from './rbm-message-content-rich-card';
|
|
|
144
144
|
export * from './rbm-message-content-text';
|
|
145
145
|
export * from './rbm-message-media';
|
|
146
146
|
export * from './rbm-open-url-enum';
|
|
147
|
+
export * from './rbm-session';
|
|
147
148
|
export * from './rbm-standalone-card';
|
|
148
149
|
export * from './rbm-suggestion-response';
|
|
149
150
|
export * from './rbm-web-view-enum';
|
|
@@ -75,7 +75,7 @@ export interface InitiateCallback {
|
|
|
75
75
|
*/
|
|
76
76
|
'sipCallId'?: string;
|
|
77
77
|
/**
|
|
78
|
-
* (optional) Map of customer-supplied X-* headers from the original INVITE
|
|
78
|
+
* (optional) Map of SIP headers, with lowercase keys (SIP headers are case-insensitive). On the Initiate callback, contains the customer-supplied X-* headers from the original INVITE; present only for inbound SIP URI calls with custom headers. On the Disconnect and Transfer Disconnect callbacks, contains a single `reason` key holding the raw, unmodified `Reason` header value from the final SIP response that rejected an outbound call (or transferred leg); present only when that response included a `Reason` header (for example, `v=analytics1` call-analytics block information from a terminating carrier). If the response carries more than one `Reason` header, all values are returned in the order received, separated by `, `. Note - on the Initiate callback, keys preserve the original SIP header name in lowercase rather than Bandwidth\'s usual camelCase JSON convention, since these are passthrough values from the caller\'s SIP INVITE, not Bandwidth-defined fields. If the same header name is sent more than once in the INVITE, only the last value is kept. The example shown is for the Initiate callback; on the Disconnect and Transfer Disconnect callbacks the only key is `reason`.
|
|
79
79
|
*/
|
|
80
80
|
'sipHeaders'?: { [key: string]: string; };
|
|
81
81
|
}
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Bandwidth
|
|
5
|
+
* Bandwidth\'s Communication APIs
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
* Contact: letstalk@bandwidth.com
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
* RCS interactive session information for the message. An interactive session is a 24-hour window covering all Rich and Rich Media messages exchanged between an RCS agent and a specific end user mobile number. It is triggered when at least 4 messages are exchanged within 24 hours, at least 2 of them mobile-originated and at least 1 mobile-terminated. Only present on `message-delivered`, `message-received` and `session-started` callbacks for RBM messages of US agents with the Conversational billing category. Omitted for all other messages.
|
|
19
|
+
*/
|
|
20
|
+
export interface RbmSession {
|
|
21
|
+
/**
|
|
22
|
+
* Whether the message can start an interactive session. `false` if the message is already part of an active session, or if the agent is not eligible for interactive session billing.
|
|
23
|
+
*/
|
|
24
|
+
'canInitiate': boolean;
|
|
25
|
+
/**
|
|
26
|
+
* The unique identifier of the interactive session the message is part of. This is not a message ID. Omitted if the message is not part of a session.
|
|
27
|
+
*/
|
|
28
|
+
'id'?: string | null;
|
|
29
|
+
/**
|
|
30
|
+
* The type of the interactive session. Only present on `session-started` callbacks.
|
|
31
|
+
*/
|
|
32
|
+
'type'?: string | null;
|
|
33
|
+
/**
|
|
34
|
+
* The time the 24-hour session window opened. Only present on `session-started` callbacks.
|
|
35
|
+
*/
|
|
36
|
+
'startTime'?: string | null;
|
|
37
|
+
/**
|
|
38
|
+
* The time the 24-hour session window closes. Only present on `session-started` callbacks.
|
|
39
|
+
*/
|
|
40
|
+
'endTime'?: string | null;
|
|
41
|
+
}
|
|
42
|
+
|
|
@@ -16,11 +16,11 @@
|
|
|
16
16
|
|
|
17
17
|
export interface RbmSuggestionResponse {
|
|
18
18
|
/**
|
|
19
|
-
* The text
|
|
19
|
+
* The text of the suggestion the user tapped.
|
|
20
20
|
*/
|
|
21
21
|
'text'?: string;
|
|
22
22
|
/**
|
|
23
|
-
*
|
|
23
|
+
* Payload the customer receives when the reply is clicked.
|
|
24
24
|
*/
|
|
25
25
|
'postbackData'?: string;
|
|
26
26
|
/**
|
|
@@ -22,6 +22,9 @@ import type { MultiChannelMessageChannelEnum } from './multi-channel-message-cha
|
|
|
22
22
|
// May contain unused imports in some cases
|
|
23
23
|
// @ts-ignore
|
|
24
24
|
import type { PriorityEnum } from './priority-enum';
|
|
25
|
+
// May contain unused imports in some cases
|
|
26
|
+
// @ts-ignore
|
|
27
|
+
import type { RbmSession } from './rbm-session';
|
|
25
28
|
|
|
26
29
|
/**
|
|
27
30
|
* Message payload schema within a callback
|
|
@@ -64,6 +67,7 @@ export interface StatusCallbackMessage {
|
|
|
64
67
|
'media'?: Array<string>;
|
|
65
68
|
'priority'?: PriorityEnum;
|
|
66
69
|
'channel'?: MultiChannelMessageChannelEnum;
|
|
70
|
+
'session'?: RbmSession;
|
|
67
71
|
}
|
|
68
72
|
|
|
69
73
|
|