bandwidth-sdk 15.0.0 → 16.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.
- checksums.yaml +4 -4
- data/Gemfile.lock +16 -16
- data/README.md +18 -10
- data/bandwidth.yml +549 -194
- data/coverage/.last_run.json +1 -1
- data/coverage/.resultset.json +322 -366
- data/coverage/index.html +10088 -10530
- data/custom_templates/README.mustache +1 -1
- data/docs/BlockedWebhook.md +28 -0
- data/docs/Callback.md +84 -0
- data/docs/CreateMultiChannelMessageResponse.md +3 -3
- data/docs/ErrorObject.md +6 -4
- data/docs/ErrorSource.md +24 -0
- data/docs/FailureWebhook.md +2 -2
- data/docs/InboundCallback.md +28 -0
- data/docs/InboundCallbackMessage.md +48 -0
- data/docs/{MultiChannelStatusEnum.md → InboundCallbackTypeEnum.md} +2 -2
- data/docs/ListMessageItem.md +1 -1
- data/docs/Message.md +5 -5
- data/docs/MessageRequest.md +1 -1
- data/docs/MmsMessageContent.md +2 -2
- data/docs/MmsMessageContentFile.md +18 -0
- data/docs/MultiChannelActionCalendarEvent.md +2 -2
- data/docs/MultiChannelError.md +22 -0
- data/docs/MultiChannelMessageContent.md +20 -0
- data/docs/MultiChannelMessageResponseData.md +32 -0
- data/docs/MultiChannelMessageResponseDataChannelListInner.md +26 -0
- data/docs/RbmActionBase.md +2 -2
- data/docs/RbmActionDial.md +2 -2
- data/docs/RbmActionOpenUrl.md +2 -2
- data/docs/RbmActionViewLocation.md +2 -2
- data/docs/RbmLocationResponse.md +20 -0
- data/docs/RbmSuggestionResponse.md +20 -0
- data/docs/StatusCallback.md +32 -0
- data/docs/StatusCallbackMessage.md +42 -0
- data/docs/{CallbackTypeEnum.md → StatusCallbackTypeEnum.md} +2 -2
- data/docs/TfvStatus.md +2 -2
- data/docs/TfvSubmissionInfo.md +6 -6
- data/docs/TollFreeVerificationApi.md +72 -0
- data/docs/VerificationDenialWebhook.md +2 -2
- data/docs/VerificationRequest.md +6 -6
- data/docs/VerificationUpdateRequest.md +6 -6
- data/lib/bandwidth-sdk/api/toll_free_verification_api.rb +82 -0
- data/lib/bandwidth-sdk/configuration.rb +6 -0
- data/lib/bandwidth-sdk/models/blocked_webhook.rb +323 -0
- data/lib/bandwidth-sdk/models/callback.rb +60 -0
- data/lib/bandwidth-sdk/models/create_multi_channel_message_response.rb +1 -1
- data/lib/bandwidth-sdk/models/error_object.rb +45 -13
- data/lib/bandwidth-sdk/models/error_source.rb +244 -0
- data/lib/bandwidth-sdk/models/failure_webhook.rb +7 -7
- data/lib/bandwidth-sdk/models/{message_callback.rb → inbound_callback.rb} +9 -20
- data/lib/bandwidth-sdk/models/inbound_callback_message.rb +454 -0
- data/lib/bandwidth-sdk/models/{multi_channel_message_direction_enum.rb → inbound_callback_type_enum.rb} +7 -6
- data/lib/bandwidth-sdk/models/list_message_item.rb +1 -1
- data/lib/bandwidth-sdk/models/message.rb +3 -3
- data/lib/bandwidth-sdk/models/message_request.rb +1 -1
- data/lib/bandwidth-sdk/models/mms_message_content.rb +1 -2
- data/lib/bandwidth-sdk/models/{multi_channel_message_callback_data.rb → mms_message_content_file.rb} +37 -100
- data/lib/bandwidth-sdk/models/multi_channel_action_calendar_event.rb +21 -21
- data/lib/bandwidth-sdk/models/multi_channel_error.rb +235 -0
- data/lib/bandwidth-sdk/models/{deferred_result.rb → multi_channel_message_content.rb} +17 -16
- data/lib/bandwidth-sdk/models/multi_channel_message_response_data.rb +372 -0
- data/lib/bandwidth-sdk/models/{multi_channel_message_data.rb → multi_channel_message_response_data_channel_list_inner.rb} +62 -59
- data/lib/bandwidth-sdk/models/rbm_action_base.rb +21 -21
- data/lib/bandwidth-sdk/models/rbm_action_dial.rb +21 -21
- data/lib/bandwidth-sdk/models/rbm_action_open_url.rb +21 -21
- data/lib/bandwidth-sdk/models/rbm_action_view_location.rb +21 -21
- data/lib/bandwidth-sdk/models/{tag.rb → rbm_location_response.rb} +18 -16
- data/lib/bandwidth-sdk/models/{multi_channel_callback_data.rb → rbm_suggestion_response.rb} +37 -67
- data/lib/bandwidth-sdk/models/status_callback.rb +338 -0
- data/lib/bandwidth-sdk/models/{message_callback_message.rb → status_callback_message.rb} +25 -17
- data/lib/bandwidth-sdk/models/{callback_type_enum.rb → status_callback_type_enum.rb} +5 -5
- data/lib/bandwidth-sdk/models/tfv_status.rb +2 -2
- data/lib/bandwidth-sdk/models/tfv_submission_info.rb +4 -4
- data/lib/bandwidth-sdk/models/verification_denial_webhook.rb +2 -2
- data/lib/bandwidth-sdk/models/verification_request.rb +4 -4
- data/lib/bandwidth-sdk/models/verification_update_request.rb +4 -4
- data/lib/bandwidth-sdk/version.rb +1 -1
- data/lib/bandwidth-sdk.rb +16 -9
- data/spec/smoke/multi_channel_api_spec.rb +18 -20
- data/spec/smoke/toll_free_verification_api_spec.rb +7 -0
- data/spec/unit/api/toll_free_verification_api_spec.rb +8 -0
- data/spec/unit/client/api_client_spec.rb +4 -4
- data/spec/unit/models/tfv_error_spec.rb +78 -0
- data/spec/unit/models/verify_code_response_spec.rb +70 -0
- metadata +112 -98
- data/docs/DeferredResult.md +0 -20
- data/docs/MessageCallback.md +0 -30
- data/docs/MessageCallbackMessage.md +0 -40
- data/docs/MultiChannelCallbackData.md +0 -26
- data/docs/MultiChannelMessageCallbackData.md +0 -32
- data/docs/MultiChannelMessageData.md +0 -34
- data/docs/MultiChannelMessageDirectionEnum.md +0 -15
- data/docs/Tag.md +0 -20
- data/lib/bandwidth-sdk/models/multi_channel_status_enum.rb +0 -42
- data/spec/unit/models/deferred_result_spec.rb +0 -74
- /data/coverage/assets/{0.13.1 → 0.13.2}/DataTables-1.10.20/images/sort_asc.png +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/DataTables-1.10.20/images/sort_asc_disabled.png +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/DataTables-1.10.20/images/sort_both.png +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/DataTables-1.10.20/images/sort_desc.png +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/DataTables-1.10.20/images/sort_desc_disabled.png +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/application.css +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/application.js +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/colorbox/border.png +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/colorbox/controls.png +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/colorbox/loading.gif +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/colorbox/loading_background.png +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/favicon_green.png +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/favicon_red.png +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/favicon_yellow.png +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/images/ui-bg_flat_0_aaaaaa_40x100.png +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/images/ui-bg_flat_75_ffffff_40x100.png +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/images/ui-bg_glass_55_fbf9ee_1x400.png +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/images/ui-bg_glass_65_ffffff_1x400.png +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/images/ui-bg_glass_75_dadada_1x400.png +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/images/ui-bg_glass_75_e6e6e6_1x400.png +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/images/ui-bg_glass_95_fef1ec_1x400.png +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/images/ui-bg_highlight-soft_75_cccccc_1x100.png +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/images/ui-icons_222222_256x240.png +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/images/ui-icons_2e83ff_256x240.png +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/images/ui-icons_454545_256x240.png +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/images/ui-icons_888888_256x240.png +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/images/ui-icons_cd0a0a_256x240.png +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/loading.gif +0 -0
- /data/coverage/assets/{0.13.1 → 0.13.2}/magnify.png +0 -0
data/bandwidth.yml
CHANGED
@@ -223,6 +223,8 @@ paths:
|
|
223
223
|
$ref: '#/components/responses/messagingForbiddenError'
|
224
224
|
'404':
|
225
225
|
$ref: '#/components/responses/messagingNotFoundError'
|
226
|
+
'405':
|
227
|
+
$ref: '#/components/responses/messagingMethodNotAllowedError'
|
226
228
|
'406':
|
227
229
|
$ref: '#/components/responses/messagingNotAcceptableError'
|
228
230
|
'415':
|
@@ -250,24 +252,26 @@ paths:
|
|
250
252
|
'202':
|
251
253
|
$ref: '#/components/responses/createMultiChannelMessageResponse'
|
252
254
|
'400':
|
253
|
-
$ref: '#/components/responses/
|
255
|
+
$ref: '#/components/responses/multiChannelBadRequestError'
|
254
256
|
'401':
|
255
|
-
$ref: '#/components/responses/
|
257
|
+
$ref: '#/components/responses/multiChannelUnauthorizedError'
|
256
258
|
'403':
|
257
|
-
$ref: '#/components/responses/
|
259
|
+
$ref: '#/components/responses/multiChannelForbiddenError'
|
258
260
|
'404':
|
259
|
-
$ref: '#/components/responses/
|
261
|
+
$ref: '#/components/responses/multiChannelNotFoundError'
|
262
|
+
'405':
|
263
|
+
$ref: '#/components/responses/multiChannelMethodNotAllowedError'
|
260
264
|
'406':
|
261
|
-
$ref: '#/components/responses/
|
265
|
+
$ref: '#/components/responses/multiChannelNotAcceptableError'
|
262
266
|
'415':
|
263
|
-
$ref: '#/components/responses/
|
267
|
+
$ref: '#/components/responses/multiChannelInvalidMediaTypeError'
|
264
268
|
'429':
|
265
|
-
$ref: '#/components/responses/
|
269
|
+
$ref: '#/components/responses/multiChannelTooManyRequestsError'
|
266
270
|
'500':
|
267
|
-
$ref: '#/components/responses/
|
271
|
+
$ref: '#/components/responses/multiChannelInternalServerError'
|
268
272
|
callbacks:
|
269
|
-
|
270
|
-
$ref: '#/components/callbacks/
|
273
|
+
statusCallback:
|
274
|
+
$ref: '#/components/callbacks/statusCallback'
|
271
275
|
x-badges:
|
272
276
|
- name: Beta
|
273
277
|
color: '#076EA8'
|
@@ -1471,6 +1475,34 @@ paths:
|
|
1471
1475
|
callbacks:
|
1472
1476
|
tfVerificationStatus:
|
1473
1477
|
$ref: '#/components/callbacks/tfVerificationStatus'
|
1478
|
+
delete:
|
1479
|
+
description: Delete a toll-free verification submission for a toll-free number.
|
1480
|
+
operationId: deleteVerificationRequest
|
1481
|
+
parameters:
|
1482
|
+
- $ref: '#/components/parameters/accountId'
|
1483
|
+
- $ref: '#/components/parameters/tfPhoneNumberPathParam'
|
1484
|
+
responses:
|
1485
|
+
'204':
|
1486
|
+
$ref: '#/components/responses/noContentResponse'
|
1487
|
+
'400':
|
1488
|
+
$ref: '#/components/responses/tfvBadRequestResponse'
|
1489
|
+
'401':
|
1490
|
+
$ref: '#/components/responses/tfvUnauthorizedResponse'
|
1491
|
+
'403':
|
1492
|
+
$ref: '#/components/responses/tfvForbiddenResponse'
|
1493
|
+
'404':
|
1494
|
+
$ref: '#/components/responses/tfvNotFoundResponse'
|
1495
|
+
'405':
|
1496
|
+
$ref: '#/components/responses/tfvNotAllowedResponse'
|
1497
|
+
'429':
|
1498
|
+
$ref: '#/components/responses/tfvTooManyRequestsResponse'
|
1499
|
+
'500':
|
1500
|
+
$ref: '#/components/responses/tfvServerErrorResponse'
|
1501
|
+
'503':
|
1502
|
+
$ref: '#/components/responses/tfvServiceUnavailableResponse'
|
1503
|
+
summary: Delete a Toll-Free Verification Submission
|
1504
|
+
tags:
|
1505
|
+
- Toll-Free Verification
|
1474
1506
|
servers: *ref_4
|
1475
1507
|
/accounts/{accountId}/tollFreeVerification/webhooks/subscriptions:
|
1476
1508
|
get:
|
@@ -1554,7 +1586,7 @@ paths:
|
|
1554
1586
|
- $ref: '#/components/parameters/webhookSubscriptionIdPathParam'
|
1555
1587
|
responses:
|
1556
1588
|
'204':
|
1557
|
-
|
1589
|
+
$ref: '#/components/responses/noContentResponse'
|
1558
1590
|
'400':
|
1559
1591
|
$ref: '#/components/responses/tfvBadRequestResponse'
|
1560
1592
|
'401':
|
@@ -1639,24 +1671,12 @@ components:
|
|
1639
1671
|
The ID of the Application your from number or senderId is associated
|
1640
1672
|
with in the Bandwidth Phone Number Dashboard.
|
1641
1673
|
example: 93de2206-9669-4e07-948d-329f4b722ee2
|
1642
|
-
callbackTypeEnum:
|
1643
|
-
type: string
|
1644
|
-
enum:
|
1645
|
-
- message-received
|
1646
|
-
- message-sending
|
1647
|
-
- message-delivered
|
1648
|
-
- message-failed
|
1649
|
-
description: >
|
1650
|
-
Indicates the type of the callback:
|
1651
|
-
|
1652
|
-
- `message-received` for inbound callbacks.
|
1653
|
-
|
1654
|
-
- One of `message-sending`, `message-delivered`, `message-failed` for
|
1655
|
-
status callbacks.
|
1656
|
-
example: message-delivered
|
1657
1674
|
priorityEnum:
|
1658
1675
|
type: string
|
1659
|
-
description:
|
1676
|
+
description: >-
|
1677
|
+
Specifies the message's sending priority with respect to other messages
|
1678
|
+
in your account. For best results and optimal throughput, reserve the
|
1679
|
+
'high' priority setting for critical messages only.
|
1660
1680
|
enum:
|
1661
1681
|
- default
|
1662
1682
|
- high
|
@@ -1753,9 +1773,7 @@ components:
|
|
1753
1773
|
messageType:
|
1754
1774
|
$ref: '#/components/schemas/messageTypeEnum'
|
1755
1775
|
segmentCount:
|
1756
|
-
|
1757
|
-
description: The number of segments the message was sent as.
|
1758
|
-
example: 1
|
1776
|
+
$ref: '#/components/schemas/segmentCount'
|
1759
1777
|
errorCode:
|
1760
1778
|
type: integer
|
1761
1779
|
description: The numeric error code of the message.
|
@@ -1863,6 +1881,12 @@ components:
|
|
1863
1881
|
type: integer
|
1864
1882
|
mediaName:
|
1865
1883
|
type: string
|
1884
|
+
segmentCount:
|
1885
|
+
type: integer
|
1886
|
+
description: >-
|
1887
|
+
The number of segments the user's message is broken into before sending
|
1888
|
+
over carrier networks.
|
1889
|
+
example: 1
|
1866
1890
|
tag:
|
1867
1891
|
title: Tag
|
1868
1892
|
type: string
|
@@ -1870,14 +1894,6 @@ components:
|
|
1870
1894
|
A custom string that will be included in callback events of the message.
|
1871
1895
|
Max 1024 characters.
|
1872
1896
|
example: custom string
|
1873
|
-
deferredResult:
|
1874
|
-
title: DeferredResult
|
1875
|
-
type: object
|
1876
|
-
properties:
|
1877
|
-
result:
|
1878
|
-
type: object
|
1879
|
-
setOrExpired:
|
1880
|
-
type: boolean
|
1881
1897
|
expiration:
|
1882
1898
|
type: string
|
1883
1899
|
format: date-time
|
@@ -1887,6 +1903,16 @@ components:
|
|
1887
1903
|
2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. Must be a date-time
|
1888
1904
|
in the future.
|
1889
1905
|
example: '2021-02-01T11:29:18-05:00'
|
1906
|
+
carrierName:
|
1907
|
+
type: string
|
1908
|
+
description: >-
|
1909
|
+
The name of the Authorized Message Provider (AMP) that handled this
|
1910
|
+
message.
|
1911
|
+
|
1912
|
+
In the US, this is the carrier that the message was sent to.
|
1913
|
+
|
1914
|
+
This field is present only when this account feature has been enabled.
|
1915
|
+
example: AT&T
|
1890
1916
|
message:
|
1891
1917
|
title: Message
|
1892
1918
|
type: object
|
@@ -1900,20 +1926,14 @@ components:
|
|
1900
1926
|
description: The Bandwidth phone number associated with the message.
|
1901
1927
|
example: '+15554443333'
|
1902
1928
|
applicationId:
|
1903
|
-
|
1904
|
-
description: The application ID associated with the message.
|
1905
|
-
example: 93de2206-9669-4e07-948d-329f4b722ee2
|
1929
|
+
$ref: '#/components/schemas/applicationId'
|
1906
1930
|
time:
|
1907
1931
|
type: string
|
1908
1932
|
format: date-time
|
1909
1933
|
description: The datetime stamp of the message in ISO 8601
|
1910
1934
|
example: 2024-12-02T20:15:57.278Z
|
1911
1935
|
segmentCount:
|
1912
|
-
|
1913
|
-
description: >-
|
1914
|
-
The number of segments the original message from the user is broken
|
1915
|
-
into before sending over to carrier networks.
|
1916
|
-
example: 2
|
1936
|
+
$ref: '#/components/schemas/segmentCount'
|
1917
1937
|
direction:
|
1918
1938
|
$ref: '#/components/schemas/messageDirectionEnum'
|
1919
1939
|
to:
|
@@ -1945,9 +1965,7 @@ components:
|
|
1945
1965
|
description: The contents of the message.
|
1946
1966
|
example: Hello world
|
1947
1967
|
tag:
|
1948
|
-
|
1949
|
-
description: The custom string set by the user.
|
1950
|
-
example: custom tag
|
1968
|
+
$ref: '#/components/schemas/tag'
|
1951
1969
|
priority:
|
1952
1970
|
$ref: '#/components/schemas/priorityEnum'
|
1953
1971
|
expiration:
|
@@ -1961,11 +1979,7 @@ components:
|
|
1961
1979
|
- from
|
1962
1980
|
properties:
|
1963
1981
|
applicationId:
|
1964
|
-
|
1965
|
-
description: >-
|
1966
|
-
The ID of the Application your from number is associated with in the
|
1967
|
-
Bandwidth Phone Number Dashboard.
|
1968
|
-
example: 93de2206-9669-4e07-948d-329f4b722ee2
|
1982
|
+
$ref: '#/components/schemas/applicationId'
|
1969
1983
|
to:
|
1970
1984
|
uniqueItems: true
|
1971
1985
|
type: array
|
@@ -2021,12 +2035,69 @@ components:
|
|
2021
2035
|
type: array
|
2022
2036
|
items:
|
2023
2037
|
$ref: '#/components/schemas/link'
|
2038
|
+
example: []
|
2024
2039
|
data:
|
2025
|
-
$ref: '#/components/schemas/
|
2040
|
+
$ref: '#/components/schemas/multiChannelMessageResponseData'
|
2026
2041
|
errors:
|
2027
2042
|
type: array
|
2028
2043
|
items:
|
2029
2044
|
$ref: '#/components/schemas/errorObject'
|
2045
|
+
example: []
|
2046
|
+
multiChannelError:
|
2047
|
+
type: object
|
2048
|
+
properties:
|
2049
|
+
links:
|
2050
|
+
type: array
|
2051
|
+
items:
|
2052
|
+
$ref: '#/components/schemas/link'
|
2053
|
+
example: []
|
2054
|
+
data:
|
2055
|
+
type: object
|
2056
|
+
nullable: true
|
2057
|
+
example: null
|
2058
|
+
errors:
|
2059
|
+
type: array
|
2060
|
+
items:
|
2061
|
+
$ref: '#/components/schemas/errorObject'
|
2062
|
+
link:
|
2063
|
+
type: object
|
2064
|
+
properties:
|
2065
|
+
rel:
|
2066
|
+
type: string
|
2067
|
+
href:
|
2068
|
+
type: string
|
2069
|
+
errorObject:
|
2070
|
+
type: object
|
2071
|
+
properties:
|
2072
|
+
type:
|
2073
|
+
description: A concise summary of the error used for categorization.
|
2074
|
+
type: string
|
2075
|
+
description:
|
2076
|
+
description: A detailed explanation of the error.
|
2077
|
+
type: string
|
2078
|
+
source:
|
2079
|
+
$ref: '#/components/schemas/errorSource'
|
2080
|
+
required:
|
2081
|
+
- type
|
2082
|
+
- description
|
2083
|
+
- source
|
2084
|
+
errorSource:
|
2085
|
+
title: Error Source
|
2086
|
+
type: object
|
2087
|
+
description: Specifies relevant sources of the error, if any.
|
2088
|
+
properties:
|
2089
|
+
parameter:
|
2090
|
+
type: string
|
2091
|
+
description: The relevant URI query parameter causing the error
|
2092
|
+
field:
|
2093
|
+
type: string
|
2094
|
+
description: The request body field that led to the error
|
2095
|
+
header:
|
2096
|
+
type: string
|
2097
|
+
description: The header field that contributed to the error
|
2098
|
+
reference:
|
2099
|
+
type: string
|
2100
|
+
description: A resource ID or path linked to the error
|
2030
2101
|
multiChannelMessageChannelEnum:
|
2031
2102
|
description: The channel of the multi-channel message.
|
2032
2103
|
type: string
|
@@ -2035,12 +2106,6 @@ components:
|
|
2035
2106
|
- SMS
|
2036
2107
|
- MMS
|
2037
2108
|
example: RBM
|
2038
|
-
multiChannelMessageDirectionEnum:
|
2039
|
-
type: string
|
2040
|
-
enum:
|
2041
|
-
- INBOUND
|
2042
|
-
- OUTBOUND
|
2043
|
-
example: OUTBOUND
|
2044
2109
|
multiChannelSenderId:
|
2045
2110
|
type: string
|
2046
2111
|
description: The sender ID of the message. This could be an alphanumeric sender ID.
|
@@ -2049,6 +2114,14 @@ components:
|
|
2049
2114
|
type: string
|
2050
2115
|
description: The phone number the message should be sent to in E164 format.
|
2051
2116
|
example: '+15552223333'
|
2117
|
+
multiChannelDestinations:
|
2118
|
+
uniqueItems: true
|
2119
|
+
type: array
|
2120
|
+
description: The destination phone number(s) of the message, in E164 format.
|
2121
|
+
example:
|
2122
|
+
- '+15554443333'
|
2123
|
+
items:
|
2124
|
+
type: string
|
2052
2125
|
rbmMessageContentText:
|
2053
2126
|
title: RBM Text
|
2054
2127
|
type: object
|
@@ -2090,6 +2163,26 @@ components:
|
|
2090
2163
|
maxLength: 1000
|
2091
2164
|
required:
|
2092
2165
|
- fileUrl
|
2166
|
+
mmsMessageContentFile:
|
2167
|
+
title: MMS Media File
|
2168
|
+
type: object
|
2169
|
+
properties:
|
2170
|
+
fileUrl:
|
2171
|
+
type: string
|
2172
|
+
format: uri
|
2173
|
+
description: >-
|
2174
|
+
The URL of a media attachment.
|
2175
|
+
|
2176
|
+
|
2177
|
+
For MMS, the API limits file size to 3.5MB. Specific carriers and
|
2178
|
+
channels may have a smaller limit that could cause a large file to
|
2179
|
+
fail, see
|
2180
|
+
[here](https://support.bandwidth.com/hc/en-us/articles/360014235473-What-are-the-MMS-file-size-limits)
|
2181
|
+
for more details.
|
2182
|
+
example: https://dev.bandwidth.com/images/bandwidth-logo.png
|
2183
|
+
maxLength: 1000
|
2184
|
+
required:
|
2185
|
+
- fileUrl
|
2093
2186
|
rbmMessageMedia:
|
2094
2187
|
title: RBM Media
|
2095
2188
|
type: object
|
@@ -2198,7 +2291,9 @@ components:
|
|
2198
2291
|
text:
|
2199
2292
|
$ref: '#/components/schemas/messageText'
|
2200
2293
|
media:
|
2201
|
-
|
2294
|
+
type: array
|
2295
|
+
items:
|
2296
|
+
$ref: '#/components/schemas/mmsMessageContentFile'
|
2202
2297
|
rbmMessageContentRichCard:
|
2203
2298
|
title: RBM Rich Card
|
2204
2299
|
oneOf:
|
@@ -2220,7 +2315,7 @@ components:
|
|
2220
2315
|
description: Displayed text for user to click
|
2221
2316
|
maxLength: 25
|
2222
2317
|
example: Hello world
|
2223
|
-
|
2318
|
+
rbmActionPostbackData:
|
2224
2319
|
title: Post Back Data
|
2225
2320
|
type: string
|
2226
2321
|
format: byte
|
@@ -2234,11 +2329,11 @@ components:
|
|
2234
2329
|
$ref: '#/components/schemas/rbmActionTypeEnum'
|
2235
2330
|
text:
|
2236
2331
|
$ref: '#/components/schemas/rbmActionText'
|
2237
|
-
|
2238
|
-
$ref: '#/components/schemas/
|
2332
|
+
postbackData:
|
2333
|
+
$ref: '#/components/schemas/rbmActionPostbackData'
|
2239
2334
|
required:
|
2240
2335
|
- text
|
2241
|
-
-
|
2336
|
+
- postbackData
|
2242
2337
|
- type
|
2243
2338
|
rbmActionDial:
|
2244
2339
|
allOf:
|
@@ -2342,14 +2437,6 @@ components:
|
|
2342
2437
|
CREATE_CALENDAR_EVENT: '#/components/schemas/multiChannelActionCalendarEvent'
|
2343
2438
|
OPEN_URL: '#/components/schemas/rbmActionOpenUrl'
|
2344
2439
|
REQUEST_LOCATION: '#/components/schemas/rbmActionBase'
|
2345
|
-
multiChannelStatusEnum:
|
2346
|
-
type: string
|
2347
|
-
enum:
|
2348
|
-
- QUEUED
|
2349
|
-
- SENDING
|
2350
|
-
- DELIVERED
|
2351
|
-
- FAILED
|
2352
|
-
example: DELIVERED
|
2353
2440
|
multiChannelChannelListObject:
|
2354
2441
|
type: object
|
2355
2442
|
properties:
|
@@ -2396,141 +2483,250 @@ components:
|
|
2396
2483
|
required:
|
2397
2484
|
- to
|
2398
2485
|
- channelList
|
2399
|
-
|
2486
|
+
multiChannelMessageResponseData:
|
2487
|
+
description: The data returned in a multichannel message response.
|
2400
2488
|
type: object
|
2401
2489
|
properties:
|
2402
2490
|
messageId:
|
2403
2491
|
$ref: '#/components/schemas/messageId'
|
2404
|
-
status:
|
2405
|
-
$ref: '#/components/schemas/multiChannelStatusEnum'
|
2406
|
-
direction:
|
2407
|
-
$ref: '#/components/schemas/multiChannelMessageDirectionEnum'
|
2408
|
-
from:
|
2409
|
-
$ref: '#/components/schemas/multiChannelSenderId'
|
2410
|
-
to:
|
2411
|
-
$ref: '#/components/schemas/multiChannelDestination'
|
2412
|
-
applicationId:
|
2413
|
-
$ref: '#/components/schemas/applicationId'
|
2414
|
-
channel:
|
2415
|
-
$ref: '#/components/schemas/multiChannelMessageChannelEnum'
|
2416
|
-
tag:
|
2417
|
-
$ref: '#/components/schemas/tag'
|
2418
|
-
multiChannelMessageData:
|
2419
|
-
type: object
|
2420
|
-
properties:
|
2421
|
-
messageId:
|
2422
|
-
$ref: '#/components/schemas/messageId'
|
2423
|
-
status:
|
2424
|
-
$ref: '#/components/schemas/multiChannelStatusEnum'
|
2425
2492
|
time:
|
2426
2493
|
description: The time the message was received by the Bandwidth API.
|
2427
2494
|
type: string
|
2428
2495
|
format: date-time
|
2429
2496
|
example: 2025-01-01T18:20:16.000Z
|
2430
2497
|
direction:
|
2431
|
-
$ref: '#/components/schemas/
|
2432
|
-
from:
|
2433
|
-
$ref: '#/components/schemas/multiChannelSenderId'
|
2498
|
+
$ref: '#/components/schemas/messageDirectionEnum'
|
2434
2499
|
to:
|
2435
|
-
$ref: '#/components/schemas/
|
2436
|
-
|
2437
|
-
|
2438
|
-
|
2439
|
-
|
2500
|
+
$ref: '#/components/schemas/multiChannelDestinations'
|
2501
|
+
channelList:
|
2502
|
+
type: array
|
2503
|
+
description: >-
|
2504
|
+
A list of message bodies. The messages will be attempted in the
|
2505
|
+
order they are listed. Once a message sends successfully, the others
|
2506
|
+
will be ignored.
|
2507
|
+
items:
|
2508
|
+
allOf:
|
2509
|
+
- $ref: '#/components/schemas/multiChannelChannelListObject'
|
2510
|
+
- type: object
|
2511
|
+
properties:
|
2512
|
+
owner:
|
2513
|
+
type: string
|
2514
|
+
description: >-
|
2515
|
+
The Bandwidth senderId associated with the message.
|
2516
|
+
Identical to 'from'.
|
2517
|
+
required:
|
2518
|
+
- owner
|
2519
|
+
maxItems: 4
|
2440
2520
|
tag:
|
2441
2521
|
$ref: '#/components/schemas/tag'
|
2442
|
-
|
2522
|
+
priority:
|
2523
|
+
$ref: '#/components/schemas/priorityEnum'
|
2524
|
+
expiration:
|
2525
|
+
$ref: '#/components/schemas/expiration'
|
2526
|
+
required:
|
2527
|
+
- messageId
|
2528
|
+
- time
|
2529
|
+
- direction
|
2530
|
+
- to
|
2531
|
+
- channelList
|
2532
|
+
multiChannelMessageContent:
|
2533
|
+
description: The structure of the content field of a multichannel message.
|
2443
2534
|
type: object
|
2444
2535
|
properties:
|
2445
|
-
|
2446
|
-
description: The time of the callback event.
|
2447
|
-
type: string
|
2448
|
-
format: date-time
|
2449
|
-
example: 2025-01-01T18:20:16.000Z
|
2450
|
-
type:
|
2451
|
-
$ref: '#/components/schemas/multiChannelStatusEnum'
|
2452
|
-
to:
|
2453
|
-
$ref: '#/components/schemas/multiChannelDestination'
|
2454
|
-
description:
|
2536
|
+
text:
|
2455
2537
|
type: string
|
2456
|
-
|
2457
|
-
|
2458
|
-
|
2459
|
-
link:
|
2538
|
+
media:
|
2539
|
+
$ref: '#/components/schemas/rbmMessageContentFile'
|
2540
|
+
rbmSuggestionResponse:
|
2460
2541
|
type: object
|
2461
2542
|
properties:
|
2462
|
-
|
2463
|
-
type: string
|
2464
|
-
href:
|
2543
|
+
text:
|
2465
2544
|
type: string
|
2466
|
-
|
2545
|
+
description: The text associated with the suggestion response.
|
2546
|
+
example: Yes, I would like to proceed
|
2547
|
+
postbackData:
|
2548
|
+
$ref: '#/components/schemas/rbmActionPostbackData'
|
2549
|
+
rbmLocationResponse:
|
2467
2550
|
type: object
|
2468
2551
|
properties:
|
2469
|
-
|
2552
|
+
latitude:
|
2470
2553
|
type: string
|
2471
|
-
|
2554
|
+
format: double
|
2555
|
+
description: The latitude of the client's location.
|
2556
|
+
example: '37.7749'
|
2557
|
+
longitude:
|
2472
2558
|
type: string
|
2473
|
-
|
2474
|
-
|
2559
|
+
format: double
|
2560
|
+
description: The longitude of the client's location.
|
2561
|
+
example: '-122.4194'
|
2562
|
+
callback:
|
2563
|
+
description: >-
|
2564
|
+
Callbacks are divided into two types based on direction of the related
|
2565
|
+
message:
|
2566
|
+
|
2567
|
+
- `statusCallback` indicates status of an outbound MT SMS, MMS, or RBM
|
2568
|
+
message.
|
2569
|
+
|
2570
|
+
- `inboundCallback` indicates an inbound MO message or a multichannel
|
2571
|
+
message client's response to a suggestion or location request.
|
2475
2572
|
type: object
|
2573
|
+
oneOf:
|
2574
|
+
- $ref: '#/components/schemas/statusCallback'
|
2575
|
+
- $ref: '#/components/schemas/inboundCallback'
|
2576
|
+
discriminator:
|
2577
|
+
propertyName: type
|
2578
|
+
mapping:
|
2579
|
+
message-sent: '#/components/schemas/statusCallback'
|
2580
|
+
message-delivered: '#/components/schemas/statusCallback'
|
2581
|
+
message-failed: '#/components/schemas/statusCallback'
|
2582
|
+
message-read: '#/components/schemas/statusCallback'
|
2583
|
+
message-received: '#/components/schemas/inboundCallback'
|
2584
|
+
request-location-response: '#/components/schemas/inboundCallback'
|
2585
|
+
suggestion-response: '#/components/schemas/inboundCallback'
|
2586
|
+
statusCallback:
|
2587
|
+
type: object
|
2588
|
+
description: >-
|
2589
|
+
Represents a status callback for an outbound MT SMS or MMS or RBM
|
2590
|
+
message.
|
2476
2591
|
properties:
|
2477
2592
|
time:
|
2478
2593
|
type: string
|
2479
2594
|
format: date-time
|
2480
2595
|
example: 2024-12-02T20:15:57.278Z
|
2596
|
+
eventTime:
|
2597
|
+
type: string
|
2598
|
+
description: >-
|
2599
|
+
Represents the time at which the message was read, for
|
2600
|
+
`message-read` callbacks.
|
2601
|
+
format: date-time
|
2602
|
+
example: 2024-12-02T20:15:58.278Z
|
2481
2603
|
type:
|
2482
|
-
$ref: '#/components/schemas/
|
2604
|
+
$ref: '#/components/schemas/statusCallbackTypeEnum'
|
2483
2605
|
to:
|
2484
2606
|
type: string
|
2607
|
+
description: >-
|
2608
|
+
The destination phone number the message was sent to.
|
2609
|
+
|
2610
|
+
For status callbacks, this the the Bandwidth user's client phone
|
2611
|
+
number.
|
2485
2612
|
example: '+15552223333'
|
2486
2613
|
description:
|
2487
2614
|
type: string
|
2488
2615
|
description: A detailed description of the event described by the callback.
|
2489
|
-
example:
|
2616
|
+
example: Message delivered to carrier.
|
2490
2617
|
message:
|
2491
|
-
$ref: '#/components/schemas/
|
2618
|
+
$ref: '#/components/schemas/statusCallbackMessage'
|
2492
2619
|
errorCode:
|
2493
2620
|
type: integer
|
2494
2621
|
description: Optional error code, applicable only when type is `message-failed`.
|
2495
|
-
nullable: true
|
2496
2622
|
example: 4405
|
2497
2623
|
carrierName:
|
2624
|
+
$ref: '#/components/schemas/carrierName'
|
2625
|
+
required:
|
2626
|
+
- time
|
2627
|
+
- type
|
2628
|
+
- to
|
2629
|
+
- description
|
2630
|
+
- message
|
2631
|
+
inboundCallback:
|
2632
|
+
type: object
|
2633
|
+
description: Represents an inbound callback.
|
2634
|
+
properties:
|
2635
|
+
time:
|
2498
2636
|
type: string
|
2499
|
-
|
2500
|
-
|
2501
|
-
|
2502
|
-
|
2503
|
-
|
2504
|
-
|
2637
|
+
format: date-time
|
2638
|
+
example: 2024-12-02T20:15:57.278Z
|
2639
|
+
type:
|
2640
|
+
$ref: '#/components/schemas/inboundCallbackTypeEnum'
|
2641
|
+
to:
|
2642
|
+
type: string
|
2643
|
+
description: >
|
2644
|
+
The destination phone number the message was sent to.
|
2645
|
+
|
2646
|
+
For inbound callbacks, this is the Bandwidth number or alphanumeric
|
2647
|
+
identifier that received the message.
|
2648
|
+
example: '+15552223333'
|
2649
|
+
description:
|
2650
|
+
type: string
|
2651
|
+
description: A detailed description of the event described by the callback.
|
2652
|
+
example: Incoming message received
|
2653
|
+
message:
|
2654
|
+
$ref: '#/components/schemas/inboundCallbackMessage'
|
2655
|
+
carrierName:
|
2656
|
+
$ref: '#/components/schemas/carrierName'
|
2505
2657
|
required:
|
2506
2658
|
- time
|
2507
2659
|
- type
|
2508
2660
|
- to
|
2509
2661
|
- description
|
2510
2662
|
- message
|
2511
|
-
|
2512
|
-
|
2663
|
+
statusCallbackTypeEnum:
|
2664
|
+
type: string
|
2665
|
+
description: >-
|
2666
|
+
The possible status callbacks when sending an MT SMS or MMS or RBM
|
2667
|
+
message:
|
2668
|
+
|
2669
|
+
- `message-sending` indicates that Bandwidth is sending the message to
|
2670
|
+
the upstream provider.
|
2671
|
+
|
2672
|
+
- `message-delivered` indicates that the message was successfully sent.
|
2673
|
+
|
2674
|
+
- `message-failed` indicates that the message could not be sent to the
|
2675
|
+
intended recipient.
|
2676
|
+
|
2677
|
+
- `message-read` indicates that the RBM message was read by the
|
2678
|
+
recipient.
|
2679
|
+
enum:
|
2680
|
+
- message-sending
|
2681
|
+
- message-delivered
|
2682
|
+
- message-failed
|
2683
|
+
- message-read
|
2684
|
+
example: message-delivered
|
2685
|
+
inboundCallbackTypeEnum:
|
2686
|
+
type: string
|
2687
|
+
description: >-
|
2688
|
+
The possible inbound callback types originating from MO messages or
|
2689
|
+
multichannel message client responses:
|
2690
|
+
|
2691
|
+
- `message-received` indicates an MO message from a Bandwidth user's
|
2692
|
+
client to a Bandwidth number.
|
2693
|
+
|
2694
|
+
- `request-location-response` indicates a response to a location request
|
2695
|
+
sent by the Bandwidth user's client after receiving an RBM message.
|
2696
|
+
|
2697
|
+
- `suggestion-response` indicates a response to a suggestion sent by the
|
2698
|
+
Bandwidth user's client after receiving an RBM message.
|
2699
|
+
enum:
|
2700
|
+
- message-received
|
2701
|
+
- request-location-response
|
2702
|
+
- suggestion-response
|
2703
|
+
example: message-received
|
2704
|
+
statusCallbackMessage:
|
2705
|
+
description: Message payload schema within a callback
|
2513
2706
|
type: object
|
2514
2707
|
properties:
|
2515
2708
|
id:
|
2516
2709
|
type: string
|
2710
|
+
description: A unique identifier of the message.
|
2517
2711
|
example: 1661365814859loidf7mcwd4qacn7
|
2518
2712
|
owner:
|
2519
2713
|
type: string
|
2714
|
+
description: >-
|
2715
|
+
The Bandwidth phone number or alphanumeric identifier associated
|
2716
|
+
with the message.
|
2520
2717
|
example: '+15553332222'
|
2521
2718
|
applicationId:
|
2522
|
-
|
2523
|
-
example: 93de2206-9669-4e07-948d-329f4b722ee2
|
2719
|
+
$ref: '#/components/schemas/applicationId'
|
2524
2720
|
time:
|
2525
2721
|
type: string
|
2526
2722
|
format: date-time
|
2527
2723
|
example: 2024-12-02T20:15:57.666Z
|
2528
2724
|
segmentCount:
|
2529
|
-
|
2530
|
-
example: 1
|
2725
|
+
$ref: '#/components/schemas/segmentCount'
|
2531
2726
|
direction:
|
2532
2727
|
$ref: '#/components/schemas/messageDirectionEnum'
|
2533
2728
|
to:
|
2729
|
+
description: The phone number recipients of the message.
|
2534
2730
|
uniqueItems: true
|
2535
2731
|
type: array
|
2536
2732
|
items:
|
@@ -2539,17 +2735,18 @@ components:
|
|
2539
2735
|
- '+15552223333'
|
2540
2736
|
from:
|
2541
2737
|
type: string
|
2738
|
+
description: >-
|
2739
|
+
The Bandwidth phone number or alphanumeric identifier the message
|
2740
|
+
was sent from.
|
2542
2741
|
example: '+15553332222'
|
2543
2742
|
text:
|
2544
2743
|
type: string
|
2545
2744
|
example: Hello world
|
2546
2745
|
tag:
|
2547
|
-
|
2548
|
-
example: custom string
|
2746
|
+
$ref: '#/components/schemas/tag'
|
2549
2747
|
media:
|
2550
2748
|
type: array
|
2551
|
-
description: Optional media, applicable
|
2552
|
-
nullable: true
|
2749
|
+
description: Optional media, not applicable for sms
|
2553
2750
|
items:
|
2554
2751
|
type: string
|
2555
2752
|
format: uri
|
@@ -2558,6 +2755,28 @@ components:
|
|
2558
2755
|
- https://dev.bandwidth.com/images/github_logo.png
|
2559
2756
|
priority:
|
2560
2757
|
$ref: '#/components/schemas/priorityEnum'
|
2758
|
+
channel:
|
2759
|
+
$ref: '#/components/schemas/multiChannelMessageChannelEnum'
|
2760
|
+
required:
|
2761
|
+
- id
|
2762
|
+
- owner
|
2763
|
+
- applicationId
|
2764
|
+
- time
|
2765
|
+
- segmentCount
|
2766
|
+
- direction
|
2767
|
+
- to
|
2768
|
+
- from
|
2769
|
+
inboundCallbackMessage:
|
2770
|
+
allOf:
|
2771
|
+
- $ref: '#/components/schemas/statusCallbackMessage'
|
2772
|
+
- type: object
|
2773
|
+
properties:
|
2774
|
+
content:
|
2775
|
+
$ref: '#/components/schemas/multiChannelMessageContent'
|
2776
|
+
suggestionResponse:
|
2777
|
+
$ref: '#/components/schemas/rbmSuggestionResponse'
|
2778
|
+
locationResponse:
|
2779
|
+
$ref: '#/components/schemas/rbmLocationResponse'
|
2561
2780
|
required:
|
2562
2781
|
- id
|
2563
2782
|
- owner
|
@@ -2567,7 +2786,6 @@ components:
|
|
2567
2786
|
- direction
|
2568
2787
|
- to
|
2569
2788
|
- from
|
2570
|
-
- text
|
2571
2789
|
callbackMethodEnum:
|
2572
2790
|
type: string
|
2573
2791
|
nullable: true
|
@@ -5239,31 +5457,26 @@ components:
|
|
5239
5457
|
blocked:
|
5240
5458
|
description: >-
|
5241
5459
|
Whether a Toll-Free Verification is blocked. This attribute will only be
|
5242
|
-
defined when the number is blocked.
|
5460
|
+
defined when the number is blocked.
|
5243
5461
|
example: true
|
5244
5462
|
type: boolean
|
5245
5463
|
blockedReason:
|
5246
5464
|
description: >-
|
5247
5465
|
The reason why the Toll-Free Verification is blocked. This attribute
|
5248
|
-
will only be defined when the number is blocked.
|
5249
|
-
5/28/2025)
|
5466
|
+
will only be defined when the number is blocked.
|
5250
5467
|
example: Toll-free number was used to send spam messages
|
5251
5468
|
type: string
|
5252
5469
|
privacyPolicyUrl:
|
5253
|
-
description:
|
5254
|
-
|
5255
|
-
Until 5/28/2025)
|
5256
|
-
example: http://your-company.com/privacyPolicyUrl.pdf
|
5470
|
+
description: The Toll-Free Verification request privacy policy URL.
|
5471
|
+
example: http://your-company.com/privacyPolicy
|
5257
5472
|
type: string
|
5258
5473
|
termsAndConditionsUrl:
|
5259
|
-
description:
|
5260
|
-
|
5261
|
-
Available Until 5/28/2025)
|
5262
|
-
example: http://your-company.com/termsAndConditionsUrl.pdf
|
5474
|
+
description: The Toll-Free Verification request terms and conditions policy URL.
|
5475
|
+
example: http://your-company.com/termsAndConditions
|
5263
5476
|
type: string
|
5264
|
-
|
5265
|
-
description: The company 'Doing Business As'.
|
5266
|
-
example:
|
5477
|
+
businessDba:
|
5478
|
+
description: The company 'Doing Business As'.
|
5479
|
+
example: Another Company Name Inc.
|
5267
5480
|
type: string
|
5268
5481
|
additionalDenialReason:
|
5269
5482
|
properties:
|
@@ -5349,8 +5562,8 @@ components:
|
|
5349
5562
|
$ref: '#/components/schemas/privacyPolicyUrl'
|
5350
5563
|
termsAndConditionsUrl:
|
5351
5564
|
$ref: '#/components/schemas/termsAndConditionsUrl'
|
5352
|
-
|
5353
|
-
$ref: '#/components/schemas/
|
5565
|
+
businessDba:
|
5566
|
+
$ref: '#/components/schemas/businessDba'
|
5354
5567
|
verificationUpdateRequest:
|
5355
5568
|
type: object
|
5356
5569
|
required:
|
@@ -5388,8 +5601,8 @@ components:
|
|
5388
5601
|
$ref: '#/components/schemas/privacyPolicyUrl'
|
5389
5602
|
termsAndConditionsUrl:
|
5390
5603
|
$ref: '#/components/schemas/termsAndConditionsUrl'
|
5391
|
-
|
5392
|
-
$ref: '#/components/schemas/
|
5604
|
+
businessDba:
|
5605
|
+
$ref: '#/components/schemas/businessDba'
|
5393
5606
|
tfvBasicAuthentication:
|
5394
5607
|
type: object
|
5395
5608
|
properties:
|
@@ -5429,7 +5642,7 @@ components:
|
|
5429
5642
|
be interpreted as an HTTP status code in regards to the error that
|
5430
5643
|
was encountered.
|
5431
5644
|
example: '400'
|
5432
|
-
|
5645
|
+
errorMessage:
|
5433
5646
|
type: string
|
5434
5647
|
description: A description of the error that was encountered.
|
5435
5648
|
example: cannot process request.
|
@@ -5483,6 +5696,21 @@ components:
|
|
5483
5696
|
$ref: '#/components/schemas/tfvCallbackStatusEnum'
|
5484
5697
|
internalTicketNumber:
|
5485
5698
|
$ref: '#/components/schemas/internalTicketNumberForWebhook'
|
5699
|
+
blockedWebhook:
|
5700
|
+
type: object
|
5701
|
+
properties:
|
5702
|
+
accountId:
|
5703
|
+
$ref: '#/components/schemas/accountId1'
|
5704
|
+
phoneNumber:
|
5705
|
+
$ref: '#/components/schemas/tfPhoneNumber'
|
5706
|
+
status:
|
5707
|
+
$ref: '#/components/schemas/tfvCallbackStatusEnum'
|
5708
|
+
internalTicketNumber:
|
5709
|
+
$ref: '#/components/schemas/internalTicketNumberForWebhook'
|
5710
|
+
blocked:
|
5711
|
+
$ref: '#/components/schemas/blocked'
|
5712
|
+
blockedReason:
|
5713
|
+
$ref: '#/components/schemas/blockedReason'
|
5486
5714
|
tfvSubmissionWrapper:
|
5487
5715
|
type: object
|
5488
5716
|
properties:
|
@@ -5849,8 +6077,8 @@ components:
|
|
5849
6077
|
$ref: '#/components/schemas/privacyPolicyUrl'
|
5850
6078
|
termsAndConditionsUrl:
|
5851
6079
|
$ref: '#/components/schemas/termsAndConditionsUrl'
|
5852
|
-
|
5853
|
-
$ref: '#/components/schemas/
|
6080
|
+
businessDba:
|
6081
|
+
$ref: '#/components/schemas/businessDba'
|
5854
6082
|
tfvStatusEnum:
|
5855
6083
|
type: string
|
5856
6084
|
enum:
|
@@ -5944,6 +6172,12 @@ components:
|
|
5944
6172
|
application/json:
|
5945
6173
|
schema:
|
5946
6174
|
$ref: '#/components/schemas/messagingRequestError'
|
6175
|
+
messagingMethodNotAllowedError:
|
6176
|
+
description: Method Not Allowed
|
6177
|
+
content:
|
6178
|
+
application/json:
|
6179
|
+
schema:
|
6180
|
+
$ref: '#/components/schemas/messagingRequestError'
|
5947
6181
|
messagingInvalidMediaTypeError:
|
5948
6182
|
description: Unsupported Media Type
|
5949
6183
|
content:
|
@@ -5962,6 +6196,120 @@ components:
|
|
5962
6196
|
application/json:
|
5963
6197
|
schema:
|
5964
6198
|
$ref: '#/components/schemas/messagingRequestError'
|
6199
|
+
multiChannelBadRequestError:
|
6200
|
+
description: Bad Request
|
6201
|
+
content:
|
6202
|
+
application/json:
|
6203
|
+
schema:
|
6204
|
+
$ref: '#/components/schemas/multiChannelError'
|
6205
|
+
example:
|
6206
|
+
links: []
|
6207
|
+
data: null
|
6208
|
+
errors:
|
6209
|
+
- type: request-validation
|
6210
|
+
description: >-
|
6211
|
+
The 'channelList[0].from' field must contain exactly one
|
6212
|
+
telephone number
|
6213
|
+
source:
|
6214
|
+
field: channelList[0].from
|
6215
|
+
multiChannelNotAcceptableError:
|
6216
|
+
description: Not Acceptable
|
6217
|
+
multiChannelUnauthorizedError:
|
6218
|
+
description: Unauthorized
|
6219
|
+
content:
|
6220
|
+
application/json:
|
6221
|
+
schema:
|
6222
|
+
$ref: '#/components/schemas/multiChannelError'
|
6223
|
+
example:
|
6224
|
+
links: []
|
6225
|
+
data: null
|
6226
|
+
errors:
|
6227
|
+
- type: unauthorized
|
6228
|
+
description: Authentication Failed
|
6229
|
+
source: {}
|
6230
|
+
multiChannelForbiddenError:
|
6231
|
+
description: Forbidden
|
6232
|
+
content:
|
6233
|
+
application/json:
|
6234
|
+
schema:
|
6235
|
+
$ref: '#/components/schemas/multiChannelError'
|
6236
|
+
example:
|
6237
|
+
links: []
|
6238
|
+
data: null
|
6239
|
+
errors:
|
6240
|
+
- type: forbidden
|
6241
|
+
description: Access Denied
|
6242
|
+
source: {}
|
6243
|
+
multiChannelNotFoundError:
|
6244
|
+
description: Not Found
|
6245
|
+
content:
|
6246
|
+
application/json:
|
6247
|
+
schema:
|
6248
|
+
$ref: '#/components/schemas/multiChannelError'
|
6249
|
+
example:
|
6250
|
+
links: []
|
6251
|
+
data: null
|
6252
|
+
errors:
|
6253
|
+
- type: forbidden
|
6254
|
+
description: Resource not found.
|
6255
|
+
source: {}
|
6256
|
+
multiChannelMethodNotAllowedError:
|
6257
|
+
description: Method Not Allowed
|
6258
|
+
content:
|
6259
|
+
application/json:
|
6260
|
+
schema:
|
6261
|
+
$ref: '#/components/schemas/multiChannelError'
|
6262
|
+
example:
|
6263
|
+
links: []
|
6264
|
+
data: null
|
6265
|
+
errors:
|
6266
|
+
- type: method-not-allowed
|
6267
|
+
description: Method 'PUT' not supported for this resource.
|
6268
|
+
source: {}
|
6269
|
+
multiChannelInvalidMediaTypeError:
|
6270
|
+
description: Unsupported Media Type
|
6271
|
+
content:
|
6272
|
+
application/json:
|
6273
|
+
schema:
|
6274
|
+
$ref: '#/components/schemas/multiChannelError'
|
6275
|
+
example:
|
6276
|
+
links: []
|
6277
|
+
data: null
|
6278
|
+
errors:
|
6279
|
+
- type: unsupported-content-type
|
6280
|
+
description: >-
|
6281
|
+
Content-Type 'application/xml;charset=UTF-8' is not supported.
|
6282
|
+
Please use 'application/json'
|
6283
|
+
source:
|
6284
|
+
header: Content-Type
|
6285
|
+
multiChannelTooManyRequestsError:
|
6286
|
+
description: Too Many Requests
|
6287
|
+
content:
|
6288
|
+
application/json:
|
6289
|
+
schema:
|
6290
|
+
$ref: '#/components/schemas/multiChannelError'
|
6291
|
+
example:
|
6292
|
+
links: []
|
6293
|
+
data: null
|
6294
|
+
errors:
|
6295
|
+
- type: rate-limit-exceeded
|
6296
|
+
description: >-
|
6297
|
+
You have exceeded your rate limit for this endpoint. Please
|
6298
|
+
retry later.
|
6299
|
+
source: {}
|
6300
|
+
multiChannelInternalServerError:
|
6301
|
+
description: Internal Server Error
|
6302
|
+
content:
|
6303
|
+
application/json:
|
6304
|
+
schema:
|
6305
|
+
$ref: '#/components/schemas/multiChannelError'
|
6306
|
+
example:
|
6307
|
+
links: []
|
6308
|
+
data: null
|
6309
|
+
errors:
|
6310
|
+
- type: internal-server-error
|
6311
|
+
description: Internal server error. No further information available
|
6312
|
+
source: {}
|
5965
6313
|
createCallResponse:
|
5966
6314
|
description: Created
|
5967
6315
|
headers:
|
@@ -6363,6 +6711,8 @@ components:
|
|
6363
6711
|
example:
|
6364
6712
|
description: Cannot process request.
|
6365
6713
|
type: bad request
|
6714
|
+
noContentResponse:
|
6715
|
+
description: No Content
|
6366
6716
|
tfvPostBadRequestResponse:
|
6367
6717
|
description: Bad Request
|
6368
6718
|
content:
|
@@ -7468,6 +7818,7 @@ components:
|
|
7468
7818
|
- $ref: '#/components/schemas/verificationWebhook'
|
7469
7819
|
- $ref: '#/components/schemas/verificationDenialWebhook'
|
7470
7820
|
- $ref: '#/components/schemas/failureWebhook'
|
7821
|
+
- $ref: '#/components/schemas/blockedWebhook'
|
7471
7822
|
webhookSubscriptionRequest:
|
7472
7823
|
description: >-
|
7473
7824
|
Information about a webhook that Bandwidth should send upon the
|
@@ -7495,17 +7846,30 @@ components:
|
|
7495
7846
|
post:
|
7496
7847
|
requestBody:
|
7497
7848
|
required: true
|
7498
|
-
description:
|
7499
|
-
<p>This Inbound Message Webhook is an envelope containing a
|
7500
|
-
received (MO) message to your
|
7501
|
-
|
7849
|
+
description: >-
|
7850
|
+
<p>This Inbound Message Webhook is an envelope containing either a
|
7851
|
+
received (MO) message to your
|
7852
|
+
|
7853
|
+
message-enabled Bandwidth telephone number or a multichannel
|
7854
|
+
client's response to a suggestion response
|
7855
|
+
|
7856
|
+
or location request.
|
7857
|
+
|
7858
|
+
<p>The payload type will be one of <code>message-received</code>,
|
7859
|
+
<code>suggestion-response</code>, or
|
7860
|
+
<code>location-request-response</code>.
|
7861
|
+
|
7862
|
+
<p>Note that <code>suggestion-response</code> and
|
7863
|
+
<code>location-request-response</code> callback types are
|
7864
|
+
pertinent only for RBM messages sent from the
|
7865
|
+
<code>/messages/multiChannel</code> endpoint.
|
7502
7866
|
|
7503
7867
|
</p><p>Please visit <a
|
7504
7868
|
href='/docs/messaging/webhooks/'>Webhooks</a></p>
|
7505
7869
|
content:
|
7506
7870
|
application/json:
|
7507
7871
|
schema:
|
7508
|
-
$ref: '#/components/schemas/
|
7872
|
+
$ref: '#/components/schemas/inboundCallback'
|
7509
7873
|
examples:
|
7510
7874
|
smsMessageReceivedCallback:
|
7511
7875
|
$ref: '#/components/examples/smsMessageReceivedCallbackExample'
|
@@ -7514,24 +7878,26 @@ components:
|
|
7514
7878
|
responses:
|
7515
7879
|
'200':
|
7516
7880
|
description: OK
|
7881
|
+
'202':
|
7882
|
+
description: Accepted
|
7517
7883
|
statusCallback:
|
7518
7884
|
'{statusCallbackUrl}':
|
7519
7885
|
post:
|
7520
7886
|
requestBody:
|
7521
7887
|
required: true
|
7522
|
-
description:
|
7888
|
+
description: >-
|
7523
7889
|
<p>This Outbound Message Webhook is an envelope containing status
|
7524
|
-
information regarding a message sent (MT)
|
7525
|
-
message-enabled Bandwidth telephone number. The payload type will
|
7526
|
-
be one of "message-sending", "message-delivered", or
|
7527
|
-
"message-failed".
|
7890
|
+
information regarding a message sent (MT)
|
7528
7891
|
|
7892
|
+
from your message-enabled Bandwidth telephone number.
|
7893
|
+
<p>The payload type will be one of <code>message-sending</code>, <code>message-delivered</code>, <code>message-failed</code> or <code>message-read</code>.
|
7894
|
+
<p>Note that <code>message-read</code> callbacks are pertinent only for RBM messages sent from the <code>/messages/multiChannel</code> endpoint.
|
7529
7895
|
</p><p>Please visit <a
|
7530
7896
|
href='/docs/messaging/webhooks/'>Webhooks</a></p>
|
7531
7897
|
content:
|
7532
7898
|
application/json:
|
7533
7899
|
schema:
|
7534
|
-
$ref: '#/components/schemas/
|
7900
|
+
$ref: '#/components/schemas/statusCallback'
|
7535
7901
|
examples:
|
7536
7902
|
messageSendingCallback:
|
7537
7903
|
$ref: '#/components/examples/messageSendingCallbackExample'
|
@@ -7547,19 +7913,8 @@ components:
|
|
7547
7913
|
responses:
|
7548
7914
|
'200':
|
7549
7915
|
description: OK
|
7550
|
-
|
7551
|
-
|
7552
|
-
post:
|
7553
|
-
requestBody:
|
7554
|
-
required: true
|
7555
|
-
description: Status Callback Payload
|
7556
|
-
content:
|
7557
|
-
application/json:
|
7558
|
-
schema:
|
7559
|
-
$ref: '#/components/schemas/multiChannelCallbackData'
|
7560
|
-
responses:
|
7561
|
-
'204':
|
7562
|
-
description: No Content
|
7916
|
+
'202':
|
7917
|
+
description: Accepted
|
7563
7918
|
tfVerificationStatus:
|
7564
7919
|
your_url.com/webhookService:
|
7565
7920
|
post:
|
@@ -7583,7 +7938,7 @@ components:
|
|
7583
7938
|
$ref: '#/components/requestBodies/verificationWebhookRequest'
|
7584
7939
|
responses:
|
7585
7940
|
'204':
|
7586
|
-
|
7941
|
+
$ref: '#/components/responses/noContentResponse'
|
7587
7942
|
'400':
|
7588
7943
|
$ref: '#/components/responses/tfvBadRequestResponse'
|
7589
7944
|
'401':
|