bandwidth-sdk 5.1.0 → 6.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/.openapi-generator/FILES +30 -18
- package/api/multi-channel-api.ts +1 -3
- package/api/toll-free-verification-api.ts +80 -0
- package/bandwidth.yml +518 -174
- package/base.ts +6 -0
- package/configuration.ts +1 -1
- package/coverage/clover.xml +213 -189
- package/coverage/coverage-final.json +7 -8
- package/coverage/lcov-report/index.html +20 -20
- package/coverage/lcov-report/node-sdk/api/calls-api.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/api/conferences-api.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/api/index.html +15 -15
- package/coverage/lcov-report/node-sdk/api/media-api.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/api/messages-api.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/api/mfaapi.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/api/multi-channel-api.ts.html +3 -9
- package/coverage/lcov-report/node-sdk/api/phone-number-lookup-api.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/api/recordings-api.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/api/statistics-api.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/api/toll-free-verification-api.ts.html +251 -11
- package/coverage/lcov-report/node-sdk/api/transcriptions-api.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/api.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/base.ts.html +20 -2
- package/coverage/lcov-report/node-sdk/common.ts.html +18 -18
- package/coverage/lcov-report/node-sdk/configuration.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/index.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/CustomParam.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/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/conference-state-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/{multi-channel-status-enum.ts.html → inbound-callback-type-enum.ts.html} +10 -13
- package/coverage/lcov-report/node-sdk/models/index.html +16 -31
- package/coverage/lcov-report/node-sdk/models/index.ts.html +31 -13
- package/coverage/lcov-report/node-sdk/models/list-message-direction-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/lookup-status-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 +2 -2
- 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/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/standalone-card-orientation-enum.ts.html +1 -1
- package/coverage/lcov-report/node-sdk/models/{callback-type-enum.ts.html → status-callback-type-enum.ts.html} +8 -8
- 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.info +553 -496
- package/dist/api/toll-free-verification-api.d.ts +37 -0
- package/dist/api/toll-free-verification-api.js +92 -0
- package/dist/base.js +6 -0
- package/dist/configuration.js +1 -1
- package/dist/models/callback.d.ts +33 -0
- package/dist/models/create-multi-channel-message-response.d.ts +3 -3
- package/dist/models/error-object.d.ts +11 -4
- package/dist/models/error-source.d.ts +42 -0
- package/dist/models/failure-webhook.d.ts +1 -1
- package/dist/models/inbound-callback-message.d.ts +17 -0
- package/dist/models/inbound-callback-type-enum.d.ts +22 -0
- package/dist/models/inbound-callback-type-enum.js +26 -0
- package/dist/models/inbound-callback.d.ts +56 -0
- package/dist/models/index.d.ts +15 -9
- package/dist/models/index.js +15 -9
- package/dist/models/list-message-item.d.ts +1 -1
- package/dist/models/message-request.d.ts +1 -1
- package/dist/models/message.d.ts +3 -3
- package/dist/models/mms-message-content-file.d.ts +24 -0
- package/dist/models/mms-message-content.d.ts +4 -3
- package/dist/models/multi-channel-error.d.ts +38 -0
- package/dist/models/multi-channel-message-content.d.ts +31 -0
- package/dist/models/{tag.d.ts → multi-channel-message-response-data-channel-list-inner.d.ts} +3 -16
- package/dist/models/multi-channel-message-response-data-channel-list-inner.js +15 -0
- package/dist/models/multi-channel-message-response-data.d.ts +69 -0
- package/dist/models/multi-channel-message-response-data.js +15 -0
- package/dist/models/priority-enum.d.ts +1 -1
- package/dist/models/priority-enum.js +1 -1
- package/dist/models/rbm-action-base.d.ts +1 -1
- package/dist/models/{deferred-result.d.ts → rbm-location-response.d.ts} +10 -10
- package/dist/models/rbm-location-response.js +15 -0
- package/dist/models/rbm-suggestion-response.d.ts +30 -0
- package/dist/models/rbm-suggestion-response.js +15 -0
- package/dist/models/status-callback-message.d.ts +99 -0
- package/dist/models/status-callback-message.js +15 -0
- package/dist/models/status-callback-type-enum.d.ts +23 -0
- package/dist/models/status-callback-type-enum.js +27 -0
- package/dist/models/status-callback.d.ts +68 -0
- package/dist/models/status-callback.js +15 -0
- package/docs/Callback.md +35 -0
- package/docs/CreateMultiChannelMessageResponse.md +1 -1
- package/docs/ErrorObject.md +6 -4
- package/docs/ErrorSource.md +27 -0
- package/docs/FailureWebhook.md +2 -2
- package/docs/InboundCallback.md +31 -0
- package/docs/InboundCallbackMessage.md +50 -0
- package/docs/InboundCallbackTypeEnum.md +13 -0
- package/docs/ListMessageItem.md +1 -1
- package/docs/Message.md +3 -3
- package/docs/MessageRequest.md +1 -1
- package/docs/MessagesApi.md +1 -0
- package/docs/MmsMessageContent.md +1 -1
- package/docs/MmsMessageContentFile.md +20 -0
- package/docs/MultiChannelAction.md +2 -2
- package/docs/MultiChannelActionCalendarEvent.md +2 -2
- package/docs/MultiChannelApi.md +1 -0
- package/docs/MultiChannelChannelListObjectContent.md +1 -1
- package/docs/MultiChannelError.md +24 -0
- package/docs/MultiChannelMessageContent.md +23 -0
- package/docs/MultiChannelMessageResponseData.md +35 -0
- package/docs/MultiChannelMessageResponseDataChannelListInner.md +28 -0
- package/docs/PriorityEnum.md +1 -1
- package/docs/RbmActionBase.md +2 -2
- package/docs/RbmActionDial.md +2 -2
- package/docs/RbmActionOpenUrl.md +2 -2
- package/docs/RbmActionViewLocation.md +2 -2
- package/docs/RbmLocationResponse.md +22 -0
- package/docs/RbmSuggestionResponse.md +22 -0
- package/docs/StatusCallback.md +35 -0
- package/docs/StatusCallbackMessage.md +45 -0
- package/docs/StatusCallbackTypeEnum.md +15 -0
- package/docs/TollFreeVerificationApi.md +63 -0
- package/models/callback.ts +36 -0
- package/models/create-multi-channel-message-response.ts +3 -3
- package/models/error-object.ts +13 -4
- package/models/error-source.ts +48 -0
- package/models/failure-webhook.ts +1 -1
- package/models/inbound-callback-message.ts +44 -0
- package/models/inbound-callback-type-enum.ts +32 -0
- package/models/inbound-callback.ts +68 -0
- package/models/index.ts +15 -9
- package/models/list-message-item.ts +1 -1
- package/models/message-request.ts +1 -1
- package/models/message.ts +3 -3
- package/models/mms-message-content-file.ts +30 -0
- package/models/mms-message-content.ts +6 -3
- package/models/multi-channel-channel-list-object-content.ts +3 -0
- package/models/multi-channel-error.ts +48 -0
- package/models/multi-channel-message-content.ts +39 -0
- package/models/multi-channel-message-response-data-channel-list-inner.ts +32 -0
- package/models/multi-channel-message-response-data.ts +83 -0
- package/models/priority-enum.ts +1 -1
- package/models/rbm-action-base.ts +1 -1
- package/models/{deferred-result.ts → rbm-location-response.ts} +10 -10
- package/models/{tag.ts → rbm-suggestion-response.ts} +8 -8
- package/models/status-callback-message.ts +113 -0
- package/models/status-callback-type-enum.ts +33 -0
- package/models/status-callback.ts +80 -0
- package/package.json +1 -1
- package/tests/unit/api/toll-free-verification-api.test.ts +7 -0
- package/tests/unit/models/inbound-callback-type-enum.test.ts +9 -0
- package/tests/unit/models/status-callback-type-enum.test.ts +10 -0
- package/coverage/lcov-report/node-sdk/models/multi-channel-message-direction-enum.ts.html +0 -178
- package/dist/models/callback-type-enum.d.ts +0 -23
- package/dist/models/callback-type-enum.js +0 -27
- package/dist/models/message-callback-message.d.ts +0 -92
- package/dist/models/message-callback.d.ts +0 -62
- package/dist/models/multi-channel-callback-data.d.ts +0 -50
- package/dist/models/multi-channel-message-callback-data.d.ts +0 -69
- package/dist/models/multi-channel-message-data.d.ts +0 -75
- package/dist/models/multi-channel-message-direction-enum.d.ts +0 -21
- package/dist/models/multi-channel-message-direction-enum.js +0 -25
- package/dist/models/multi-channel-status-enum.d.ts +0 -23
- package/dist/models/multi-channel-status-enum.js +0 -27
- package/docs/CallbackTypeEnum.md +0 -15
- package/docs/DeferredResult.md +0 -22
- package/docs/MessageCallback.md +0 -33
- package/docs/MessageCallbackMessage.md +0 -43
- package/docs/MultiChannelCallbackData.md +0 -28
- package/docs/MultiChannelMessageCallbackData.md +0 -34
- package/docs/MultiChannelMessageData.md +0 -36
- package/docs/MultiChannelMessageDirectionEnum.md +0 -10
- package/docs/MultiChannelStatusEnum.md +0 -14
- package/models/callback-type-enum.ts +0 -33
- package/models/message-callback-message.ts +0 -104
- package/models/message-callback.ts +0 -74
- package/models/multi-channel-callback-data.ts +0 -62
- package/models/multi-channel-message-callback-data.ts +0 -83
- package/models/multi-channel-message-data.ts +0 -89
- package/models/multi-channel-message-direction-enum.ts +0 -31
- package/models/multi-channel-status-enum.ts +0 -33
- package/tests/unit/models/callback-type-enum.test.ts +0 -10
- package/tests/unit/models/multi-channel-message-direction-enum.test.ts +0 -8
- package/tests/unit/models/multi-channel-status-enum.test.ts +0 -10
- /package/dist/models/{deferred-result.js → callback.js} +0 -0
- /package/dist/models/{message-callback-message.js → error-source.js} +0 -0
- /package/dist/models/{message-callback.js → inbound-callback-message.js} +0 -0
- /package/dist/models/{multi-channel-callback-data.js → inbound-callback.js} +0 -0
- /package/dist/models/{multi-channel-message-callback-data.js → mms-message-content-file.js} +0 -0
- /package/dist/models/{multi-channel-message-data.js → multi-channel-error.js} +0 -0
- /package/dist/models/{tag.js → multi-channel-message-content.js} +0 -0
package/docs/Callback.md
ADDED
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# Callback
|
|
2
|
+
|
|
3
|
+
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.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**time** | **string** | | [default to undefined]
|
|
10
|
+
**eventTime** | **string** | Represents the time at which the message was read, for `message-read` callbacks. | [optional] [default to undefined]
|
|
11
|
+
**type** | [**InboundCallbackTypeEnum**](InboundCallbackTypeEnum.md) | | [default to undefined]
|
|
12
|
+
**to** | **string** | The destination phone number the message was sent to. For inbound callbacks, this is the Bandwidth number or alphanumeric identifier that received the message. | [default to undefined]
|
|
13
|
+
**description** | **string** | A detailed description of the event described by the callback. | [default to undefined]
|
|
14
|
+
**message** | [**InboundCallbackMessage**](InboundCallbackMessage.md) | | [default to undefined]
|
|
15
|
+
**errorCode** | **number** | Optional error code, applicable only when type is `message-failed`. | [optional] [default to undefined]
|
|
16
|
+
**carrierName** | **string** | The name of the Authorized Message Provider (AMP) that handled this message. In the US, this is the carrier that the message was sent to. This field is present only when this account feature has been enabled. | [optional] [default to undefined]
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import { Callback } from 'bandwidth-sdk';
|
|
22
|
+
|
|
23
|
+
const instance: Callback = {
|
|
24
|
+
time,
|
|
25
|
+
eventTime,
|
|
26
|
+
type,
|
|
27
|
+
to,
|
|
28
|
+
description,
|
|
29
|
+
message,
|
|
30
|
+
errorCode,
|
|
31
|
+
carrierName,
|
|
32
|
+
};
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**links** | [**Array<Link>**](Link.md) | | [optional] [default to undefined]
|
|
9
|
-
**data** | [**
|
|
9
|
+
**data** | [**MultiChannelMessageResponseData**](MultiChannelMessageResponseData.md) | | [optional] [default to undefined]
|
|
10
10
|
**errors** | [**Array<ErrorObject>**](ErrorObject.md) | | [optional] [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
package/docs/ErrorObject.md
CHANGED
|
@@ -5,8 +5,9 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**
|
|
9
|
-
**
|
|
8
|
+
**type** | **string** | A concise summary of the error used for categorization. | [default to undefined]
|
|
9
|
+
**description** | **string** | A detailed explanation of the error. | [default to undefined]
|
|
10
|
+
**source** | [**ErrorSource**](ErrorSource.md) | | [default to undefined]
|
|
10
11
|
|
|
11
12
|
## Example
|
|
12
13
|
|
|
@@ -14,8 +15,9 @@ Name | Type | Description | Notes
|
|
|
14
15
|
import { ErrorObject } from 'bandwidth-sdk';
|
|
15
16
|
|
|
16
17
|
const instance: ErrorObject = {
|
|
17
|
-
|
|
18
|
-
|
|
18
|
+
type,
|
|
19
|
+
description,
|
|
20
|
+
source,
|
|
19
21
|
};
|
|
20
22
|
```
|
|
21
23
|
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# ErrorSource
|
|
2
|
+
|
|
3
|
+
Specifies relevant sources of the error, if any.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**parameter** | **string** | The relevant URI query parameter causing the error | [optional] [default to undefined]
|
|
10
|
+
**field** | **string** | The request body field that led to the error | [optional] [default to undefined]
|
|
11
|
+
**header** | **string** | The header field that contributed to the error | [optional] [default to undefined]
|
|
12
|
+
**reference** | **string** | A resource ID or path linked to the error | [optional] [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { ErrorSource } from 'bandwidth-sdk';
|
|
18
|
+
|
|
19
|
+
const instance: ErrorSource = {
|
|
20
|
+
parameter,
|
|
21
|
+
field,
|
|
22
|
+
header,
|
|
23
|
+
reference,
|
|
24
|
+
};
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/FailureWebhook.md
CHANGED
|
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**accountId** | **string** | User\'s account ID. | [optional] [default to undefined]
|
|
9
9
|
**phoneNumber** | **string** | Toll-free telephone number in E.164 format. | [optional] [default to undefined]
|
|
10
10
|
**errorCode** | **string** | An error code indicating what error was encountered. This code can be interpreted as an HTTP status code in regards to the error that was encountered. | [optional] [default to undefined]
|
|
11
|
-
**
|
|
11
|
+
**errorMessage** | **string** | A description of the error that was encountered. | [optional] [default to undefined]
|
|
12
12
|
**errors** | **Array<string>** | Details of the errors that were encountered when processing the request. | [optional] [default to undefined]
|
|
13
13
|
**internalTicketNumber** | **string** | Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number. | [optional] [default to undefined]
|
|
14
14
|
|
|
@@ -21,7 +21,7 @@ const instance: FailureWebhook = {
|
|
|
21
21
|
accountId,
|
|
22
22
|
phoneNumber,
|
|
23
23
|
errorCode,
|
|
24
|
-
|
|
24
|
+
errorMessage,
|
|
25
25
|
errors,
|
|
26
26
|
internalTicketNumber,
|
|
27
27
|
};
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# InboundCallback
|
|
2
|
+
|
|
3
|
+
Represents an inbound callback.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**time** | **string** | | [default to undefined]
|
|
10
|
+
**type** | [**InboundCallbackTypeEnum**](InboundCallbackTypeEnum.md) | | [default to undefined]
|
|
11
|
+
**to** | **string** | The destination phone number the message was sent to. For inbound callbacks, this is the Bandwidth number or alphanumeric identifier that received the message. | [default to undefined]
|
|
12
|
+
**description** | **string** | A detailed description of the event described by the callback. | [default to undefined]
|
|
13
|
+
**message** | [**InboundCallbackMessage**](InboundCallbackMessage.md) | | [default to undefined]
|
|
14
|
+
**carrierName** | **string** | The name of the Authorized Message Provider (AMP) that handled this message. In the US, this is the carrier that the message was sent to. This field is present only when this account feature has been enabled. | [optional] [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { InboundCallback } from 'bandwidth-sdk';
|
|
20
|
+
|
|
21
|
+
const instance: InboundCallback = {
|
|
22
|
+
time,
|
|
23
|
+
type,
|
|
24
|
+
to,
|
|
25
|
+
description,
|
|
26
|
+
message,
|
|
27
|
+
carrierName,
|
|
28
|
+
};
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# InboundCallbackMessage
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | A unique identifier of the message. | [default to undefined]
|
|
9
|
+
**owner** | **string** | The Bandwidth phone number or alphanumeric identifier associated with the message. | [default to undefined]
|
|
10
|
+
**applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard. | [default to undefined]
|
|
11
|
+
**time** | **string** | | [default to undefined]
|
|
12
|
+
**segmentCount** | **number** | The number of segments the user\'s message is broken into before sending over carrier networks. | [default to undefined]
|
|
13
|
+
**direction** | [**MessageDirectionEnum**](MessageDirectionEnum.md) | | [default to undefined]
|
|
14
|
+
**to** | **Set<string>** | The phone number recipients of the message. | [default to undefined]
|
|
15
|
+
**from** | **string** | The Bandwidth phone number or alphanumeric identifier the message was sent from. | [default to undefined]
|
|
16
|
+
**text** | **string** | | [optional] [default to undefined]
|
|
17
|
+
**tag** | **string** | A custom string that will be included in callback events of the message. Max 1024 characters. | [optional] [default to undefined]
|
|
18
|
+
**media** | **Array<string>** | Optional media, not applicable for sms | [optional] [default to undefined]
|
|
19
|
+
**priority** | [**PriorityEnum**](PriorityEnum.md) | | [optional] [default to undefined]
|
|
20
|
+
**channel** | [**MultiChannelMessageChannelEnum**](MultiChannelMessageChannelEnum.md) | | [optional] [default to undefined]
|
|
21
|
+
**content** | [**MultiChannelMessageContent**](MultiChannelMessageContent.md) | | [optional] [default to undefined]
|
|
22
|
+
**suggestionResponse** | [**RbmSuggestionResponse**](RbmSuggestionResponse.md) | | [optional] [default to undefined]
|
|
23
|
+
**locationResponse** | [**RbmLocationResponse**](RbmLocationResponse.md) | | [optional] [default to undefined]
|
|
24
|
+
|
|
25
|
+
## Example
|
|
26
|
+
|
|
27
|
+
```typescript
|
|
28
|
+
import { InboundCallbackMessage } from 'bandwidth-sdk';
|
|
29
|
+
|
|
30
|
+
const instance: InboundCallbackMessage = {
|
|
31
|
+
id,
|
|
32
|
+
owner,
|
|
33
|
+
applicationId,
|
|
34
|
+
time,
|
|
35
|
+
segmentCount,
|
|
36
|
+
direction,
|
|
37
|
+
to,
|
|
38
|
+
from,
|
|
39
|
+
text,
|
|
40
|
+
tag,
|
|
41
|
+
media,
|
|
42
|
+
priority,
|
|
43
|
+
channel,
|
|
44
|
+
content,
|
|
45
|
+
suggestionResponse,
|
|
46
|
+
locationResponse,
|
|
47
|
+
};
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# InboundCallbackTypeEnum
|
|
2
|
+
|
|
3
|
+
The possible inbound callback types originating from MO messages or multichannel message client responses: - `message-received` indicates an MO message from a Bandwidth user\'s client to a Bandwidth number. - `request-location-response` indicates a response to a location request sent by the Bandwidth user\'s client after receiving an RBM message. - `suggestion-response` indicates a response to a suggestion sent by the Bandwidth user\'s client after receiving an RBM message.
|
|
4
|
+
|
|
5
|
+
## Enum
|
|
6
|
+
|
|
7
|
+
* `MessageReceived` (value: `'message-received'`)
|
|
8
|
+
|
|
9
|
+
* `RequestLocationResponse` (value: `'request-location-response'`)
|
|
10
|
+
|
|
11
|
+
* `SuggestionResponse` (value: `'suggestion-response'`)
|
|
12
|
+
|
|
13
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/ListMessageItem.md
CHANGED
|
@@ -12,7 +12,7 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**messageStatus** | [**MessageStatusEnum**](MessageStatusEnum.md) | | [optional] [default to undefined]
|
|
13
13
|
**messageDirection** | [**ListMessageDirectionEnum**](ListMessageDirectionEnum.md) | | [optional] [default to undefined]
|
|
14
14
|
**messageType** | [**MessageTypeEnum**](MessageTypeEnum.md) | | [optional] [default to undefined]
|
|
15
|
-
**segmentCount** | **number** | The number of segments the message
|
|
15
|
+
**segmentCount** | **number** | The number of segments the user\'s message is broken into before sending over carrier networks. | [optional] [default to undefined]
|
|
16
16
|
**errorCode** | **number** | The numeric error code of the message. | [optional] [default to undefined]
|
|
17
17
|
**receiveTime** | **string** | The ISO 8601 datetime of the message. | [optional] [default to undefined]
|
|
18
18
|
**carrierName** | **string** | The name of the carrier. Not currently supported for MMS coming soon. | [optional] [default to undefined]
|
package/docs/Message.md
CHANGED
|
@@ -7,15 +7,15 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**id** | **string** | The id of the message. | [optional] [default to undefined]
|
|
9
9
|
**owner** | **string** | The Bandwidth phone number associated with the message. | [optional] [default to undefined]
|
|
10
|
-
**applicationId** | **string** | The
|
|
10
|
+
**applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard. | [optional] [default to undefined]
|
|
11
11
|
**time** | **string** | The datetime stamp of the message in ISO 8601 | [optional] [default to undefined]
|
|
12
|
-
**segmentCount** | **number** | The number of segments the
|
|
12
|
+
**segmentCount** | **number** | The number of segments the user\'s message is broken into before sending over carrier networks. | [optional] [default to undefined]
|
|
13
13
|
**direction** | [**MessageDirectionEnum**](MessageDirectionEnum.md) | | [optional] [default to undefined]
|
|
14
14
|
**to** | **Set<string>** | The phone number recipients of the message. | [optional] [default to undefined]
|
|
15
15
|
**from** | **string** | The phone number the message was sent from. | [optional] [default to undefined]
|
|
16
16
|
**media** | **Set<string>** | The list of media URLs sent in the message. Including a `filename` field in the `Content-Disposition` header of the media linked with a URL will set the displayed file name. This is a best practice to ensure that your media has a readable file name. | [optional] [default to undefined]
|
|
17
17
|
**text** | **string** | The contents of the message. | [optional] [default to undefined]
|
|
18
|
-
**tag** | **string** |
|
|
18
|
+
**tag** | **string** | A custom string that will be included in callback events of the message. Max 1024 characters. | [optional] [default to undefined]
|
|
19
19
|
**priority** | [**PriorityEnum**](PriorityEnum.md) | | [optional] [default to undefined]
|
|
20
20
|
**expiration** | **string** | A string with the date/time value that the message will automatically expire by. This must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. Must be a date-time in the future. | [optional] [default to undefined]
|
|
21
21
|
|
package/docs/MessageRequest.md
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**applicationId** | **string** | The ID of the Application your from number is associated with in the Bandwidth Phone Number Dashboard. | [default to undefined]
|
|
8
|
+
**applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard. | [default to undefined]
|
|
9
9
|
**to** | **Set<string>** | The phone number(s) the message should be sent to in E164 format. | [default to undefined]
|
|
10
10
|
**from** | **string** | Either an alphanumeric sender ID or the sender\'s Bandwidth phone number in E.164 format, which must be hosted within Bandwidth and linked to the account that is generating the message. Alphanumeric Sender IDs can contain up to 11 characters, upper-case letters A-Z, lower-case letters a-z, numbers 0-9, space, hyphen -, plus +, underscore _ and ampersand &. Alphanumeric Sender IDs must contain at least one letter. | [default to undefined]
|
|
11
11
|
**text** | **string** | The contents of the text message. Must be 2048 characters or less. | [optional] [default to undefined]
|
package/docs/MessagesApi.md
CHANGED
|
@@ -63,6 +63,7 @@ const { status, data } = await apiInstance.createMessage(
|
|
|
63
63
|
|**401** | Unauthorized | - |
|
|
64
64
|
|**403** | Forbidden | - |
|
|
65
65
|
|**404** | Not Found | - |
|
|
66
|
+
|**405** | Method Not Allowed | - |
|
|
66
67
|
|**406** | Not Acceptable | - |
|
|
67
68
|
|**415** | Unsupported Media Type | - |
|
|
68
69
|
|**429** | Too Many Requests | - |
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**text** | **string** | The contents of the text message. Must be 2048 characters or less. | [optional] [default to undefined]
|
|
9
|
-
**media** | **Array<
|
|
9
|
+
**media** | [**Array<MmsMessageContentFile>**](MmsMessageContentFile.md) | | [optional] [default to undefined]
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# MmsMessageContentFile
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**fileUrl** | **string** | The URL of a media attachment. For MMS, the API limits file size to 3.5MB. Specific carriers and channels may have a smaller limit that could cause a large file to fail, see [here](https://support.bandwidth.com/hc/en-us/articles/360014235473-What-are-the-MMS-file-size-limits) for more details. | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { MmsMessageContentFile } from 'bandwidth-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: MmsMessageContentFile = {
|
|
16
|
+
fileUrl,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -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
|
-
**
|
|
10
|
+
**postbackData** | **string** | Base64 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. | [default to undefined]
|
|
13
13
|
**longitude** | **number** | The longitude of the location. | [default to undefined]
|
|
@@ -26,7 +26,7 @@ import { MultiChannelAction } from 'bandwidth-sdk';
|
|
|
26
26
|
const instance: MultiChannelAction = {
|
|
27
27
|
type,
|
|
28
28
|
text,
|
|
29
|
-
|
|
29
|
+
postbackData,
|
|
30
30
|
phoneNumber,
|
|
31
31
|
latitude,
|
|
32
32
|
longitude,
|
|
@@ -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
|
-
**
|
|
10
|
+
**postbackData** | **string** | Base64 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. | [default to undefined]
|
|
13
13
|
**endTime** | **string** | The end time of the event. | [default to undefined]
|
|
@@ -21,7 +21,7 @@ import { MultiChannelActionCalendarEvent } from 'bandwidth-sdk';
|
|
|
21
21
|
const instance: MultiChannelActionCalendarEvent = {
|
|
22
22
|
type,
|
|
23
23
|
text,
|
|
24
|
-
|
|
24
|
+
postbackData,
|
|
25
25
|
title,
|
|
26
26
|
startTime,
|
|
27
27
|
endTime,
|
package/docs/MultiChannelApi.md
CHANGED
|
@@ -62,6 +62,7 @@ const { status, data } = await apiInstance.createMultiChannelMessage(
|
|
|
62
62
|
|**401** | Unauthorized | - |
|
|
63
63
|
|**403** | Forbidden | - |
|
|
64
64
|
|**404** | Not Found | - |
|
|
65
|
+
|**405** | Method Not Allowed | - |
|
|
65
66
|
|**406** | Not Acceptable | - |
|
|
66
67
|
|**415** | Unsupported Media Type | - |
|
|
67
68
|
|**429** | Too Many Requests | - |
|
|
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**text** | **string** | The contents of the text message. Must be 2048 characters or less. | [default to undefined]
|
|
10
10
|
**suggestions** | [**Array<MultiChannelAction>**](MultiChannelAction.md) | An array of suggested actions for the recipient. | [optional] [default to undefined]
|
|
11
|
-
**media** | **Array<
|
|
11
|
+
**media** | [**Array<MmsMessageContentFile>**](MmsMessageContentFile.md) | | [default to undefined]
|
|
12
12
|
**orientation** | [**StandaloneCardOrientationEnum**](StandaloneCardOrientationEnum.md) | | [default to undefined]
|
|
13
13
|
**thumbnailImageAlignment** | [**ThumbnailAlignmentEnum**](ThumbnailAlignmentEnum.md) | | [default to undefined]
|
|
14
14
|
**cardContent** | [**RbmCardContent**](RbmCardContent.md) | | [default to undefined]
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# MultiChannelError
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**links** | [**Array<Link>**](Link.md) | | [optional] [default to undefined]
|
|
9
|
+
**data** | **object** | | [optional] [default to undefined]
|
|
10
|
+
**errors** | [**Array<ErrorObject>**](ErrorObject.md) | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { MultiChannelError } from 'bandwidth-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: MultiChannelError = {
|
|
18
|
+
links,
|
|
19
|
+
data,
|
|
20
|
+
errors,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# MultiChannelMessageContent
|
|
2
|
+
|
|
3
|
+
The structure of the content field of a multichannel message.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**text** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**media** | [**RbmMessageContentFile**](RbmMessageContentFile.md) | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { MultiChannelMessageContent } from 'bandwidth-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: MultiChannelMessageContent = {
|
|
18
|
+
text,
|
|
19
|
+
media,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# MultiChannelMessageResponseData
|
|
2
|
+
|
|
3
|
+
The data returned in a multichannel message response.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**messageId** | **string** | The ID of the message. | [default to undefined]
|
|
10
|
+
**time** | **string** | The time the message was received by the Bandwidth API. | [default to undefined]
|
|
11
|
+
**direction** | [**MessageDirectionEnum**](MessageDirectionEnum.md) | | [default to undefined]
|
|
12
|
+
**to** | **Set<string>** | The destination phone number(s) of the message, in E164 format. | [default to undefined]
|
|
13
|
+
**channelList** | [**Array<MultiChannelMessageResponseDataChannelListInner>**](MultiChannelMessageResponseDataChannelListInner.md) | A list of message bodies. The messages will be attempted in the order they are listed. Once a message sends successfully, the others will be ignored. | [default to undefined]
|
|
14
|
+
**tag** | **string** | A custom string that will be included in callback events of the message. Max 1024 characters. | [optional] [default to undefined]
|
|
15
|
+
**priority** | [**PriorityEnum**](PriorityEnum.md) | | [optional] [default to undefined]
|
|
16
|
+
**expiration** | **string** | A string with the date/time value that the message will automatically expire by. This must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. Must be a date-time in the future. | [optional] [default to undefined]
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import { MultiChannelMessageResponseData } from 'bandwidth-sdk';
|
|
22
|
+
|
|
23
|
+
const instance: MultiChannelMessageResponseData = {
|
|
24
|
+
messageId,
|
|
25
|
+
time,
|
|
26
|
+
direction,
|
|
27
|
+
to,
|
|
28
|
+
channelList,
|
|
29
|
+
tag,
|
|
30
|
+
priority,
|
|
31
|
+
expiration,
|
|
32
|
+
};
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# MultiChannelMessageResponseDataChannelListInner
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**from** | **string** | The sender ID of the message. This could be an alphanumeric sender ID. | [default to undefined]
|
|
9
|
+
**applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard. | [default to undefined]
|
|
10
|
+
**channel** | [**MultiChannelMessageChannelEnum**](MultiChannelMessageChannelEnum.md) | | [default to undefined]
|
|
11
|
+
**content** | [**MultiChannelChannelListObjectContent**](MultiChannelChannelListObjectContent.md) | | [default to undefined]
|
|
12
|
+
**owner** | **string** | The Bandwidth senderId associated with the message. Identical to \'from\'. | [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { MultiChannelMessageResponseDataChannelListInner } from 'bandwidth-sdk';
|
|
18
|
+
|
|
19
|
+
const instance: MultiChannelMessageResponseDataChannelListInner = {
|
|
20
|
+
from,
|
|
21
|
+
applicationId,
|
|
22
|
+
channel,
|
|
23
|
+
content,
|
|
24
|
+
owner,
|
|
25
|
+
};
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/PriorityEnum.md
CHANGED
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
|
-
**
|
|
10
|
+
**postbackData** | **string** | Base64 payload the customer receives when the reply is clicked. | [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
@@ -17,7 +17,7 @@ import { RbmActionBase } from 'bandwidth-sdk';
|
|
|
17
17
|
const instance: RbmActionBase = {
|
|
18
18
|
type,
|
|
19
19
|
text,
|
|
20
|
-
|
|
20
|
+
postbackData,
|
|
21
21
|
};
|
|
22
22
|
```
|
|
23
23
|
|
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
|
-
**
|
|
10
|
+
**postbackData** | **string** | Base64 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
|
|
@@ -18,7 +18,7 @@ import { RbmActionDial } from 'bandwidth-sdk';
|
|
|
18
18
|
const instance: RbmActionDial = {
|
|
19
19
|
type,
|
|
20
20
|
text,
|
|
21
|
-
|
|
21
|
+
postbackData,
|
|
22
22
|
phoneNumber,
|
|
23
23
|
};
|
|
24
24
|
```
|
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
|
-
**
|
|
10
|
+
**postbackData** | **string** | Base64 payload the customer receives when the reply is clicked. | [default to undefined]
|
|
11
11
|
**url** | **string** | The URL to open in browser. | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
@@ -18,7 +18,7 @@ import { RbmActionOpenUrl } from 'bandwidth-sdk';
|
|
|
18
18
|
const instance: RbmActionOpenUrl = {
|
|
19
19
|
type,
|
|
20
20
|
text,
|
|
21
|
-
|
|
21
|
+
postbackData,
|
|
22
22
|
url,
|
|
23
23
|
};
|
|
24
24
|
```
|
|
@@ -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
|
-
**
|
|
10
|
+
**postbackData** | **string** | Base64 payload the customer receives when the reply is clicked. | [default to undefined]
|
|
11
11
|
**latitude** | **number** | The latitude of the location. | [default to undefined]
|
|
12
12
|
**longitude** | **number** | The longitude of the location. | [default to undefined]
|
|
13
13
|
**label** | **string** | The label of the location. | [optional] [default to undefined]
|
|
@@ -20,7 +20,7 @@ import { RbmActionViewLocation } from 'bandwidth-sdk';
|
|
|
20
20
|
const instance: RbmActionViewLocation = {
|
|
21
21
|
type,
|
|
22
22
|
text,
|
|
23
|
-
|
|
23
|
+
postbackData,
|
|
24
24
|
latitude,
|
|
25
25
|
longitude,
|
|
26
26
|
label,
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# RbmLocationResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**latitude** | **number** | The latitude of the client\'s location. | [optional] [default to undefined]
|
|
9
|
+
**longitude** | **number** | The longitude of the client\'s location. | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { RbmLocationResponse } from 'bandwidth-sdk';
|
|
15
|
+
|
|
16
|
+
const instance: RbmLocationResponse = {
|
|
17
|
+
latitude,
|
|
18
|
+
longitude,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# RbmSuggestionResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**text** | **string** | The text associated with the suggestion response. | [optional] [default to undefined]
|
|
9
|
+
**postbackData** | **string** | Base64 payload the customer receives when the reply is clicked. | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { RbmSuggestionResponse } from 'bandwidth-sdk';
|
|
15
|
+
|
|
16
|
+
const instance: RbmSuggestionResponse = {
|
|
17
|
+
text,
|
|
18
|
+
postbackData,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# StatusCallback
|
|
2
|
+
|
|
3
|
+
Represents a status callback for an outbound MT SMS or MMS or RBM message.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**time** | **string** | | [default to undefined]
|
|
10
|
+
**eventTime** | **string** | Represents the time at which the message was read, for `message-read` callbacks. | [optional] [default to undefined]
|
|
11
|
+
**type** | [**StatusCallbackTypeEnum**](StatusCallbackTypeEnum.md) | | [default to undefined]
|
|
12
|
+
**to** | **string** | The destination phone number the message was sent to. For status callbacks, this the the Bandwidth user\'s client phone number. | [default to undefined]
|
|
13
|
+
**description** | **string** | A detailed description of the event described by the callback. | [default to undefined]
|
|
14
|
+
**message** | [**StatusCallbackMessage**](StatusCallbackMessage.md) | | [default to undefined]
|
|
15
|
+
**errorCode** | **number** | Optional error code, applicable only when type is `message-failed`. | [optional] [default to undefined]
|
|
16
|
+
**carrierName** | **string** | The name of the Authorized Message Provider (AMP) that handled this message. In the US, this is the carrier that the message was sent to. This field is present only when this account feature has been enabled. | [optional] [default to undefined]
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import { StatusCallback } from 'bandwidth-sdk';
|
|
22
|
+
|
|
23
|
+
const instance: StatusCallback = {
|
|
24
|
+
time,
|
|
25
|
+
eventTime,
|
|
26
|
+
type,
|
|
27
|
+
to,
|
|
28
|
+
description,
|
|
29
|
+
message,
|
|
30
|
+
errorCode,
|
|
31
|
+
carrierName,
|
|
32
|
+
};
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|