You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/Callback.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,11 +9,11 @@ Name | Type | Description | Notes
9
9
**time** | **string** | | [default to undefined]
10
10
**eventTime** | **string** | Represents the time at which the message was read, for `message-read` callbacks. | [optional][default to undefined]
11
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]
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
13
**description** | **string** | A detailed description of the event described by the callback. | [default to undefined]
14
14
**message** | [**InboundCallbackMessage**](InboundCallbackMessage.md) | | [default to undefined]
15
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]
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]
Copy file name to clipboardExpand all lines: docs/CreateCall.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
8
8
**to** | **string** | The destination to call (must be an E.164 formatted number (e.g. `+15555551212`) or a SIP URI (e.g. `sip:user@server.example`)). | [default to undefined]
9
9
**from** | **string** | A Bandwidth phone number on your account the call should come from (must be in E.164 format, like `+15555551212`) even if `privacy` is set to true. | [default to undefined]
10
10
**privacy** | **boolean** | Hide the calling number. The `displayName` field can be used to customize the displayed name. | [optional][default to undefined]
11
-
**displayName** | **string** | The caller display name to use when the call is created. May not exceed 256 characters nor contain control characters such as new lines. If `privacy` is true, only the following values are valid: `Restricted`, `Anonymous`, `Private`, or `Unavailable`. | [optional][default to undefined]
11
+
**displayName** | **string** | The caller display name to use when the call is created. May not exceed 256 characters nor contain control characters such as new lines. If `privacy` is true, only the following values are valid: `Restricted`, `Anonymous`, `Private`, or `Unavailable`. | [optional][default to undefined]
12
12
**uui** | **string** | A comma-separated list of \'User-To-User\' headers to be sent in the INVITE when calling a SIP URI. Each value must end with an \'encoding\' parameter as described in <a href=\'https://tools.ietf.org/html/rfc7433\'>RFC 7433</a>. Only \'jwt\', \'base64\' and \'hex\' encodings are allowed. The entire value cannot exceed 350 characters, including parameters and separators. | [optional][default to undefined]
13
13
**applicationId** | **string** | The id of the application associated with the `from` number. | [default to undefined]
14
14
**answerUrl** | **string** | The full URL to send the <a href=\'/docs/voice/webhooks/answer\'>Answer</a> event to when the called party answers. This endpoint should return the first <a href=\'/docs/voice/bxml\'>BXML document</a> to be executed in the call. Must use `https` if specifying `username` and `password`. | [default to undefined]
**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]
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
12
**description** | **string** | A detailed description of the event described by the callback. | [default to undefined]
13
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]
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]
Copy file name to clipboardExpand all lines: docs/InboundCallbackTypeEnum.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# InboundCallbackTypeEnum
2
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.
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.
Copy file name to clipboardExpand all lines: docs/MachineDetectionConfiguration.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
11
11
**silenceTimeout** | **number** | If no speech is detected in this period, a callback with a \'silence\' result is sent. | [optional][default to 10]
12
12
**speechThreshold** | **number** | When speech has ended and a result couldn\'t be determined based on the audio content itself, this value is used to determine if the speaker is a machine based on the speech duration. If the length of the speech detected is greater than or equal to this threshold, the result will be \'answering-machine\'. If the length of speech detected is below this threshold, the result will be \'human\'. | [optional][default to 10]
13
13
**speechEndThreshold** | **number** | Amount of silence (in seconds) before assuming the callee has finished speaking. | [optional][default to 5]
14
-
**machineSpeechEndThreshold** | **number** | When an answering machine is detected, the amount of silence (in seconds) before assuming the message has finished playing. If not provided it will default to the speechEndThreshold value. | [optional][default to undefined]
14
+
**machineSpeechEndThreshold** | **number** | When an answering machine is detected, the amount of silence (in seconds) before assuming the message has finished playing. If not provided it will default to the speechEndThreshold value. | [optional][default to undefined]
15
15
**delayResult** | **boolean** | If set to \'true\' and if an answering machine is detected, the \'answering-machine\' callback will be delayed until the machine is done speaking, or an end of message tone is detected, or until the \'detectionTimeout\' is exceeded. If false, the \'answering-machine\' result is sent immediately. | [optional][default to false]
16
16
**callbackUrl** | **string** | The URL to send the \'machineDetectionComplete\' webhook when the detection is completed. Only for \'async\' mode. | [optional][default to undefined]
17
17
**callbackMethod** | [**CallbackMethodEnum**](CallbackMethodEnum.md) | | [optional][default to undefined]
**applicationId** | **string** | The ID of the Application your from number or senderId is associated with in the Bandwidth App. | [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
-
**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]
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]
12
12
**media** | **Array<string>** | A list of URLs to include as media attachments as part of the message. Each URL can be at most 4096 characters. | [optional][default to undefined]
13
13
**tag** | **string** | A custom string that will be included in callback events of the message. Max 1024 characters. | [optional][default to undefined]
Copy file name to clipboardExpand all lines: docs/RbmOpenUrlEnum.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# RbmOpenUrlEnum
2
2
3
-
Specifies how the URL should be opened on a mobile device. - `BROWSER` Opens the URL in the device\'s default browser. If application is not set or the device doesn’t support WebView, this option is used by default. - `WEBVIEW` Opens the URL in an in-app WebView.
3
+
Specifies how the URL should be opened on a mobile device. - `BROWSER` Opens the URL in the device\'s default browser. If application is not set or the device doesn\'t support WebView, this option is used by default. - `WEBVIEW` Opens the URL in an in-app WebView.
Copy file name to clipboardExpand all lines: docs/RbmWebViewEnum.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# RbmWebViewEnum
2
2
3
-
Defines the layout of the WebView on a mobile device. It must be defined when application is set to `WEBVIEW` - `FULL` WebView takes the full screen. - `HALF` WebView takes half of the screen. - `TALL` WebView takes three-quarters of the screen.
3
+
Defines the layout of the WebView on a mobile device. It must be defined when application is set to `WEBVIEW` - `FULL` WebView takes the full screen. - `HALF` WebView takes half of the screen. - `TALL` WebView takes three-quarters of the screen.
Copy file name to clipboardExpand all lines: docs/StatusCallback.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
13
13
**description** | **string** | A detailed description of the event described by the callback. | [default to undefined]
14
14
**message** | [**StatusCallbackMessage**](StatusCallbackMessage.md) | | [default to undefined]
15
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]
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]
0 commit comments