bandwidth-sdk 18.3.0 → 19.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 +27 -21
- data/README.md +2 -11
- data/Rakefile +1 -1
- data/bandwidth.yml +341 -122
- data/coverage/.last_run.json +1 -1
- data/coverage/.resultset.json +1308 -939
- data/coverage/index.html +21197 -17030
- data/custom_templates/README.mustache +1 -1
- data/custom_templates/api_client.mustache +3 -1
- data/custom_templates/configuration.mustache +18 -12
- data/custom_templates/gem.mustache +4 -2
- data/docs/Callback.md +1 -0
- data/docs/CallsApi.md +5 -25
- data/docs/ConferencesApi.md +9 -45
- data/docs/DisconnectCallback.md +6 -2
- data/docs/EndpointsApi.md +5 -25
- data/docs/InboundCallback.md +1 -1
- data/docs/InboundCallbackMessage.md +2 -0
- data/docs/InitiateCallback.md +1 -1
- data/docs/LookupResult.md +2 -2
- data/docs/MFAApi.md +3 -15
- data/docs/MediaApi.md +7 -23
- data/docs/Message.md +1 -1
- data/docs/MessagesApi.md +2 -10
- data/docs/MultiChannelAction.md +3 -3
- data/docs/MultiChannelActionCalendarEvent.md +3 -3
- data/docs/MultiChannelApi.md +1 -5
- data/docs/PhoneNumberLookupApi.md +3 -15
- data/docs/RbmActionBase.md +3 -3
- data/docs/RbmActionDial.md +3 -3
- data/docs/RbmActionOpenUrl.md +3 -3
- data/docs/RbmActionViewLocation.md +3 -3
- data/docs/RbmSession.md +26 -0
- data/docs/RbmSuggestionResponse.md +4 -4
- data/docs/RecordingsApi.md +10 -50
- data/docs/StatisticsApi.md +1 -5
- data/docs/StatusCallback.md +2 -2
- data/docs/StatusCallbackMessage.md +3 -1
- data/docs/TfvSubmissionInfo.md +2 -2
- data/docs/TollFreeVerificationApi.md +12 -48
- data/docs/TranscriptionsApi.md +3 -15
- data/docs/TransferDisconnectCallback.md +7 -1
- data/docs/VerificationRequest.md +2 -2
- data/docs/VerificationUpdateRequest.md +3 -3
- data/generate.sh +9 -0
- data/lib/bandwidth-sdk/api/calls_api.rb +5 -5
- data/lib/bandwidth-sdk/api/conferences_api.rb +9 -9
- data/lib/bandwidth-sdk/api/endpoints_api.rb +5 -5
- data/lib/bandwidth-sdk/api/media_api.rb +8 -8
- data/lib/bandwidth-sdk/api/messages_api.rb +2 -2
- data/lib/bandwidth-sdk/api/mfa_api.rb +3 -3
- data/lib/bandwidth-sdk/api/multi_channel_api.rb +1 -1
- data/lib/bandwidth-sdk/api/phone_number_lookup_api.rb +3 -3
- data/lib/bandwidth-sdk/api/recordings_api.rb +10 -10
- data/lib/bandwidth-sdk/api/statistics_api.rb +1 -1
- data/lib/bandwidth-sdk/api/toll_free_verification_api.rb +15 -15
- data/lib/bandwidth-sdk/api/transcriptions_api.rb +3 -3
- data/lib/bandwidth-sdk/api_client.rb +3 -1
- data/lib/bandwidth-sdk/configuration.rb +18 -19
- data/lib/bandwidth-sdk/models/callback.rb +1 -0
- data/lib/bandwidth-sdk/models/disconnect_callback.rb +27 -5
- data/lib/bandwidth-sdk/models/inbound_callback_message.rb +10 -1
- data/lib/bandwidth-sdk/models/initiate_callback.rb +1 -1
- data/lib/bandwidth-sdk/models/list_message_item.rb +1 -0
- data/lib/bandwidth-sdk/models/multi_channel_action_calendar_event.rb +1 -1
- data/lib/bandwidth-sdk/models/rbm_action_base.rb +1 -1
- data/lib/bandwidth-sdk/models/rbm_action_dial.rb +1 -1
- data/lib/bandwidth-sdk/models/rbm_action_open_url.rb +1 -1
- data/lib/bandwidth-sdk/models/rbm_action_view_location.rb +1 -1
- data/lib/bandwidth-sdk/models/rbm_session.rb +208 -0
- data/lib/bandwidth-sdk/models/rbm_suggestion_response.rb +2 -2
- data/lib/bandwidth-sdk/models/status_callback_message.rb +13 -4
- data/lib/bandwidth-sdk/models/status_callback_type_enum.rb +2 -1
- data/lib/bandwidth-sdk/models/tfv_submission_info.rb +2 -2
- data/lib/bandwidth-sdk/models/transfer_disconnect_callback.rb +37 -5
- data/lib/bandwidth-sdk/models/verification_request.rb +2 -2
- data/lib/bandwidth-sdk/models/verification_update_request.rb +19 -2
- data/lib/bandwidth-sdk/version.rb +1 -1
- data/lib/bandwidth-sdk.rb +3 -2
- data/spec/smoke/calls_api_spec.rb +46 -46
- data/spec/smoke/conferences_api_spec.rb +1 -1
- data/spec/smoke/endpoints_api_spec.rb +2 -31
- data/spec/smoke/media_api_spec.rb +2 -0
- data/spec/smoke/messages_api_spec.rb +2 -24
- data/spec/smoke/mfa_api_spec.rb +4 -27
- data/spec/smoke/multi_channel_api_spec.rb +4 -2
- data/spec/smoke/phone_number_lookup_api_spec.rb +2 -0
- data/spec/smoke/recordings_api_spec.rb +1 -1
- data/spec/smoke/smoke_helper.rb +41 -0
- data/spec/smoke/statistics_api_spec.rb +2 -37
- data/spec/smoke/toll_free_verification_api_spec.rb +2 -0
- data/spec/smoke/transcriptions_api_spec.rb +1 -1
- data/spec/spec_helper.rb +0 -48
- data/spec/unit/api/calls_api_spec.rb +3 -1
- data/spec/unit/api/conferences_api_spec.rb +2 -0
- data/spec/unit/api/endpoints_api_spec.rb +2 -0
- data/spec/unit/api/media_api_spec.rb +2 -0
- data/spec/unit/api/messages_api_spec.rb +2 -0
- data/spec/unit/api/mfa_api_spec.rb +2 -0
- data/spec/unit/api/multi_channel_api_spec.rb +2 -0
- data/spec/unit/api/phone_number_lookup_api_spec.rb +2 -0
- data/spec/unit/api/recordings_api_spec.rb +2 -0
- data/spec/unit/api/statistics_api_spec.rb +2 -0
- data/spec/unit/api/toll_free_verification_api_spec.rb +2 -0
- data/spec/unit/api/transcriptions_api_spec.rb +2 -0
- data/spec/unit/client/api_client_spec.rb +70 -206
- data/spec/unit/client/configuration_spec.rb +22 -17
- data/spec/unit/constants.rb +6 -0
- data/spec/unit/models/callback_spec.rb +1 -0
- data/spec/unit/models/disconnect_callback_spec.rb +10 -2
- data/spec/unit/models/inbound_callback_message_spec.rb +20 -5
- data/spec/unit/models/list_message_item_spec.rb +1 -0
- data/spec/unit/models/rbm_session_spec.rb +95 -0
- data/spec/unit/models/status_callback_message_spec.rb +20 -5
- data/spec/unit/models/status_callback_type_enum_spec.rb +7 -1
- data/spec/unit/models/tfv_submission_wrapper_spec.rb +2 -1
- data/spec/unit/models/transfer_disconnect_callback_spec.rb +16 -4
- data/spec/unit/models/verification_update_request_spec.rb +4 -2
- metadata +10 -1
data/bandwidth.yml
CHANGED
|
@@ -8,7 +8,6 @@ info:
|
|
|
8
8
|
email: letstalk@bandwidth.com
|
|
9
9
|
version: 1.0.0
|
|
10
10
|
security:
|
|
11
|
-
- Basic: []
|
|
12
11
|
- OAuth2: []
|
|
13
12
|
tags:
|
|
14
13
|
- name: Messages
|
|
@@ -88,12 +87,11 @@ paths:
|
|
|
88
87
|
put:
|
|
89
88
|
summary: Upload Media
|
|
90
89
|
description: >-
|
|
91
|
-
Upload a file.
|
|
92
|
-
some control to your media file.
|
|
90
|
+
Upload a file.
|
|
93
91
|
|
|
94
92
|
|
|
95
|
-
|
|
96
|
-
|
|
93
|
+
Filename should always be unique. Reusing filenames may result in the
|
|
94
|
+
wrong media being sent.
|
|
97
95
|
|
|
98
96
|
|
|
99
97
|
A list of supported media types can be found at [Bandwidth
|
|
@@ -1404,7 +1402,19 @@ paths:
|
|
|
1404
1402
|
tags:
|
|
1405
1403
|
- Toll-Free Verification
|
|
1406
1404
|
summary: Request Toll-Free Verification
|
|
1407
|
-
description:
|
|
1405
|
+
description: >-
|
|
1406
|
+
Submit a request for verification of a toll-free phone number.
|
|
1407
|
+
|
|
1408
|
+
|
|
1409
|
+
**Upcoming change (effective January 2027):** If any phone number in the
|
|
1410
|
+
request already has a verification in progress, the request will be
|
|
1411
|
+
rejected with a `409 Conflict`.
|
|
1412
|
+
|
|
1413
|
+
This check is all-or-nothing: if a single phone number conflicts, the
|
|
1414
|
+
entire request is rejected and **none** of the phone numbers in the
|
|
1415
|
+
request are submitted.
|
|
1416
|
+
|
|
1417
|
+
Today, these requests are accepted with a `202`.
|
|
1408
1418
|
operationId: requestTollFreeVerification
|
|
1409
1419
|
parameters:
|
|
1410
1420
|
- $ref: '#/components/parameters/accountId4'
|
|
@@ -1421,6 +1431,8 @@ paths:
|
|
|
1421
1431
|
$ref: '#/components/responses/tfvForbiddenResponse'
|
|
1422
1432
|
'405':
|
|
1423
1433
|
$ref: '#/components/responses/tfvNotAllowedResponse'
|
|
1434
|
+
'409':
|
|
1435
|
+
$ref: '#/components/responses/tfvConflictResponse'
|
|
1424
1436
|
'429':
|
|
1425
1437
|
$ref: '#/components/responses/tfvTooManyRequestsResponse'
|
|
1426
1438
|
'500':
|
|
@@ -1477,6 +1489,14 @@ paths:
|
|
|
1477
1489
|
Submissions are only eligible for resubmission for 7 days within being
|
|
1478
1490
|
processed and if resubmission is allowed (resubmitAllowed field is
|
|
1479
1491
|
true).
|
|
1492
|
+
|
|
1493
|
+
Returns a `404` if no verification request exists for the phone number,
|
|
1494
|
+
and a `400` if the existing request is not eligible for resubmission.
|
|
1495
|
+
|
|
1496
|
+
|
|
1497
|
+
**Upcoming change (effective January 2027):** If a verification for the
|
|
1498
|
+
phone number is in progress, the update will be rejected with a `409
|
|
1499
|
+
Conflict`.
|
|
1480
1500
|
operationId: updateTollFreeVerificationRequest
|
|
1481
1501
|
parameters:
|
|
1482
1502
|
- $ref: '#/components/parameters/accountId4'
|
|
@@ -1492,8 +1512,12 @@ paths:
|
|
|
1492
1512
|
$ref: '#/components/responses/tfvUnauthorizedResponse'
|
|
1493
1513
|
'403':
|
|
1494
1514
|
$ref: '#/components/responses/tfvForbiddenResponse'
|
|
1515
|
+
'404':
|
|
1516
|
+
$ref: '#/components/responses/tfvNotFoundResponse'
|
|
1495
1517
|
'405':
|
|
1496
1518
|
$ref: '#/components/responses/tfvNotAllowedResponse'
|
|
1519
|
+
'409':
|
|
1520
|
+
$ref: '#/components/responses/tfvConflictResponse'
|
|
1497
1521
|
'429':
|
|
1498
1522
|
$ref: '#/components/responses/tfvTooManyRequestsResponse'
|
|
1499
1523
|
'500':
|
|
@@ -1504,7 +1528,13 @@ paths:
|
|
|
1504
1528
|
tfVerificationStatus:
|
|
1505
1529
|
$ref: '#/components/callbacks/tfVerificationStatus'
|
|
1506
1530
|
delete:
|
|
1507
|
-
description:
|
|
1531
|
+
description: >-
|
|
1532
|
+
Delete a toll-free verification submission for a toll-free number.
|
|
1533
|
+
|
|
1534
|
+
|
|
1535
|
+
**Upcoming change (effective January 2027):** If a verification for the
|
|
1536
|
+
phone number is in progress, it will be cancelled and the submission
|
|
1537
|
+
will then be deleted asynchronously.
|
|
1508
1538
|
operationId: deleteVerificationRequest
|
|
1509
1539
|
parameters:
|
|
1510
1540
|
- $ref: '#/components/parameters/accountId4'
|
|
@@ -1984,7 +2014,7 @@ components:
|
|
|
1984
2014
|
type: string
|
|
1985
2015
|
format: date-time
|
|
1986
2016
|
description: The ISO 8601 datetime of the message.
|
|
1987
|
-
example: 2020-04-07T14:03:07.000Z
|
|
2017
|
+
example: '2020-04-07T14:03:07.000Z'
|
|
1988
2018
|
carrierName:
|
|
1989
2019
|
type: string
|
|
1990
2020
|
nullable: true
|
|
@@ -2000,6 +2030,7 @@ components:
|
|
|
2000
2030
|
messageLength:
|
|
2001
2031
|
type: integer
|
|
2002
2032
|
description: The length of the message content.
|
|
2033
|
+
nullable: true
|
|
2003
2034
|
example: 18
|
|
2004
2035
|
attachmentCount:
|
|
2005
2036
|
type: integer
|
|
@@ -2063,13 +2094,11 @@ components:
|
|
|
2063
2094
|
prevPage:
|
|
2064
2095
|
type: string
|
|
2065
2096
|
description: The link to the previous page for pagination.
|
|
2066
|
-
example:
|
|
2067
|
-
https://messaging.bandwidth.com/api/v2/users/accountId/messages?messageStatus=DLR_EXPIRED&nextPage=DLAPE902
|
|
2097
|
+
example: https://messaging.bandwidth.com/api/v2/users/accountId/messages?messageStatus=DLR_EXPIRED&nextPage=DLAPE902
|
|
2068
2098
|
nextPage:
|
|
2069
2099
|
type: string
|
|
2070
2100
|
description: The link to the next page for pagination.
|
|
2071
|
-
example:
|
|
2072
|
-
https://messaging.bandwidth.com/api/v2/users/accountId/messages?messageStatus=DLR_EXPIRED&prevPage=GL83PD3C
|
|
2101
|
+
example: https://messaging.bandwidth.com/api/v2/users/accountId/messages?messageStatus=DLR_EXPIRED&prevPage=GL83PD3C
|
|
2073
2102
|
prevPageToken:
|
|
2074
2103
|
type: string
|
|
2075
2104
|
description: The isolated pagination token for the previous page.
|
|
@@ -2170,7 +2199,7 @@ components:
|
|
|
2170
2199
|
type: string
|
|
2171
2200
|
format: date-time
|
|
2172
2201
|
description: The datetime stamp of the message in ISO 8601
|
|
2173
|
-
example: 2024-12-02T20:15:57.
|
|
2202
|
+
example: '2024-12-02T20:15:57.278201Z'
|
|
2174
2203
|
segmentCount:
|
|
2175
2204
|
$ref: '#/components/schemas/segmentCount'
|
|
2176
2205
|
direction:
|
|
@@ -2589,14 +2618,13 @@ components:
|
|
|
2589
2618
|
type: string
|
|
2590
2619
|
description: Displayed text for user to click
|
|
2591
2620
|
maxLength: 25
|
|
2592
|
-
example:
|
|
2621
|
+
example: Track my order
|
|
2593
2622
|
rbmActionPostbackData:
|
|
2594
2623
|
title: Post Back Data
|
|
2595
2624
|
type: string
|
|
2596
|
-
|
|
2597
|
-
description: Base64 payload the customer receives when the reply is clicked.
|
|
2625
|
+
description: Payload the customer receives when the reply is clicked.
|
|
2598
2626
|
maxLength: 2048
|
|
2599
|
-
example:
|
|
2627
|
+
example: track-order-43654
|
|
2600
2628
|
rbmActionBase:
|
|
2601
2629
|
type: object
|
|
2602
2630
|
properties:
|
|
@@ -2667,14 +2695,14 @@ components:
|
|
|
2667
2695
|
description: >-
|
|
2668
2696
|
The start time of the event. Must be a valid RFC-3339 value,
|
|
2669
2697
|
e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00.
|
|
2670
|
-
example: 2022-09-14T18:20:16.000Z
|
|
2698
|
+
example: '2022-09-14T18:20:16.000Z'
|
|
2671
2699
|
endTime:
|
|
2672
2700
|
type: string
|
|
2673
2701
|
format: date-time
|
|
2674
2702
|
description: >-
|
|
2675
2703
|
The end time of the event. Must be a valid RFC-3339 value, e.g.,
|
|
2676
2704
|
2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00.
|
|
2677
|
-
example: 2022-09-14T18:20:16.000Z
|
|
2705
|
+
example: '2022-09-14T18:20:16.000Z'
|
|
2678
2706
|
description:
|
|
2679
2707
|
type: string
|
|
2680
2708
|
description: The description of the event.
|
|
@@ -2846,7 +2874,7 @@ components:
|
|
|
2846
2874
|
description: The time the message was received by the Bandwidth API.
|
|
2847
2875
|
type: string
|
|
2848
2876
|
format: date-time
|
|
2849
|
-
example: 2025-01-01T18:20:16.000Z
|
|
2877
|
+
example: '2025-01-01T18:20:16.000Z'
|
|
2850
2878
|
direction:
|
|
2851
2879
|
$ref: '#/components/schemas/messageDirectionEnum'
|
|
2852
2880
|
to:
|
|
@@ -2885,8 +2913,8 @@ components:
|
|
|
2885
2913
|
properties:
|
|
2886
2914
|
text:
|
|
2887
2915
|
type: string
|
|
2888
|
-
description: The text
|
|
2889
|
-
example:
|
|
2916
|
+
description: The text of the suggestion the user tapped.
|
|
2917
|
+
example: Track my order
|
|
2890
2918
|
postbackData:
|
|
2891
2919
|
$ref: '#/components/schemas/rbmActionPostbackData'
|
|
2892
2920
|
pairedMessageId:
|
|
@@ -2907,6 +2935,70 @@ components:
|
|
|
2907
2935
|
format: double
|
|
2908
2936
|
description: The longitude of the client's location.
|
|
2909
2937
|
example: '-122.4194'
|
|
2938
|
+
rbmSession:
|
|
2939
|
+
type: object
|
|
2940
|
+
description: >-
|
|
2941
|
+
RCS interactive session information for the message.
|
|
2942
|
+
|
|
2943
|
+
An interactive session is a 24-hour window covering all Rich and Rich
|
|
2944
|
+
Media messages exchanged between an
|
|
2945
|
+
|
|
2946
|
+
RCS agent and a specific end user mobile number. It is triggered when at
|
|
2947
|
+
least 4 messages are exchanged within
|
|
2948
|
+
|
|
2949
|
+
24 hours, at least 2 of them mobile-originated and at least 1
|
|
2950
|
+
mobile-terminated.
|
|
2951
|
+
|
|
2952
|
+
Only present on `message-delivered`, `message-received` and
|
|
2953
|
+
`session-started` callbacks for RBM messages of
|
|
2954
|
+
|
|
2955
|
+
US agents with the Conversational billing category. Omitted for all
|
|
2956
|
+
other messages.
|
|
2957
|
+
properties:
|
|
2958
|
+
canInitiate:
|
|
2959
|
+
type: boolean
|
|
2960
|
+
description: >-
|
|
2961
|
+
Whether the message can start an interactive session.
|
|
2962
|
+
|
|
2963
|
+
`false` if the message is already part of an active session, or if
|
|
2964
|
+
the agent is not eligible for
|
|
2965
|
+
|
|
2966
|
+
interactive session billing.
|
|
2967
|
+
example: false
|
|
2968
|
+
id:
|
|
2969
|
+
type: string
|
|
2970
|
+
nullable: true
|
|
2971
|
+
description: >-
|
|
2972
|
+
The unique identifier of the interactive session the message is part
|
|
2973
|
+
of. This is not a message ID.
|
|
2974
|
+
|
|
2975
|
+
Omitted if the message is not part of a session.
|
|
2976
|
+
example: 0f5a3b9c-2d4e-4f6a-8b1c-7e9d0a2b3c4d
|
|
2977
|
+
type:
|
|
2978
|
+
type: string
|
|
2979
|
+
nullable: true
|
|
2980
|
+
description: |-
|
|
2981
|
+
The type of the interactive session.
|
|
2982
|
+
Only present on `session-started` callbacks.
|
|
2983
|
+
example: INTERACTIVE_SESSION
|
|
2984
|
+
startTime:
|
|
2985
|
+
type: string
|
|
2986
|
+
nullable: true
|
|
2987
|
+
format: date-time
|
|
2988
|
+
description: >-
|
|
2989
|
+
The time the 24-hour session window opened. Only present on
|
|
2990
|
+
`session-started` callbacks.
|
|
2991
|
+
example: '2026-08-06T09:59:55Z'
|
|
2992
|
+
endTime:
|
|
2993
|
+
type: string
|
|
2994
|
+
nullable: true
|
|
2995
|
+
format: date-time
|
|
2996
|
+
description: >-
|
|
2997
|
+
The time the 24-hour session window closes. Only present on
|
|
2998
|
+
`session-started` callbacks.
|
|
2999
|
+
example: '2026-08-07T09:59:55Z'
|
|
3000
|
+
required:
|
|
3001
|
+
- canInitiate
|
|
2910
3002
|
callback:
|
|
2911
3003
|
description: >-
|
|
2912
3004
|
Callbacks are divided into two types based on direction of the related
|
|
@@ -2929,6 +3021,7 @@ components:
|
|
|
2929
3021
|
message-delivered: '#/components/schemas/statusCallback'
|
|
2930
3022
|
message-failed: '#/components/schemas/statusCallback'
|
|
2931
3023
|
message-read: '#/components/schemas/statusCallback'
|
|
3024
|
+
session-started: '#/components/schemas/statusCallback'
|
|
2932
3025
|
message-received: '#/components/schemas/inboundCallback'
|
|
2933
3026
|
requested-location-response: '#/components/schemas/inboundCallback'
|
|
2934
3027
|
suggestion-response: '#/components/schemas/inboundCallback'
|
|
@@ -2941,14 +3034,14 @@ components:
|
|
|
2941
3034
|
time:
|
|
2942
3035
|
type: string
|
|
2943
3036
|
format: date-time
|
|
2944
|
-
example: 2024-12-02T20:15:57.
|
|
3037
|
+
example: '2024-12-02T20:15:57.278201Z'
|
|
2945
3038
|
eventTime:
|
|
2946
3039
|
type: string
|
|
2947
3040
|
description: >-
|
|
2948
3041
|
Represents the time at which the message was read, for
|
|
2949
3042
|
`message-read` callbacks.
|
|
2950
3043
|
format: date-time
|
|
2951
|
-
example: 2024-12-02T20:15:58.
|
|
3044
|
+
example: '2024-12-02T20:15:58.278205Z'
|
|
2952
3045
|
type:
|
|
2953
3046
|
$ref: '#/components/schemas/statusCallbackTypeEnum'
|
|
2954
3047
|
to:
|
|
@@ -2984,7 +3077,7 @@ components:
|
|
|
2984
3077
|
time:
|
|
2985
3078
|
type: string
|
|
2986
3079
|
format: date-time
|
|
2987
|
-
example: 2024-12-02T20:15:57.
|
|
3080
|
+
example: '2024-12-02T20:15:57.278201Z'
|
|
2988
3081
|
type:
|
|
2989
3082
|
$ref: '#/components/schemas/inboundCallbackTypeEnum'
|
|
2990
3083
|
to:
|
|
@@ -3029,12 +3122,17 @@ components:
|
|
|
3029
3122
|
|
|
3030
3123
|
- `message-read` indicates that the RBM message was read by the
|
|
3031
3124
|
recipient.
|
|
3125
|
+
|
|
3126
|
+
- `session-started` indicates that a previously exchanged RBM message is
|
|
3127
|
+
now part of an RCS interactive session and is no longer billed
|
|
3128
|
+
individually.
|
|
3032
3129
|
enum:
|
|
3033
3130
|
- message-sending
|
|
3034
3131
|
- message-sent
|
|
3035
3132
|
- message-delivered
|
|
3036
3133
|
- message-failed
|
|
3037
3134
|
- message-read
|
|
3135
|
+
- session-started
|
|
3038
3136
|
example: message-delivered
|
|
3039
3137
|
inboundCallbackTypeEnum:
|
|
3040
3138
|
type: string
|
|
@@ -3075,7 +3173,7 @@ components:
|
|
|
3075
3173
|
time:
|
|
3076
3174
|
type: string
|
|
3077
3175
|
format: date-time
|
|
3078
|
-
example: 2024-12-02T20:15:57.
|
|
3176
|
+
example: '2024-12-02T20:15:57.666000Z'
|
|
3079
3177
|
segmentCount:
|
|
3080
3178
|
$ref: '#/components/schemas/segmentCount'
|
|
3081
3179
|
direction:
|
|
@@ -3112,6 +3210,8 @@ components:
|
|
|
3112
3210
|
$ref: '#/components/schemas/priorityEnum'
|
|
3113
3211
|
channel:
|
|
3114
3212
|
$ref: '#/components/schemas/multiChannelMessageChannelEnum'
|
|
3213
|
+
session:
|
|
3214
|
+
$ref: '#/components/schemas/rbmSession'
|
|
3115
3215
|
required:
|
|
3116
3216
|
- id
|
|
3117
3217
|
- owner
|
|
@@ -3305,8 +3405,7 @@ components:
|
|
|
3305
3405
|
uui:
|
|
3306
3406
|
nullable: true
|
|
3307
3407
|
type: string
|
|
3308
|
-
example:
|
|
3309
|
-
eyJhbGciOiJIUzI1NiJ9.WyJoaSJd.-znkjYyCkgz4djmHUPSXl9YrJ6Nix_XvmlwKGFh5ERM;encoding=jwt,aGVsbG8gd29ybGQ;encoding=base64
|
|
3408
|
+
example: eyJhbGciOiJIUzI1NiJ9.WyJoaSJd.-znkjYyCkgz4djmHUPSXl9YrJ6Nix_XvmlwKGFh5ERM;encoding=jwt,aGVsbG8gd29ybGQ;encoding=base64
|
|
3310
3409
|
description: >-
|
|
3311
3410
|
A comma-separated list of 'User-To-User' headers to be sent
|
|
3312
3411
|
|
|
@@ -3516,8 +3615,7 @@ components:
|
|
|
3516
3615
|
callUrl:
|
|
3517
3616
|
type: string
|
|
3518
3617
|
format: uri
|
|
3519
|
-
example:
|
|
3520
|
-
https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
|
|
3618
|
+
example: https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
|
|
3521
3619
|
description: The URL to update this call's state.
|
|
3522
3620
|
callTimeout:
|
|
3523
3621
|
type: number
|
|
@@ -3688,8 +3786,7 @@ components:
|
|
|
3688
3786
|
configured
|
|
3689
3787
|
|
|
3690
3788
|
to forward this header.
|
|
3691
|
-
example:
|
|
3692
|
-
eyJhbGciOiJFUzI1NiIsInBwdCI6InNoYWtlbiIsInR5cCI6InBhc3Nwb3J0IiwieDV1IjoiaHR0cHM6Ly9idy1zaGFrZW4tY2VydC1wdWIuczMuYW1hem9uYXdzLmNvbS9iYW5kd2lkdGgtc2hha2VuLWNlcnRfMjAyMzA3MTYucGVtIn0.eyJhdHRlc3QiOiJBIiwiZGVzdCI6eyJ0biI6WyIxOTg0MjgyMDI4MCJdfSwiaWF0IjoxNjU2NTM0MzM2LCJvcmlnIjp7InRuIjoiMTkxOTQ0NDI2ODMifSwib3JpZ2lkIjoiNDk0NTlhOGEtNDJmNi0zNTFjLTkzNjEtYWRmNTdhOWUwOGNhIn0.56un9sRw_uH-sbJvnUsqdevlVxbOVjn8MVlGTlBMicjaZuRRwxfiNp-C9zYCMKTTCbc-QdYPN05F61XNVN4D3w;info=<https://bw-shaken-cert-pub.s3.amazonaws.com/bandwidth-shaken-cert_20230716.pem>;alg=ES256;ppt=shaken
|
|
3789
|
+
example: eyJhbGciOiJFUzI1NiIsInBwdCI6InNoYWtlbiIsInR5cCI6InBhc3Nwb3J0IiwieDV1IjoiaHR0cHM6Ly9idy1zaGFrZW4tY2VydC1wdWIuczMuYW1hem9uYXdzLmNvbS9iYW5kd2lkdGgtc2hha2VuLWNlcnRfMjAyMzA3MTYucGVtIn0.eyJhdHRlc3QiOiJBIiwiZGVzdCI6eyJ0biI6WyIxOTg0MjgyMDI4MCJdfSwiaWF0IjoxNjU2NTM0MzM2LCJvcmlnIjp7InRuIjoiMTkxOTQ0NDI2ODMifSwib3JpZ2lkIjoiNDk0NTlhOGEtNDJmNi0zNTFjLTkzNjEtYWRmNTdhOWUwOGNhIn0.56un9sRw_uH-sbJvnUsqdevlVxbOVjn8MVlGTlBMicjaZuRRwxfiNp-C9zYCMKTTCbc-QdYPN05F61XNVN4D3w;info=<https://bw-shaken-cert-pub.s3.amazonaws.com/bandwidth-shaken-cert_20230716.pem>;alg=ES256;ppt=shaken
|
|
3693
3790
|
enqueuedTime:
|
|
3694
3791
|
nullable: true
|
|
3695
3792
|
type: string
|
|
@@ -4006,8 +4103,7 @@ components:
|
|
|
4006
4103
|
respond. Not
|
|
4007
4104
|
|
|
4008
4105
|
allowed if `state` is `completed`.
|
|
4009
|
-
example:
|
|
4010
|
-
https://myFallbackServer.example/bandwidth/webhooks/conferenceRedirect
|
|
4106
|
+
example: https://myFallbackServer.example/bandwidth/webhooks/conferenceRedirect
|
|
4011
4107
|
redirectFallbackMethod:
|
|
4012
4108
|
$ref: '#/components/schemas/redirectMethodEnum'
|
|
4013
4109
|
fallbackUsername:
|
|
@@ -4046,8 +4142,7 @@ components:
|
|
|
4046
4142
|
Member](/apis/voice-apis/voice/#tag/Conferences/operation/updateConferenceMember)
|
|
4047
4143
|
|
|
4048
4144
|
endpoint.
|
|
4049
|
-
example:
|
|
4050
|
-
https://voice.bandwidth.com/api/v2/accounts/9900000/conferences/conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9/members/c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
|
|
4145
|
+
example: https://voice.bandwidth.com/api/v2/accounts/9900000/conferences/conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9/members/c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
|
|
4051
4146
|
mute:
|
|
4052
4147
|
type: boolean
|
|
4053
4148
|
description: >-
|
|
@@ -4284,8 +4379,7 @@ components:
|
|
|
4284
4379
|
|
|
4285
4380
|
to respond
|
|
4286
4381
|
maxLength: 2048
|
|
4287
|
-
example:
|
|
4288
|
-
https://myFallbackServer.example/bandwidth/webhooks/machineDetectionComplete
|
|
4382
|
+
example: https://myFallbackServer.example/bandwidth/webhooks/machineDetectionComplete
|
|
4289
4383
|
fallbackMethod:
|
|
4290
4384
|
$ref: '#/components/schemas/callbackMethodEnum'
|
|
4291
4385
|
fallbackUsername:
|
|
@@ -4439,8 +4533,7 @@ components:
|
|
|
4439
4533
|
example:
|
|
4440
4534
|
- transcriptionId: t-3f758f24-c7a2fc78-7c91-401a-8b2e-e542f9c40d6b
|
|
4441
4535
|
transcriptionName: live_transcription
|
|
4442
|
-
transcriptionUrl:
|
|
4443
|
-
https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-fef240ff-5cfc9091-8069-4863-a8c0-a4dcbbf1f1a4/transcriptions/t-3f758f24-c7a2fc78-7c91-401a-8b2e-e542f9c40d6b
|
|
4536
|
+
transcriptionUrl: https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-fef240ff-5cfc9091-8069-4863-a8c0-a4dcbbf1f1a4/transcriptions/t-3f758f24-c7a2fc78-7c91-401a-8b2e-e542f9c40d6b
|
|
4444
4537
|
callTranscriptionMetadata:
|
|
4445
4538
|
type: object
|
|
4446
4539
|
properties:
|
|
@@ -4463,8 +4556,7 @@ components:
|
|
|
4463
4556
|
[Get Call
|
|
4464
4557
|
Transcription](/apis/voice-apis/voice/#tag/Transcriptions/operation/getRealTimeTranscription)
|
|
4465
4558
|
endpoint.
|
|
4466
|
-
example:
|
|
4467
|
-
https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-fef240ff-5cfc9091-8069-4863-a8c0-a4dcbbf1f1a4/transcriptions/t-3f758f24-c7a2fc78-7c91-401a-8b2e-e542f9c40d6b
|
|
4559
|
+
example: https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-fef240ff-5cfc9091-8069-4863-a8c0-a4dcbbf1f1a4/transcriptions/t-3f758f24-c7a2fc78-7c91-401a-8b2e-e542f9c40d6b
|
|
4468
4560
|
callTranscriptionResponse:
|
|
4469
4561
|
type: object
|
|
4470
4562
|
properties:
|
|
@@ -4529,8 +4621,7 @@ components:
|
|
|
4529
4621
|
type: string
|
|
4530
4622
|
format: uri
|
|
4531
4623
|
description: The URL of the [transcription](#operation/getCallTranscription)
|
|
4532
|
-
example:
|
|
4533
|
-
https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85/recordings/r-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85/transcription
|
|
4624
|
+
example: https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85/recordings/r-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85/transcription
|
|
4534
4625
|
voiceApiError:
|
|
4535
4626
|
type: object
|
|
4536
4627
|
properties:
|
|
@@ -4845,6 +4936,10 @@ components:
|
|
|
4845
4936
|
$ref: '#/components/schemas/sipCallId'
|
|
4846
4937
|
sipResponseCode:
|
|
4847
4938
|
$ref: '#/components/schemas/sipResponseCode'
|
|
4939
|
+
sipStatusLine:
|
|
4940
|
+
$ref: '#/components/schemas/sipStatusLine'
|
|
4941
|
+
sipHeaders:
|
|
4942
|
+
$ref: '#/components/schemas/sipHeaders'
|
|
4848
4943
|
dtmfCallback:
|
|
4849
4944
|
type: object
|
|
4850
4945
|
description: >-
|
|
@@ -5364,6 +5459,12 @@ components:
|
|
|
5364
5459
|
$ref: '#/components/schemas/errorMessage'
|
|
5365
5460
|
errorId:
|
|
5366
5461
|
$ref: '#/components/schemas/errorId'
|
|
5462
|
+
sipResponseCode:
|
|
5463
|
+
$ref: '#/components/schemas/sipResponseCode'
|
|
5464
|
+
sipStatusLine:
|
|
5465
|
+
$ref: '#/components/schemas/sipStatusLine'
|
|
5466
|
+
sipHeaders:
|
|
5467
|
+
$ref: '#/components/schemas/sipHeaders'
|
|
5367
5468
|
eventType:
|
|
5368
5469
|
type: string
|
|
5369
5470
|
description: >-
|
|
@@ -5495,8 +5596,7 @@ components:
|
|
|
5495
5596
|
description: >-
|
|
5496
5597
|
The URL that can be used to download the recording. Only present if the
|
|
5497
5598
|
recording is finished and may be downloaded.
|
|
5498
|
-
example:
|
|
5499
|
-
https://voice.bandwidth.com/api/v2/accounts/9900000/conferences/conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9/recordings/r-fbe05094-9fd2afe9-bf5b-4c68-820a-41a01c1c5833/media
|
|
5599
|
+
example: https://voice.bandwidth.com/api/v2/accounts/9900000/conferences/conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9/recordings/r-fbe05094-9fd2afe9-bf5b-4c68-820a-41a01c1c5833/media
|
|
5500
5600
|
callId:
|
|
5501
5601
|
type: string
|
|
5502
5602
|
description: The call id associated with the event.
|
|
@@ -5509,8 +5609,7 @@ components:
|
|
|
5509
5609
|
type: string
|
|
5510
5610
|
format: uri
|
|
5511
5611
|
description: The URL of the call associated with the event.
|
|
5512
|
-
example:
|
|
5513
|
-
https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
|
|
5612
|
+
example: https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
|
|
5514
5613
|
parentCallId:
|
|
5515
5614
|
type: string
|
|
5516
5615
|
description: >-
|
|
@@ -5679,23 +5778,44 @@ components:
|
|
|
5679
5778
|
additionalProperties:
|
|
5680
5779
|
type: string
|
|
5681
5780
|
description: >-
|
|
5682
|
-
(optional) Map of
|
|
5683
|
-
|
|
5684
|
-
|
|
5685
|
-
|
|
5686
|
-
|
|
5687
|
-
|
|
5688
|
-
|
|
5781
|
+
(optional) Map of SIP headers, with lowercase keys (SIP headers are
|
|
5782
|
+
case-insensitive). On the Initiate callback, contains the
|
|
5783
|
+
customer-supplied X-* headers from the original INVITE; present only for
|
|
5784
|
+
inbound SIP URI calls with custom headers. On the Disconnect and
|
|
5785
|
+
Transfer Disconnect callbacks, contains a single `reason` key holding
|
|
5786
|
+
the raw, unmodified `Reason` header value from the final SIP response
|
|
5787
|
+
that rejected an outbound call (or transferred leg); present only when
|
|
5788
|
+
that response included a `Reason` header (for example, `v=analytics1`
|
|
5789
|
+
call-analytics block information from a terminating carrier). If the
|
|
5790
|
+
response carries more than one `Reason` header, all values are returned
|
|
5791
|
+
in the order received, separated by `, `. Note - on the Initiate
|
|
5792
|
+
callback, keys preserve the original SIP header name in lowercase rather
|
|
5793
|
+
than Bandwidth's usual camelCase JSON convention, since these are
|
|
5794
|
+
passthrough values from the caller's SIP INVITE, not Bandwidth-defined
|
|
5795
|
+
fields. If the same header name is sent more than once in the INVITE,
|
|
5796
|
+
only the last value is kept. The example shown is for the Initiate
|
|
5797
|
+
callback; on the Disconnect and Transfer Disconnect callbacks the only
|
|
5798
|
+
key is `reason`.
|
|
5689
5799
|
example:
|
|
5690
5800
|
x-custom-header: customer-value
|
|
5691
5801
|
x-session-id: sess-12345
|
|
5692
5802
|
sipResponseCode:
|
|
5693
5803
|
type: integer
|
|
5694
5804
|
description: >-
|
|
5695
|
-
(optional) The SIP status code
|
|
5696
|
-
|
|
5697
|
-
Present only when
|
|
5805
|
+
(optional) The SIP status code of the final response that rejected an
|
|
5806
|
+
outbound call's (or transferred leg's) INVITE (e.g. 486 for busy, 603
|
|
5807
|
+
for decline). Present only when the call was rejected with a SIP
|
|
5808
|
+
response.
|
|
5698
5809
|
example: 486
|
|
5810
|
+
sipStatusLine:
|
|
5811
|
+
type: string
|
|
5812
|
+
description: >-
|
|
5813
|
+
(optional) The full SIP status line, exactly as received, of the final
|
|
5814
|
+
response that rejected an outbound call's INVITE. The reason phrase can
|
|
5815
|
+
help distinguish outcomes that share a status code, such as `603 Network
|
|
5816
|
+
Blocked` and `603 Decline`. Present only when an outbound call was
|
|
5817
|
+
rejected with a SIP response.
|
|
5818
|
+
example: SIP/2.0 603 Network Blocked
|
|
5699
5819
|
codeRequest:
|
|
5700
5820
|
type: object
|
|
5701
5821
|
properties:
|
|
@@ -6273,7 +6393,7 @@ components:
|
|
|
6273
6393
|
Government-issued business identifying number.
|
|
6274
6394
|
|
|
6275
6395
|
|
|
6276
|
-
**
|
|
6396
|
+
**As of October 19th, 2026 this field is required when
|
|
6277
6397
|
`businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is
|
|
6278
6398
|
provided, `businessRegistrationType` and
|
|
6279
6399
|
`businessRegistrationIssuingCountry` are also required.**
|
|
@@ -6286,7 +6406,7 @@ components:
|
|
|
6286
6406
|
The type of business registration number.
|
|
6287
6407
|
|
|
6288
6408
|
|
|
6289
|
-
**
|
|
6409
|
+
**As of October 19th, 2026 this field is required when
|
|
6290
6410
|
`businessRegistrationNumber` is provided.**
|
|
6291
6411
|
enum:
|
|
6292
6412
|
- EIN
|
|
@@ -6317,7 +6437,7 @@ components:
|
|
|
6317
6437
|
encouraged.
|
|
6318
6438
|
|
|
6319
6439
|
|
|
6320
|
-
**
|
|
6440
|
+
**As of October 19th, 2026 this field is required when
|
|
6321
6441
|
`businessRegistrationNumber` is provided.**
|
|
6322
6442
|
|
|
6323
6443
|
|
|
@@ -6368,9 +6488,9 @@ components:
|
|
|
6368
6488
|
The type of registered business.
|
|
6369
6489
|
|
|
6370
6490
|
|
|
6371
|
-
**
|
|
6491
|
+
**As of October 19th, 2026 submissions using a value other than
|
|
6372
6492
|
`SOLE_PROPRIETOR` must provide a value for `businessRegistrationNumber`,
|
|
6373
|
-
`businessRegistrationType`, and `businessRegistrationIssuingCountry`.
|
|
6493
|
+
`businessRegistrationType`, and `businessRegistrationIssuingCountry`.
|
|
6374
6494
|
|
|
6375
6495
|
Submissions using `SOLE_PROPRIETOR` must _omit_
|
|
6376
6496
|
`businessRegistrationNumber`, `businessRegistrationType`, and
|
|
@@ -6490,6 +6610,7 @@ components:
|
|
|
6490
6610
|
- useCaseSummary
|
|
6491
6611
|
- productionMessageContent
|
|
6492
6612
|
- optInWorkflow
|
|
6613
|
+
- businessEntityType
|
|
6493
6614
|
properties:
|
|
6494
6615
|
businessAddress:
|
|
6495
6616
|
$ref: '#/components/schemas/address'
|
|
@@ -6734,8 +6855,7 @@ components:
|
|
|
6734
6855
|
maxLength: 500
|
|
6735
6856
|
nullable: false
|
|
6736
6857
|
example: https://www.example.com/path/to/resource
|
|
6737
|
-
pattern:
|
|
6738
|
-
^$|(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,253}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#()?&//=]*)
|
|
6858
|
+
pattern: ^$|(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,253}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#()?&//=]*)
|
|
6739
6859
|
confirmationResponse:
|
|
6740
6860
|
type: string
|
|
6741
6861
|
minLength: 0
|
|
@@ -6782,8 +6902,7 @@ components:
|
|
|
6782
6902
|
minLength: 0
|
|
6783
6903
|
maxLength: 500
|
|
6784
6904
|
nullable: false
|
|
6785
|
-
pattern:
|
|
6786
|
-
^(?:[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\[(?:(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9]))\.){3}(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9])|[a-z0-9-]*[a-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])$
|
|
6905
|
+
pattern: ^(?:[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\[(?:(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9]))\.){3}(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9])|[a-z0-9-]*[a-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])$
|
|
6787
6906
|
example: foo@bar.com
|
|
6788
6907
|
useCases:
|
|
6789
6908
|
type: array
|
|
@@ -6935,8 +7054,7 @@ components:
|
|
|
6935
7054
|
maxLength: 2000
|
|
6936
7055
|
nullable: true
|
|
6937
7056
|
example: https://www.example.com/path/to/resource
|
|
6938
|
-
pattern:
|
|
6939
|
-
^$|(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,253}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#()?&//=]*)
|
|
7057
|
+
pattern: ^$|(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,253}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#()?&//=]*)
|
|
6940
7058
|
tfvError:
|
|
6941
7059
|
description: A generic error object.
|
|
6942
7060
|
properties:
|
|
@@ -7075,8 +7193,7 @@ components:
|
|
|
7075
7193
|
minLength: 0
|
|
7076
7194
|
maxLength: 500
|
|
7077
7195
|
nullable: true
|
|
7078
|
-
example:
|
|
7079
|
-
cv.user123|sess456|mno|tfree|read_write|X7yZ9aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVw
|
|
7196
|
+
example: cv.user123|sess456|mno|tfree|read_write|X7yZ9aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVw
|
|
7080
7197
|
endpointId:
|
|
7081
7198
|
type: string
|
|
7082
7199
|
description: The unique ID of the endpoint.
|
|
@@ -7281,8 +7398,7 @@ components:
|
|
|
7281
7398
|
href:
|
|
7282
7399
|
type: string
|
|
7283
7400
|
description: The full URL of the link.
|
|
7284
|
-
example:
|
|
7285
|
-
https://api.bandwidth.com/v2/accounts/5500123/endpoints/e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
|
|
7401
|
+
example: https://api.bandwidth.com/v2/accounts/5500123/endpoints/e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
|
|
7286
7402
|
rel:
|
|
7287
7403
|
type: string
|
|
7288
7404
|
description: The relationship of the link to the current resource.
|
|
@@ -8072,6 +8188,17 @@ components:
|
|
|
8072
8188
|
example:
|
|
8073
8189
|
description: Cannot find the requested resource.
|
|
8074
8190
|
type: Not Found
|
|
8191
|
+
tfvConflictResponse:
|
|
8192
|
+
description: >-
|
|
8193
|
+
Conflict. A toll-free verification for the phone number is already in
|
|
8194
|
+
progress.
|
|
8195
|
+
content:
|
|
8196
|
+
application/json:
|
|
8197
|
+
schema:
|
|
8198
|
+
$ref: '#/components/schemas/tfvError'
|
|
8199
|
+
example:
|
|
8200
|
+
description: 'TFV request already in progress for phone number: +18005551234'
|
|
8201
|
+
type: conflict
|
|
8075
8202
|
tfvNotAllowedResponse:
|
|
8076
8203
|
description: Method Not Allowed
|
|
8077
8204
|
content:
|
|
@@ -8256,8 +8383,8 @@ components:
|
|
|
8256
8383
|
style: simple
|
|
8257
8384
|
explode: false
|
|
8258
8385
|
description: >-
|
|
8259
|
-
|
|
8260
|
-
by
|
|
8386
|
+
Pass-through header stored with the media and returned when the media is
|
|
8387
|
+
retrieved by the user. Does not affect internal server caching behavior.
|
|
8261
8388
|
example: no-cache
|
|
8262
8389
|
schema:
|
|
8263
8390
|
type: string
|
|
@@ -8265,8 +8392,7 @@ components:
|
|
|
8265
8392
|
in: header
|
|
8266
8393
|
name: Continuation-Token
|
|
8267
8394
|
description: Continuation token used to retrieve subsequent media.
|
|
8268
|
-
example:
|
|
8269
|
-
1XEi2tsFtLo1JbtLwETnM1ZJ+PqAa8w6ENvC5QKvwyrCDYII663Gy5M4s40owR1tjkuWUif6qbWvFtQJR5/ipqbUnfAqL254LKNlPy6tATCzioKSuHuOqgzloDkSwRtX0LtcL2otHS69hK343m+SjdL+vlj71tT39
|
|
8395
|
+
example: 1XEi2tsFtLo1JbtLwETnM1ZJ+PqAa8w6ENvC5QKvwyrCDYII663Gy5M4s40owR1tjkuWUif6qbWvFtQJR5/ipqbUnfAqL254LKNlPy6tATCzioKSuHuOqgzloDkSwRtX0LtcL2otHS69hK343m+SjdL+vlj71tT39
|
|
8270
8396
|
schema:
|
|
8271
8397
|
type: string
|
|
8272
8398
|
messageId:
|
|
@@ -8355,7 +8481,7 @@ components:
|
|
|
8355
8481
|
description: >-
|
|
8356
8482
|
The start of the date range to search in ISO 8601 format. Uses the
|
|
8357
8483
|
message receive time. The date range to search in is currently 14 days.
|
|
8358
|
-
example: 2022-09-14T18:20:16.000Z
|
|
8484
|
+
example: '2022-09-14T18:20:16.000Z'
|
|
8359
8485
|
schema:
|
|
8360
8486
|
type: string
|
|
8361
8487
|
toDateTime:
|
|
@@ -8365,7 +8491,7 @@ components:
|
|
|
8365
8491
|
description: >-
|
|
8366
8492
|
The end of the date range to search in ISO 8601 format. Uses the message
|
|
8367
8493
|
receive time. The date range to search in is currently 14 days.
|
|
8368
|
-
example: 2022-09-14T18:20:16.000Z
|
|
8494
|
+
example: '2022-09-14T18:20:16.000Z'
|
|
8369
8495
|
schema:
|
|
8370
8496
|
type: string
|
|
8371
8497
|
campaignId:
|
|
@@ -8833,8 +8959,32 @@ components:
|
|
|
8833
8959
|
from: '+12345678901'
|
|
8834
8960
|
text: Hey, check out the MMS!
|
|
8835
8961
|
media:
|
|
8836
|
-
-
|
|
8837
|
-
|
|
8962
|
+
- https://messaging.bandwidth.com/api/v2/users/9900902/media/14762070468292kw2fuqty55yp2b2/0/bw.png
|
|
8963
|
+
rbmMessageReceivedSessionCallbackExample:
|
|
8964
|
+
summary: >-
|
|
8965
|
+
An example of a rbm message-received callback body for a message that is
|
|
8966
|
+
part of an RCS interactive session.
|
|
8967
|
+
value:
|
|
8968
|
+
time: '2026-08-06T10:00:05.502180Z'
|
|
8969
|
+
type: message-received
|
|
8970
|
+
to: BandwidthRBM
|
|
8971
|
+
description: Incoming message received
|
|
8972
|
+
message:
|
|
8973
|
+
id: 1786010405502l2ntaoajuqjhqnxu
|
|
8974
|
+
owner: BandwidthRBM
|
|
8975
|
+
applicationId: 93de2206-9669-4e07-948d-329f4b722ee2
|
|
8976
|
+
time: '2026-08-06T10:00:05.302180Z'
|
|
8977
|
+
segmentCount: 1
|
|
8978
|
+
direction: in
|
|
8979
|
+
to:
|
|
8980
|
+
- BandwidthRBM
|
|
8981
|
+
from: '+12345678902'
|
|
8982
|
+
channel: RBM
|
|
8983
|
+
content:
|
|
8984
|
+
text: Yes, please book it for tomorrow.
|
|
8985
|
+
session:
|
|
8986
|
+
canInitiate: false
|
|
8987
|
+
id: 0f5a3b9c-2d4e-4f6a-8b1c-7e9d0a2b3c4d
|
|
8838
8988
|
messageSendingCallbackExample:
|
|
8839
8989
|
summary: An example of a message-sending callback body.
|
|
8840
8990
|
value:
|
|
@@ -8934,6 +9084,79 @@ components:
|
|
|
8934
9084
|
owner: '+12345678902'
|
|
8935
9085
|
direction: out
|
|
8936
9086
|
segmentCount: 1
|
|
9087
|
+
rbmMessageDeliveredSessionCallbackExample:
|
|
9088
|
+
summary: >-
|
|
9089
|
+
An example of a rbm message-delivered callback body for a message that
|
|
9090
|
+
is part of an RCS interactive session.
|
|
9091
|
+
value:
|
|
9092
|
+
type: message-delivered
|
|
9093
|
+
time: '2026-08-06T10:01:11.160744Z'
|
|
9094
|
+
description: Message delivered to handset.
|
|
9095
|
+
to: '+12345678902'
|
|
9096
|
+
message:
|
|
9097
|
+
id: 1786010470868ty55yp2b2kw2fuq
|
|
9098
|
+
time: '2026-08-06T10:01:10.868292Z'
|
|
9099
|
+
to:
|
|
9100
|
+
- '+12345678902'
|
|
9101
|
+
from: BandwidthRBM
|
|
9102
|
+
text: ''
|
|
9103
|
+
applicationId: 93de2206-9669-4e07-948d-329f4b722ee2
|
|
9104
|
+
owner: BandwidthRBM
|
|
9105
|
+
direction: out
|
|
9106
|
+
segmentCount: 1
|
|
9107
|
+
channel: RBM
|
|
9108
|
+
session:
|
|
9109
|
+
canInitiate: false
|
|
9110
|
+
id: 0f5a3b9c-2d4e-4f6a-8b1c-7e9d0a2b3c4d
|
|
9111
|
+
rbmMessageDeliveredCanInitiateSessionCallbackExample:
|
|
9112
|
+
summary: >-
|
|
9113
|
+
An example of a rbm message-delivered callback body for a message that
|
|
9114
|
+
is not yet part of an RCS interactive session.
|
|
9115
|
+
value:
|
|
9116
|
+
type: message-delivered
|
|
9117
|
+
time: '2026-08-06T09:59:56.160744Z'
|
|
9118
|
+
description: Message delivered to handset.
|
|
9119
|
+
to: '+12345678902'
|
|
9120
|
+
message:
|
|
9121
|
+
id: 1786010395000kw2fuqty55yp2b2
|
|
9122
|
+
time: '2026-08-06T09:59:55.000000Z'
|
|
9123
|
+
to:
|
|
9124
|
+
- '+12345678902'
|
|
9125
|
+
from: BandwidthRBM
|
|
9126
|
+
text: ''
|
|
9127
|
+
applicationId: 93de2206-9669-4e07-948d-329f4b722ee2
|
|
9128
|
+
owner: BandwidthRBM
|
|
9129
|
+
direction: out
|
|
9130
|
+
segmentCount: 1
|
|
9131
|
+
channel: RBM
|
|
9132
|
+
session:
|
|
9133
|
+
canInitiate: true
|
|
9134
|
+
sessionStartedCallbackExample:
|
|
9135
|
+
summary: An example of a session-started callback body.
|
|
9136
|
+
value:
|
|
9137
|
+
type: session-started
|
|
9138
|
+
time: '2026-08-06T10:00:00.123000Z'
|
|
9139
|
+
description: Message is now part of an RCS interactive session.
|
|
9140
|
+
to: '+12345678902'
|
|
9141
|
+
message:
|
|
9142
|
+
id: 1786010395000kw2fuqty55yp2b2
|
|
9143
|
+
owner: BandwidthRBM
|
|
9144
|
+
applicationId: 93de2206-9669-4e07-948d-329f4b722ee2
|
|
9145
|
+
time: '2026-08-06T10:00:00.120000Z'
|
|
9146
|
+
segmentCount: 1
|
|
9147
|
+
direction: out
|
|
9148
|
+
to:
|
|
9149
|
+
- '+12345678902'
|
|
9150
|
+
from: BandwidthRBM
|
|
9151
|
+
text: ''
|
|
9152
|
+
tag: ''
|
|
9153
|
+
channel: RBM
|
|
9154
|
+
session:
|
|
9155
|
+
canInitiate: false
|
|
9156
|
+
id: 0f5a3b9c-2d4e-4f6a-8b1c-7e9d0a2b3c4d
|
|
9157
|
+
type: INTERACTIVE_SESSION
|
|
9158
|
+
startTime: '2026-08-06T09:59:55Z'
|
|
9159
|
+
endTime: '2026-08-07T09:59:55Z'
|
|
8937
9160
|
messageFailedCallbackExample:
|
|
8938
9161
|
summary: An example of a message-failed callback body.
|
|
8939
9162
|
value:
|
|
@@ -8965,8 +9188,7 @@ components:
|
|
|
8965
9188
|
to: '+19195551234'
|
|
8966
9189
|
from: '+19195554312'
|
|
8967
9190
|
enqueuedTime: '2022-06-16T13:15:07.160Z'
|
|
8968
|
-
callUrl:
|
|
8969
|
-
https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
|
|
9191
|
+
callUrl: https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
|
|
8970
9192
|
callTimeout: 30
|
|
8971
9193
|
callbackTimeout: 15
|
|
8972
9194
|
tag: My custom tag value
|
|
@@ -9058,14 +9280,12 @@ components:
|
|
|
9058
9280
|
summary: Numbers Lookup Accepted
|
|
9059
9281
|
value:
|
|
9060
9282
|
links:
|
|
9061
|
-
- href:
|
|
9062
|
-
/accounts/9912345/phoneNumberLookup/bulk/004223a0-8b17-41b1-bf81-20732adf5590
|
|
9283
|
+
- href: /accounts/9912345/phoneNumberLookup/bulk/004223a0-8b17-41b1-bf81-20732adf5590
|
|
9063
9284
|
rel: createdRequest
|
|
9064
9285
|
method: GET
|
|
9065
9286
|
data:
|
|
9066
9287
|
requestId: 004223a0-8b17-41b1-bf81-20732adf5590
|
|
9067
9288
|
status: IN_PROGRESS
|
|
9068
|
-
results: []
|
|
9069
9289
|
errors: []
|
|
9070
9290
|
lookupInProgressExample:
|
|
9071
9291
|
summary: Numbers Lookup In Progress
|
|
@@ -9238,7 +9458,8 @@ components:
|
|
|
9238
9458
|
links: []
|
|
9239
9459
|
data: {}
|
|
9240
9460
|
errors:
|
|
9241
|
-
-
|
|
9461
|
+
- code: '1234'
|
|
9462
|
+
type: bad-request
|
|
9242
9463
|
description: >-
|
|
9243
9464
|
Bad Request. Ensure that you have set the requestId as a URL path
|
|
9244
9465
|
parameter.
|
|
@@ -9251,7 +9472,6 @@ components:
|
|
|
9251
9472
|
- type: Unauthorized
|
|
9252
9473
|
description: You are not authorized to access this resource.
|
|
9253
9474
|
code: '1'
|
|
9254
|
-
page: null
|
|
9255
9475
|
forbiddenExample:
|
|
9256
9476
|
summary: Forbidden Error
|
|
9257
9477
|
value:
|
|
@@ -9261,14 +9481,14 @@ components:
|
|
|
9261
9481
|
- type: Forbidden
|
|
9262
9482
|
description: You do not have permission to access this resource.
|
|
9263
9483
|
code: '2'
|
|
9264
|
-
page: null
|
|
9265
9484
|
unsupportedMediaTypeExample:
|
|
9266
9485
|
summary: Unsupported Media Type Error
|
|
9267
9486
|
value:
|
|
9268
9487
|
links: []
|
|
9269
9488
|
data: {}
|
|
9270
9489
|
errors:
|
|
9271
|
-
-
|
|
9490
|
+
- code: '1234'
|
|
9491
|
+
type: invalid-content-type
|
|
9272
9492
|
description: >-
|
|
9273
9493
|
Invalid content-type. Ensure that your content-type header is set
|
|
9274
9494
|
to application/json.
|
|
@@ -9278,7 +9498,8 @@ components:
|
|
|
9278
9498
|
links: []
|
|
9279
9499
|
data: {}
|
|
9280
9500
|
errors:
|
|
9281
|
-
-
|
|
9501
|
+
- code: '1234'
|
|
9502
|
+
type: not-found
|
|
9282
9503
|
description: >-
|
|
9283
9504
|
RequestId not found. Ensure that the requestId used in the URL
|
|
9284
9505
|
path is valid and maps to a previous request that was submitted.
|
|
@@ -9288,7 +9509,8 @@ components:
|
|
|
9288
9509
|
links: []
|
|
9289
9510
|
data: {}
|
|
9290
9511
|
errors:
|
|
9291
|
-
-
|
|
9512
|
+
- code: '1234'
|
|
9513
|
+
type: rate-limiting
|
|
9292
9514
|
description: >-
|
|
9293
9515
|
Rate limit exceeded. Wait for the time specified in the
|
|
9294
9516
|
Retry-After header before sending another request.
|
|
@@ -9308,12 +9530,10 @@ components:
|
|
|
9308
9530
|
summary: List Endpoints Paginated Response
|
|
9309
9531
|
value:
|
|
9310
9532
|
links:
|
|
9311
|
-
- href:
|
|
9312
|
-
https://api.bandwidth.com/v2/accounts/5500123/endpoints?type=SIP&status=CONNECTED&limit=2
|
|
9533
|
+
- href: https://api.bandwidth.com/v2/accounts/5500123/endpoints?type=SIP&status=CONNECTED&limit=2
|
|
9313
9534
|
rel: self
|
|
9314
9535
|
method: GET
|
|
9315
|
-
- href:
|
|
9316
|
-
https://api.bandwidth.com/v2/accounts/5500123/endpoints?type=SIP&status=CONNECTED&limit=2&afterCursor=TWF5IHRoZSBmb3JjZSBiZSB3aXRoIHlvdQ==
|
|
9536
|
+
- href: https://api.bandwidth.com/v2/accounts/5500123/endpoints?type=SIP&status=CONNECTED&limit=2&afterCursor=TWF5IHRoZSBmb3JjZSBiZSB3aXRoIHlvdQ==
|
|
9317
9537
|
rel: next
|
|
9318
9538
|
method: GET
|
|
9319
9539
|
page:
|
|
@@ -9339,8 +9559,7 @@ components:
|
|
|
9339
9559
|
summary: Create Endpoint Response
|
|
9340
9560
|
value:
|
|
9341
9561
|
links:
|
|
9342
|
-
- href:
|
|
9343
|
-
https://api.bandwidth.com/v2/accounts/5500123/endpoints/e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
|
|
9562
|
+
- href: https://api.bandwidth.com/v2/accounts/5500123/endpoints/e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
|
|
9344
9563
|
rel: endpoint
|
|
9345
9564
|
method: GET
|
|
9346
9565
|
data:
|
|
@@ -9357,8 +9576,7 @@ components:
|
|
|
9357
9576
|
summary: Get Endpoint Response
|
|
9358
9577
|
value:
|
|
9359
9578
|
links:
|
|
9360
|
-
- href:
|
|
9361
|
-
https://api.bandwidth.com/v2/accounts/5500123/endpoints/e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
|
|
9579
|
+
- href: https://api.bandwidth.com/v2/accounts/5500123/endpoints/e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
|
|
9362
9580
|
rel: self
|
|
9363
9581
|
method: GET
|
|
9364
9582
|
data:
|
|
@@ -9884,24 +10102,6 @@ components:
|
|
|
9884
10102
|
examples:
|
|
9885
10103
|
updateEndpointBxmlRequestExample:
|
|
9886
10104
|
$ref: '#/components/examples/updateEndpointBxmlRequestExample'
|
|
9887
|
-
securitySchemes:
|
|
9888
|
-
Basic:
|
|
9889
|
-
type: http
|
|
9890
|
-
scheme: basic
|
|
9891
|
-
description: >-
|
|
9892
|
-
Basic authentication is a simple authentication scheme built into the
|
|
9893
|
-
HTTP protocol. To use it, send your HTTP requests with an
|
|
9894
|
-
`Authorization` header that contains the word `Basic` followed by a
|
|
9895
|
-
space and a Base64-encoded string `username:password`.
|
|
9896
|
-
|
|
9897
|
-
|
|
9898
|
-
- Example: `Authorization: Basic ZGVtbZpwQDU1dzByZA==`
|
|
9899
|
-
OAuth2:
|
|
9900
|
-
type: oauth2
|
|
9901
|
-
flows:
|
|
9902
|
-
clientCredentials:
|
|
9903
|
-
tokenUrl: https://api.bandwidth.com/api/v1/oauth2/token
|
|
9904
|
-
scopes: {}
|
|
9905
10105
|
callbacks:
|
|
9906
10106
|
inboundCallback:
|
|
9907
10107
|
'{inboundCallbackUrl}':
|
|
@@ -9937,6 +10137,8 @@ components:
|
|
|
9937
10137
|
$ref: '#/components/examples/smsMessageReceivedCallbackExample'
|
|
9938
10138
|
mmsMessageReceivedCallback:
|
|
9939
10139
|
$ref: '#/components/examples/mmsMessageReceivedCallbackExample'
|
|
10140
|
+
rbmMessageReceivedSessionCallback:
|
|
10141
|
+
$ref: '#/components/examples/rbmMessageReceivedSessionCallbackExample'
|
|
9940
10142
|
responses:
|
|
9941
10143
|
'200':
|
|
9942
10144
|
description: OK
|
|
@@ -9952,8 +10154,9 @@ components:
|
|
|
9952
10154
|
information regarding a message sent (MT)
|
|
9953
10155
|
|
|
9954
10156
|
from your message-enabled Bandwidth telephone number.
|
|
9955
|
-
<p>The payload type will be one of <code>message-sending</code>, <code>message-sent</code>, <code>message-delivered</code>, <code>message-failed</code> or <code>
|
|
9956
|
-
<p>Note that <code>message-read</code> callbacks are pertinent only for RBM messages sent from the <code>/messages/multiChannel</code> endpoint.
|
|
10157
|
+
<p>The payload type will be one of <code>message-sending</code>, <code>message-sent</code>, <code>message-delivered</code>, <code>message-failed</code>, <code>message-read</code> or <code>session-started</code>.
|
|
10158
|
+
<p>Note that <code>message-read</code> and <code>session-started</code> callbacks are pertinent only for RBM messages sent from the <code>/messages/multiChannel</code> endpoint.
|
|
10159
|
+
<p>Note that <code>session-started</code> callbacks are pertinent only for RBM messages of agents with the Conversational billing category.
|
|
9957
10160
|
</p><p>Please visit <a
|
|
9958
10161
|
href='/docs/messaging/webhooks/'>Webhooks</a></p>
|
|
9959
10162
|
content:
|
|
@@ -9970,10 +10173,15 @@ components:
|
|
|
9970
10173
|
mmsMessageDeliveredCallback:
|
|
9971
10174
|
$ref: '#/components/examples/mmsMessageDeliveredCallbackExample'
|
|
9972
10175
|
groupMmsMessageDeliveredCallback:
|
|
9973
|
-
$ref:
|
|
9974
|
-
|
|
10176
|
+
$ref: '#/components/examples/groupMmsMessageDeliveredCallbackExample'
|
|
10177
|
+
rbmMessageDeliveredSessionCallback:
|
|
10178
|
+
$ref: '#/components/examples/rbmMessageDeliveredSessionCallbackExample'
|
|
10179
|
+
rbmMessageDeliveredCanInitiateSessionCallback:
|
|
10180
|
+
$ref: '#/components/examples/rbmMessageDeliveredCanInitiateSessionCallbackExample'
|
|
9975
10181
|
messageFailedCallback:
|
|
9976
10182
|
$ref: '#/components/examples/messageFailedCallbackExample'
|
|
10183
|
+
sessionStartedCallback:
|
|
10184
|
+
$ref: '#/components/examples/sessionStartedCallbackExample'
|
|
9977
10185
|
responses:
|
|
9978
10186
|
'200':
|
|
9979
10187
|
description: OK
|
|
@@ -10033,3 +10241,14 @@ components:
|
|
|
10033
10241
|
responses:
|
|
10034
10242
|
'204':
|
|
10035
10243
|
description: Event was successfully received.
|
|
10244
|
+
securitySchemes:
|
|
10245
|
+
OAuth2:
|
|
10246
|
+
type: oauth2
|
|
10247
|
+
description: >-
|
|
10248
|
+
OAuth2 client credentials. For information on obtaining credentials, see
|
|
10249
|
+
[Credentials
|
|
10250
|
+
Management](https://dev.bandwidth.com/docs/account/credentials/management/).
|
|
10251
|
+
flows:
|
|
10252
|
+
clientCredentials:
|
|
10253
|
+
tokenUrl: https://api.bandwidth.com/api/v1/oauth2/token
|
|
10254
|
+
scopes: {}
|