bandwidth-sdk 8.3.0 → 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/CODEOWNERS +0 -3
- package/.github/workflows/deploy.yml +1 -30
- 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 +8 -24
- 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 +12 -48
- package/api/transcriptions-api.ts +0 -12
- package/bandwidth.yml +341 -122
- 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 +14 -62
- 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 +18 -126
- 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 +2 -2
- package/coverage/lcov-report/node-sdk/models/business-registration-type-enum.ts.html +2 -2
- 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.d.ts +8 -8
- package/dist/api/media-api.js +8 -20
- 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.d.ts +12 -12
- package/dist/api/toll-free-verification-api.js +12 -39
- 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/business-entity-type-enum.d.ts +1 -1
- package/dist/models/business-entity-type-enum.js +1 -1
- package/dist/models/business-registration-type-enum.d.ts +1 -1
- package/dist/models/business-registration-type-enum.js +1 -1
- 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/tfv-submission-info.d.ts +2 -2
- package/dist/models/transfer-disconnect-callback.d.ts +14 -0
- package/dist/models/verification-request.d.ts +2 -2
- package/dist/models/verification-update-request.d.ts +3 -3
- package/docs/BusinessEntityTypeEnum.md +1 -1
- package/docs/BusinessRegistrationTypeEnum.md +1 -1
- 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 +7 -7
- 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/TfvSubmissionInfo.md +2 -2
- package/docs/TollFreeVerificationApi.md +15 -12
- package/docs/TranscriptionsApi.md +3 -3
- package/docs/TransferDisconnectCallback.md +6 -0
- package/docs/VerificationRequest.md +2 -2
- package/docs/VerificationUpdateRequest.md +3 -3
- package/generate.sh +6 -0
- package/jest.config.js +0 -6
- package/models/business-entity-type-enum.ts +1 -1
- package/models/business-registration-type-enum.ts +1 -1
- 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/tfv-submission-info.ts +2 -2
- package/models/transfer-disconnect-callback.ts +12 -0
- package/models/verification-request.ts +2 -2
- package/models/verification-update-request.ts +3 -3
- 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
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Bandwidth
|
|
3
|
+
* Bandwidth\'s Communication APIs
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
* Contact: letstalk@bandwidth.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* 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.
|
|
14
|
+
*/
|
|
15
|
+
export interface RbmSession {
|
|
16
|
+
/**
|
|
17
|
+
* 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.
|
|
18
|
+
*/
|
|
19
|
+
'canInitiate': boolean;
|
|
20
|
+
/**
|
|
21
|
+
* 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.
|
|
22
|
+
*/
|
|
23
|
+
'id'?: string | null;
|
|
24
|
+
/**
|
|
25
|
+
* The type of the interactive session. Only present on `session-started` callbacks.
|
|
26
|
+
*/
|
|
27
|
+
'type'?: string | null;
|
|
28
|
+
/**
|
|
29
|
+
* The time the 24-hour session window opened. Only present on `session-started` callbacks.
|
|
30
|
+
*/
|
|
31
|
+
'startTime'?: string | null;
|
|
32
|
+
/**
|
|
33
|
+
* The time the 24-hour session window closes. Only present on `session-started` callbacks.
|
|
34
|
+
*/
|
|
35
|
+
'endTime'?: string | null;
|
|
36
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Bandwidth
|
|
6
|
+
* Bandwidth\'s Communication APIs
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
* Contact: letstalk@bandwidth.com
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -11,11 +11,11 @@
|
|
|
11
11
|
*/
|
|
12
12
|
export interface RbmSuggestionResponse {
|
|
13
13
|
/**
|
|
14
|
-
* The text
|
|
14
|
+
* The text of the suggestion the user tapped.
|
|
15
15
|
*/
|
|
16
16
|
'text'?: string;
|
|
17
17
|
/**
|
|
18
|
-
*
|
|
18
|
+
* Payload the customer receives when the reply is clicked.
|
|
19
19
|
*/
|
|
20
20
|
'postbackData'?: string;
|
|
21
21
|
/**
|
|
@@ -12,6 +12,7 @@
|
|
|
12
12
|
import type { MessageDirectionEnum } from './message-direction-enum';
|
|
13
13
|
import type { MultiChannelMessageChannelEnum } from './multi-channel-message-channel-enum';
|
|
14
14
|
import type { PriorityEnum } from './priority-enum';
|
|
15
|
+
import type { RbmSession } from './rbm-session';
|
|
15
16
|
/**
|
|
16
17
|
* Message payload schema within a callback
|
|
17
18
|
*/
|
|
@@ -53,4 +54,5 @@ export interface StatusCallbackMessage {
|
|
|
53
54
|
'media'?: Array<string>;
|
|
54
55
|
'priority'?: PriorityEnum;
|
|
55
56
|
'channel'?: MultiChannelMessageChannelEnum;
|
|
57
|
+
'session'?: RbmSession;
|
|
56
58
|
}
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
/**
|
|
13
|
-
* 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.
|
|
13
|
+
* 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.
|
|
14
14
|
*/
|
|
15
15
|
export declare const StatusCallbackTypeEnum: {
|
|
16
16
|
readonly MessageSending: "message-sending";
|
|
@@ -18,5 +18,6 @@ export declare const StatusCallbackTypeEnum: {
|
|
|
18
18
|
readonly MessageDelivered: "message-delivered";
|
|
19
19
|
readonly MessageFailed: "message-failed";
|
|
20
20
|
readonly MessageRead: "message-read";
|
|
21
|
+
readonly SessionStarted: "session-started";
|
|
21
22
|
};
|
|
22
23
|
export type StatusCallbackTypeEnum = typeof StatusCallbackTypeEnum[keyof typeof StatusCallbackTypeEnum];
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
16
|
exports.StatusCallbackTypeEnum = void 0;
|
|
17
17
|
/**
|
|
18
|
-
* 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.
|
|
18
|
+
* 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.
|
|
19
19
|
*/
|
|
20
20
|
exports.StatusCallbackTypeEnum = {
|
|
21
21
|
MessageSending: 'message-sending',
|
|
@@ -23,4 +23,5 @@ exports.StatusCallbackTypeEnum = {
|
|
|
23
23
|
MessageDelivered: 'message-delivered',
|
|
24
24
|
MessageFailed: 'message-failed',
|
|
25
25
|
MessageRead: 'message-read',
|
|
26
|
+
SessionStarted: 'session-started',
|
|
26
27
|
};
|
|
@@ -55,12 +55,12 @@ export interface TfvSubmissionInfo {
|
|
|
55
55
|
*/
|
|
56
56
|
'businessDba'?: string;
|
|
57
57
|
/**
|
|
58
|
-
* Government-issued business identifying number. **
|
|
58
|
+
* Government-issued business identifying number. **As of October 19th, 2026 this field is required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.**
|
|
59
59
|
*/
|
|
60
60
|
'businessRegistrationNumber'?: string | null;
|
|
61
61
|
'businessRegistrationType'?: BusinessRegistrationTypeEnum | null;
|
|
62
62
|
/**
|
|
63
|
-
* The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 format is accepted by the API, but alpha-3 is highly encouraged. **
|
|
63
|
+
* The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 format is accepted by the API, but alpha-3 is highly encouraged. **As of October 19th, 2026 this field is required when `businessRegistrationNumber` is provided.** | Registration Type | Supported Countries | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code |
|
|
64
64
|
*/
|
|
65
65
|
'businessRegistrationIssuingCountry'?: string | null;
|
|
66
66
|
'businessEntityType'?: BusinessEntityTypeEnum;
|
|
@@ -91,4 +91,18 @@ export interface TransferDisconnectCallback {
|
|
|
91
91
|
* Bandwidth\'s internal id that references the error event.
|
|
92
92
|
*/
|
|
93
93
|
'errorId'?: string | null;
|
|
94
|
+
/**
|
|
95
|
+
* (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.
|
|
96
|
+
*/
|
|
97
|
+
'sipResponseCode'?: number;
|
|
98
|
+
/**
|
|
99
|
+
* (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.
|
|
100
|
+
*/
|
|
101
|
+
'sipStatusLine'?: string;
|
|
102
|
+
/**
|
|
103
|
+
* (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`.
|
|
104
|
+
*/
|
|
105
|
+
'sipHeaders'?: {
|
|
106
|
+
[key: string]: string;
|
|
107
|
+
};
|
|
94
108
|
}
|
|
@@ -56,12 +56,12 @@ export interface VerificationRequest {
|
|
|
56
56
|
*/
|
|
57
57
|
'businessDba'?: string;
|
|
58
58
|
/**
|
|
59
|
-
* Government-issued business identifying number. **
|
|
59
|
+
* Government-issued business identifying number. **As of October 19th, 2026 this field is required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.**
|
|
60
60
|
*/
|
|
61
61
|
'businessRegistrationNumber'?: string | null;
|
|
62
62
|
'businessRegistrationType'?: BusinessRegistrationTypeEnum | null;
|
|
63
63
|
/**
|
|
64
|
-
* The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 format is accepted by the API, but alpha-3 is highly encouraged. **
|
|
64
|
+
* The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 format is accepted by the API, but alpha-3 is highly encouraged. **As of October 19th, 2026 this field is required when `businessRegistrationNumber` is provided.** | Registration Type | Supported Countries | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code |
|
|
65
65
|
*/
|
|
66
66
|
'businessRegistrationIssuingCountry'?: string | null;
|
|
67
67
|
'businessEntityType': BusinessEntityTypeEnum;
|
|
@@ -55,13 +55,13 @@ export interface VerificationUpdateRequest {
|
|
|
55
55
|
*/
|
|
56
56
|
'businessDba'?: string;
|
|
57
57
|
/**
|
|
58
|
-
* Government-issued business identifying number. **
|
|
58
|
+
* Government-issued business identifying number. **As of October 19th, 2026 this field is required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.**
|
|
59
59
|
*/
|
|
60
60
|
'businessRegistrationNumber'?: string | null;
|
|
61
61
|
'businessRegistrationType'?: BusinessRegistrationTypeEnum | null;
|
|
62
|
-
'businessEntityType'
|
|
62
|
+
'businessEntityType': BusinessEntityTypeEnum;
|
|
63
63
|
/**
|
|
64
|
-
* The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 format is accepted by the API, but alpha-3 is highly encouraged. **
|
|
64
|
+
* The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 format is accepted by the API, but alpha-3 is highly encouraged. **As of October 19th, 2026 this field is required when `businessRegistrationNumber` is provided.** | Registration Type | Supported Countries | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code |
|
|
65
65
|
*/
|
|
66
66
|
'businessRegistrationIssuingCountry'?: string | null;
|
|
67
67
|
/**
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# BusinessEntityTypeEnum
|
|
2
2
|
|
|
3
|
-
The type of registered business. **
|
|
3
|
+
The type of registered business. **As of October 19th, 2026 submissions using a value other than `SOLE_PROPRIETOR` must provide a value for `businessRegistrationNumber`, `businessRegistrationType`, and `businessRegistrationIssuingCountry`. Submissions using `SOLE_PROPRIETOR` must _omit_ `businessRegistrationNumber`, `businessRegistrationType`, and `businessRegistrationIssuingCountry`. Failure to adhere to these constraints will result in a 400 Bad Request rejection.**
|
|
4
4
|
|
|
5
5
|
## Enum
|
|
6
6
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# BusinessRegistrationTypeEnum
|
|
2
2
|
|
|
3
|
-
The type of business registration number. **
|
|
3
|
+
The type of business registration number. **As of October 19th, 2026 this field is required when `businessRegistrationNumber` is provided.**
|
|
4
4
|
|
|
5
5
|
## Enum
|
|
6
6
|
|
package/docs/CallsApi.md
CHANGED
|
@@ -50,7 +50,7 @@ const { status, data } = await apiInstance.createCall(
|
|
|
50
50
|
|
|
51
51
|
### Authorization
|
|
52
52
|
|
|
53
|
-
[
|
|
53
|
+
[OAuth2](../README.md#OAuth2)
|
|
54
54
|
|
|
55
55
|
### HTTP request headers
|
|
56
56
|
|
|
@@ -112,7 +112,7 @@ const { status, data } = await apiInstance.getCallState(
|
|
|
112
112
|
|
|
113
113
|
### Authorization
|
|
114
114
|
|
|
115
|
-
[
|
|
115
|
+
[OAuth2](../README.md#OAuth2)
|
|
116
116
|
|
|
117
117
|
### HTTP request headers
|
|
118
118
|
|
|
@@ -192,7 +192,7 @@ const { status, data } = await apiInstance.listCalls(
|
|
|
192
192
|
|
|
193
193
|
### Authorization
|
|
194
194
|
|
|
195
|
-
[
|
|
195
|
+
[OAuth2](../README.md#OAuth2)
|
|
196
196
|
|
|
197
197
|
### HTTP request headers
|
|
198
198
|
|
|
@@ -258,7 +258,7 @@ void (empty response body)
|
|
|
258
258
|
|
|
259
259
|
### Authorization
|
|
260
260
|
|
|
261
|
-
[
|
|
261
|
+
[OAuth2](../README.md#OAuth2)
|
|
262
262
|
|
|
263
263
|
### HTTP request headers
|
|
264
264
|
|
|
@@ -324,7 +324,7 @@ void (empty response body)
|
|
|
324
324
|
|
|
325
325
|
### Authorization
|
|
326
326
|
|
|
327
|
-
[
|
|
327
|
+
[OAuth2](../README.md#OAuth2)
|
|
328
328
|
|
|
329
329
|
### HTTP request headers
|
|
330
330
|
|
package/docs/ConferencesApi.md
CHANGED
|
@@ -56,7 +56,7 @@ const { status, data } = await apiInstance.downloadConferenceRecording(
|
|
|
56
56
|
|
|
57
57
|
### Authorization
|
|
58
58
|
|
|
59
|
-
[
|
|
59
|
+
[OAuth2](../README.md#OAuth2)
|
|
60
60
|
|
|
61
61
|
### HTTP request headers
|
|
62
62
|
|
|
@@ -118,7 +118,7 @@ const { status, data } = await apiInstance.getConference(
|
|
|
118
118
|
|
|
119
119
|
### Authorization
|
|
120
120
|
|
|
121
|
-
[
|
|
121
|
+
[OAuth2](../README.md#OAuth2)
|
|
122
122
|
|
|
123
123
|
### HTTP request headers
|
|
124
124
|
|
|
@@ -183,7 +183,7 @@ const { status, data } = await apiInstance.getConferenceMember(
|
|
|
183
183
|
|
|
184
184
|
### Authorization
|
|
185
185
|
|
|
186
|
-
[
|
|
186
|
+
[OAuth2](../README.md#OAuth2)
|
|
187
187
|
|
|
188
188
|
### HTTP request headers
|
|
189
189
|
|
|
@@ -248,7 +248,7 @@ const { status, data } = await apiInstance.getConferenceRecording(
|
|
|
248
248
|
|
|
249
249
|
### Authorization
|
|
250
250
|
|
|
251
|
-
[
|
|
251
|
+
[OAuth2](../README.md#OAuth2)
|
|
252
252
|
|
|
253
253
|
### HTTP request headers
|
|
254
254
|
|
|
@@ -310,7 +310,7 @@ const { status, data } = await apiInstance.listConferenceRecordings(
|
|
|
310
310
|
|
|
311
311
|
### Authorization
|
|
312
312
|
|
|
313
|
-
[
|
|
313
|
+
[OAuth2](../README.md#OAuth2)
|
|
314
314
|
|
|
315
315
|
### HTTP request headers
|
|
316
316
|
|
|
@@ -384,7 +384,7 @@ const { status, data } = await apiInstance.listConferences(
|
|
|
384
384
|
|
|
385
385
|
### Authorization
|
|
386
386
|
|
|
387
|
-
[
|
|
387
|
+
[OAuth2](../README.md#OAuth2)
|
|
388
388
|
|
|
389
389
|
### HTTP request headers
|
|
390
390
|
|
|
@@ -450,7 +450,7 @@ void (empty response body)
|
|
|
450
450
|
|
|
451
451
|
### Authorization
|
|
452
452
|
|
|
453
|
-
[
|
|
453
|
+
[OAuth2](../README.md#OAuth2)
|
|
454
454
|
|
|
455
455
|
### HTTP request headers
|
|
456
456
|
|
|
@@ -515,7 +515,7 @@ void (empty response body)
|
|
|
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
|
|
|
@@ -24,7 +24,9 @@ Name | Type | Description | Notes
|
|
|
24
24
|
**errorId** | **string** | Bandwidth\'s internal id that references the error event. | [optional] [default to undefined]
|
|
25
25
|
**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]
|
|
26
26
|
**sipCallId** | **string** | (optional) The SIP Call-ID of the call\'s current SIP dialog with Bandwidth\'s SBC. Used to correlate dialogs and trace calls. Present on any call, inbound or outbound, once that dialog has been established; may be absent very early in a call before the dialog exists. | [optional] [default to undefined]
|
|
27
|
-
**sipResponseCode** | **number** | (optional) The SIP status code
|
|
27
|
+
**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]
|
|
28
|
+
**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]
|
|
29
|
+
**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]
|
|
28
30
|
|
|
29
31
|
## Example
|
|
30
32
|
|
|
@@ -51,6 +53,8 @@ const instance: DisconnectCallback = {
|
|
|
51
53
|
tag,
|
|
52
54
|
sipCallId,
|
|
53
55
|
sipResponseCode,
|
|
56
|
+
sipStatusLine,
|
|
57
|
+
sipHeaders,
|
|
54
58
|
};
|
|
55
59
|
```
|
|
56
60
|
|
package/docs/EndpointsApi.md
CHANGED
|
@@ -49,7 +49,7 @@ const { status, data } = await apiInstance.createEndpoint(
|
|
|
49
49
|
|
|
50
50
|
### Authorization
|
|
51
51
|
|
|
52
|
-
[
|
|
52
|
+
[OAuth2](../README.md#OAuth2)
|
|
53
53
|
|
|
54
54
|
### HTTP request headers
|
|
55
55
|
|
|
@@ -111,7 +111,7 @@ void (empty response body)
|
|
|
111
111
|
|
|
112
112
|
### Authorization
|
|
113
113
|
|
|
114
|
-
[
|
|
114
|
+
[OAuth2](../README.md#OAuth2)
|
|
115
115
|
|
|
116
116
|
### HTTP request headers
|
|
117
117
|
|
|
@@ -173,7 +173,7 @@ const { status, data } = await apiInstance.getEndpoint(
|
|
|
173
173
|
|
|
174
174
|
### Authorization
|
|
175
175
|
|
|
176
|
-
[
|
|
176
|
+
[OAuth2](../README.md#OAuth2)
|
|
177
177
|
|
|
178
178
|
### HTTP request headers
|
|
179
179
|
|
|
@@ -244,7 +244,7 @@ const { status, data } = await apiInstance.listEndpoints(
|
|
|
244
244
|
|
|
245
245
|
### Authorization
|
|
246
246
|
|
|
247
|
-
[
|
|
247
|
+
[OAuth2](../README.md#OAuth2)
|
|
248
248
|
|
|
249
249
|
### HTTP request headers
|
|
250
250
|
|
|
@@ -309,7 +309,7 @@ void (empty response body)
|
|
|
309
309
|
|
|
310
310
|
### Authorization
|
|
311
311
|
|
|
312
|
-
[
|
|
312
|
+
[OAuth2](../README.md#OAuth2)
|
|
313
313
|
|
|
314
314
|
### HTTP request headers
|
|
315
315
|
|
|
@@ -18,6 +18,7 @@ Name | Type | Description | Notes
|
|
|
18
18
|
**media** | **Array<string>** | Optional media, not applicable for sms | [optional] [default to undefined]
|
|
19
19
|
**priority** | [**PriorityEnum**](PriorityEnum.md) | | [optional] [default to undefined]
|
|
20
20
|
**channel** | [**MultiChannelMessageChannelEnum**](MultiChannelMessageChannelEnum.md) | | [optional] [default to undefined]
|
|
21
|
+
**session** | [**RbmSession**](RbmSession.md) | | [optional] [default to undefined]
|
|
21
22
|
**content** | [**MultiChannelMessageContent**](MultiChannelMessageContent.md) | | [optional] [default to undefined]
|
|
22
23
|
**suggestionResponse** | [**RbmSuggestionResponse**](RbmSuggestionResponse.md) | | [optional] [default to undefined]
|
|
23
24
|
**locationResponse** | [**RbmLocationResponse**](RbmLocationResponse.md) | | [optional] [default to undefined]
|
|
@@ -41,6 +42,7 @@ const instance: InboundCallbackMessage = {
|
|
|
41
42
|
media,
|
|
42
43
|
priority,
|
|
43
44
|
channel,
|
|
45
|
+
session,
|
|
44
46
|
content,
|
|
45
47
|
suggestionResponse,
|
|
46
48
|
locationResponse,
|
package/docs/InitiateCallback.md
CHANGED
|
@@ -20,7 +20,7 @@ Name | Type | Description | Notes
|
|
|
20
20
|
**stirShaken** | [**StirShaken**](StirShaken.md) | | [optional] [default to undefined]
|
|
21
21
|
**uui** | **string** | The value of the `User-To-User` header to send within the initial `INVITE`. Must include the encoding parameter as specified in RFC 7433. Only `base64`, `jwt` and `hex` encoding are currently allowed. This value, including the encoding specifier, may not exceed 256 characters. | [optional] [default to undefined]
|
|
22
22
|
**sipCallId** | **string** | (optional) The SIP Call-ID of the call\'s current SIP dialog with Bandwidth\'s SBC. Used to correlate dialogs and trace calls. Present on any call, inbound or outbound, once that dialog has been established; may be absent very early in a call before the dialog exists. | [optional] [default to undefined]
|
|
23
|
-
**sipHeaders** | **{ [key: string]: string; }** | (optional) Map of customer-supplied X-* headers from the original INVITE
|
|
23
|
+
**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]
|
|
24
24
|
|
|
25
25
|
## Example
|
|
26
26
|
|
package/docs/MFAApi.md
CHANGED
|
@@ -48,7 +48,7 @@ const { status, data } = await apiInstance.generateMessagingCode(
|
|
|
48
48
|
|
|
49
49
|
### Authorization
|
|
50
50
|
|
|
51
|
-
[
|
|
51
|
+
[OAuth2](../README.md#OAuth2)
|
|
52
52
|
|
|
53
53
|
### HTTP request headers
|
|
54
54
|
|
|
@@ -107,7 +107,7 @@ const { status, data } = await apiInstance.generateVoiceCode(
|
|
|
107
107
|
|
|
108
108
|
### Authorization
|
|
109
109
|
|
|
110
|
-
[
|
|
110
|
+
[OAuth2](../README.md#OAuth2)
|
|
111
111
|
|
|
112
112
|
### HTTP request headers
|
|
113
113
|
|
|
@@ -166,7 +166,7 @@ const { status, data } = await apiInstance.verifyCode(
|
|
|
166
166
|
|
|
167
167
|
### Authorization
|
|
168
168
|
|
|
169
|
-
[
|
|
169
|
+
[OAuth2](../README.md#OAuth2)
|
|
170
170
|
|
|
171
171
|
### HTTP request headers
|
|
172
172
|
|
package/docs/MediaApi.md
CHANGED
|
@@ -48,7 +48,7 @@ void (empty response body)
|
|
|
48
48
|
|
|
49
49
|
### Authorization
|
|
50
50
|
|
|
51
|
-
[
|
|
51
|
+
[OAuth2](../README.md#OAuth2)
|
|
52
52
|
|
|
53
53
|
### HTTP request headers
|
|
54
54
|
|
|
@@ -110,7 +110,7 @@ const { status, data } = await apiInstance.getMedia(
|
|
|
110
110
|
|
|
111
111
|
### Authorization
|
|
112
112
|
|
|
113
|
-
[
|
|
113
|
+
[OAuth2](../README.md#OAuth2)
|
|
114
114
|
|
|
115
115
|
### HTTP request headers
|
|
116
116
|
|
|
@@ -172,7 +172,7 @@ const { status, data } = await apiInstance.listMedia(
|
|
|
172
172
|
|
|
173
173
|
### Authorization
|
|
174
174
|
|
|
175
|
-
[
|
|
175
|
+
[OAuth2](../README.md#OAuth2)
|
|
176
176
|
|
|
177
177
|
### HTTP request headers
|
|
178
178
|
|
|
@@ -198,7 +198,7 @@ const { status, data } = await apiInstance.listMedia(
|
|
|
198
198
|
# **uploadMedia**
|
|
199
199
|
> uploadMedia(body)
|
|
200
200
|
|
|
201
|
-
Upload a file.
|
|
201
|
+
Upload a file. Filename should always be unique. Reusing filenames may result in the wrong media being sent. A list of supported media types can be found at [Bandwidth Support](https://www.bandwidth.com/support/en/articles/12823220-what-mms-file-types-are-supported).
|
|
202
202
|
|
|
203
203
|
### Example
|
|
204
204
|
|
|
@@ -215,7 +215,7 @@ let accountId: string; //This is your 7-digit Bandwidth Account ID, as shown in
|
|
|
215
215
|
let mediaId: string; //The ID of the media file. (default to undefined)
|
|
216
216
|
let body: File; //
|
|
217
217
|
let contentType: string; //The media type of the entity-body. (optional) (default to undefined)
|
|
218
|
-
let cacheControl: string; //
|
|
218
|
+
let cacheControl: string; //Pass-through header stored with the media and returned when the media is retrieved by the user. Does not affect internal server caching behavior. (optional) (default to undefined)
|
|
219
219
|
|
|
220
220
|
const { status, data } = await apiInstance.uploadMedia(
|
|
221
221
|
accountId,
|
|
@@ -234,7 +234,7 @@ const { status, data } = await apiInstance.uploadMedia(
|
|
|
234
234
|
| **accountId** | [**string**] | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** | defaults to undefined|
|
|
235
235
|
| **mediaId** | [**string**] | The ID of the media file. | defaults to undefined|
|
|
236
236
|
| **contentType** | [**string**] | The media type of the entity-body. | (optional) defaults to undefined|
|
|
237
|
-
| **cacheControl** | [**string**] |
|
|
237
|
+
| **cacheControl** | [**string**] | Pass-through header stored with the media and returned when the media is retrieved by the user. Does not affect internal server caching behavior. | (optional) defaults to undefined|
|
|
238
238
|
|
|
239
239
|
|
|
240
240
|
### Return type
|
|
@@ -243,7 +243,7 @@ void (empty response body)
|
|
|
243
243
|
|
|
244
244
|
### Authorization
|
|
245
245
|
|
|
246
|
-
[
|
|
246
|
+
[OAuth2](../README.md#OAuth2)
|
|
247
247
|
|
|
248
248
|
### HTTP request headers
|
|
249
249
|
|
package/docs/MessagesApi.md
CHANGED
|
@@ -47,7 +47,7 @@ const { status, data } = await apiInstance.createMessage(
|
|
|
47
47
|
|
|
48
48
|
### Authorization
|
|
49
49
|
|
|
50
|
-
[
|
|
50
|
+
[OAuth2](../README.md#OAuth2)
|
|
51
51
|
|
|
52
52
|
### HTTP request headers
|
|
53
53
|
|
|
@@ -188,7 +188,7 @@ const { status, data } = await apiInstance.listMessages(
|
|
|
188
188
|
|
|
189
189
|
### Authorization
|
|
190
190
|
|
|
191
|
-
[
|
|
191
|
+
[OAuth2](../README.md#OAuth2)
|
|
192
192
|
|
|
193
193
|
### HTTP request headers
|
|
194
194
|
|
|
@@ -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
|