@@ -1042,46 +1042,6 @@ components:
1042
1042
- $ref: '#/components/schemas/failureWebhookRequest'
1043
1043
description: Verification callback status of a toll-free phone number.
1044
1044
required: true
1045
- webhookSubscription:
1046
- content:
1047
- application/json:
1048
- schema:
1049
- properties:
1050
- accountId:
1051
- type: string
1052
- basicAuthentication:
1053
- properties:
1054
- password:
1055
- maxLength: 200
1056
- type: string
1057
- username:
1058
- maxLength: 100
1059
- type: string
1060
- required:
1061
- - username
1062
- - password
1063
- type: object
1064
- callbackUrl:
1065
- $ref: '#/components/schemas/webhookUrl'
1066
- createdDate:
1067
- format: date-time
1068
- type: string
1069
- id:
1070
- type: string
1071
- modifiedDate:
1072
- format: date-time
1073
- type: string
1074
- type:
1075
- enum:
1076
- - TOLLFREE_VERIFICATION_STATUS
1077
- type: string
1078
- required:
1079
- - callbackUrl
1080
- type: object
1081
- description: >-
1082
- Information about a webhook that Bandwidth should send upon the
1083
- completion of TFV verification.
1084
- required: true
1085
1045
webhookSubscriptionRequest:
1086
1046
content:
1087
1047
application/json:
@@ -1108,20 +1068,6 @@ components:
1108
1068
Information about a webhook that Bandwidth should send upon the
1109
1069
completion of TFV verification.
1110
1070
required: true
1111
- webhookSubscriptionsList:
1112
- content:
1113
- application/json:
1114
- schema:
1115
- properties:
1116
- data:
1117
- items:
1118
- $ref: '#/components/requestBodies/webhookSubscription'
1119
- type: array
1120
- type: object
1121
- description: >-
1122
- A list of all webhook subscriptions registered for this account ID for
1123
- this particular feature.
1124
- required: true
1125
1071
zipWhipTfvWebhookRequest:
1126
1072
content:
1127
1073
application/json:
@@ -1390,21 +1336,21 @@ components:
1390
1336
content:
1391
1337
application/json:
1392
1338
schema:
1393
- $ref: '#/components/requestBodies /webhookSubscription'
1339
+ $ref: '#/components/schemas /webhookSubscription'
1394
1340
description: Created
1395
1341
webhookSubscriptionDeleted:
1396
1342
description: Deleted
1397
1343
webhookSubscriptionUpdated:
1398
1344
content:
1399
1345
application/json:
1400
1346
schema:
1401
- $ref: '#/components/requestBodies /webhookSubscription'
1347
+ $ref: '#/components/schemas /webhookSubscription'
1402
1348
description: OK
1403
1349
webhookSubscriptionsList:
1404
1350
content:
1405
1351
application/json:
1406
1352
schema:
1407
- $ref: '#/components/requestBodies/webhookSubscriptionsList '
1353
+ $ref: '#/components/schemas/webhookSubscriptionsListBody '
1408
1354
description: OK
1409
1355
schemas:
1410
1356
A2pClass:
@@ -14409,14 +14355,60 @@ components:
14409
14355
status:
14410
14356
$ref: '#/components/schemas/tfvCallbackStatus'
14411
14357
type: object
14358
+ webhookSubscription:
14359
+ description: >-
14360
+ Information about a webhook that Bandwidth should send upon the
14361
+ completion of TFV verification.
14362
+ properties:
14363
+ accountId:
14364
+ type: string
14365
+ basicAuthentication:
14366
+ properties:
14367
+ password:
14368
+ maxLength: 200
14369
+ type: string
14370
+ username:
14371
+ maxLength: 100
14372
+ type: string
14373
+ required:
14374
+ - username
14375
+ - password
14376
+ type: object
14377
+ callbackUrl:
14378
+ $ref: '#/components/schemas/webhookUrl'
14379
+ createdDate:
14380
+ format: date-time
14381
+ type: string
14382
+ id:
14383
+ type: string
14384
+ modifiedDate:
14385
+ format: date-time
14386
+ type: string
14387
+ type:
14388
+ enum:
14389
+ - TOLLFREE_VERIFICATION_STATUS
14390
+ type: string
14391
+ required:
14392
+ - callbackUrl
14393
+ type: object
14394
+ webhookSubscriptionsListBody:
14395
+ description: >-
14396
+ A list of all webhook subscriptions registered for this account ID for
14397
+ this particular feature.
14398
+ properties:
14399
+ data:
14400
+ items:
14401
+ $ref: '#/components/schemas/webhookSubscription'
14402
+ type: array
14403
+ required:
14404
+ - data
14405
+ type: object
14412
14406
webhookUrl:
14413
14407
description: >-
14414
- Callback URL to receive status updates from Bandwidth. When this value
14415
- is registered with a validation request, it will be used for that
14416
- request (only) and it cannot be updated after submission. To register a
14417
- callback for all status updates, which can be updated through the API,
14418
- register a webhook subscription (which can also include basic
14419
- authentication credentials).
14408
+ Callback URL to receive status updates from Bandwidth. When a webhook
14409
+ subscription is registered with Bandwidth under a given account ID, it
14410
+ will be used to send status updates for all requests submitted under
14411
+ that account ID.
14420
14412
example: https://www.example.com/path/to/resource
14421
14413
maxLength: 2000
14422
14414
minLength: 0
0 commit comments