@@ -559,6 +559,28 @@ paths:
559
559
schema:
560
560
type: string
561
561
style: form
562
+ - description: A boolean value indicating whether the message is queued in the
563
+ carrier network. Only available for OUTBOUND messages from accounts with
564
+ the Advanced Quality Metrics feature enabled.
565
+ example: true
566
+ explode: true
567
+ in: query
568
+ name: carrierQueued
569
+ required: false
570
+ schema:
571
+ type: boolean
572
+ style: form
573
+ - description: The minimum carrier latency of the message in seconds. Only available
574
+ for OUTBOUND messages from accounts with the Advanced Quality Metrics feature
575
+ enabled.
576
+ example: 50
577
+ explode: true
578
+ in: query
579
+ name: fromCarrierLatency
580
+ required: false
581
+ schema:
582
+ type: integer
583
+ style: form
562
584
- description: Calling number country in A3 format.
563
585
example: USA
564
586
explode: true
@@ -6493,6 +6515,30 @@ components:
6493
6515
schema:
6494
6516
type: string
6495
6517
style: form
6518
+ carrierQueued:
6519
+ description: A boolean value indicating whether the message is queued in the
6520
+ carrier network. Only available for OUTBOUND messages from accounts with the
6521
+ Advanced Quality Metrics feature enabled.
6522
+ example: true
6523
+ explode: true
6524
+ in: query
6525
+ name: carrierQueued
6526
+ required: false
6527
+ schema:
6528
+ type: boolean
6529
+ style: form
6530
+ fromCarrierLatency:
6531
+ description: The minimum carrier latency of the message in seconds. Only available
6532
+ for OUTBOUND messages from accounts with the Advanced Quality Metrics feature
6533
+ enabled.
6534
+ example: 50
6535
+ explode: true
6536
+ in: query
6537
+ name: fromCarrierLatency
6538
+ required: false
6539
+ schema:
6540
+ type: integer
6541
+ style: form
6496
6542
callingNumberCountryA3:
6497
6543
description: Calling number country in A3 format.
6498
6544
example: USA
@@ -7957,6 +8003,7 @@ components:
7957
8003
receiveTime: 2020-04-07T14:03:07Z
7958
8004
accountId: "9900000"
7959
8005
messageDirection: INBOUND
8006
+ carrierLatency: 20
7960
8007
messageType: sms
7961
8008
carrierName: other
7962
8009
recipientCount: 1
@@ -7979,6 +8026,7 @@ components:
7979
8026
receiveTime: 2020-04-07T14:03:07Z
7980
8027
accountId: "9900000"
7981
8028
messageDirection: INBOUND
8029
+ carrierLatency: 20
7982
8030
messageType: sms
7983
8031
carrierName: other
7984
8032
recipientCount: 1
@@ -8018,6 +8066,7 @@ components:
8018
8066
receiveTime: 2020-04-07T14:03:07Z
8019
8067
accountId: "9900000"
8020
8068
messageDirection: INBOUND
8069
+ carrierLatency: 20
8021
8070
messageType: sms
8022
8071
carrierName: other
8023
8072
recipientCount: 1
@@ -8104,6 +8153,13 @@ components:
8104
8153
example: 20
8105
8154
nullable: true
8106
8155
type: integer
8156
+ carrierLatency:
8157
+ description: The carrier latency of the message in seconds. Only available
8158
+ for OUTBOUND messages from accounts with the Advanced Quality Metrics
8159
+ feature enabled.
8160
+ example: 20
8161
+ nullable: true
8162
+ type: integer
8107
8163
callingNumberCountryA3:
8108
8164
description: The A3 country code of the calling number.
8109
8165
example: USA
@@ -13192,6 +13248,47 @@ components:
13192
13248
description: The company 'Doing Business As'.
13193
13249
example: Another Company Name Inc.
13194
13250
type: string
13251
+ businessRegistrationNumber:
13252
+ description: "US Federal Tax ID Number (EIN) or Canada Business Number (CBN).\
13253
+ \ Optional until early 2026. If a value is provided for this field, a value\
13254
+ \ must be provided for `businessRegistrationType` and `businessEntityType`.\
13255
+ \ Available starting October 1st, 2025."
13256
+ example: 12-3456789
13257
+ maxLength: 500
13258
+ nullable: true
13259
+ type: string
13260
+ businessRegistrationTypeEnum:
13261
+ description: "The type of business registration number. Optional until early\
13262
+ \ 2026; required if `businessRegistrationNumber` is provided. Available starting\
13263
+ \ October 1st, 2025."
13264
+ enum:
13265
+ - EIN
13266
+ - CBN
13267
+ nullable: true
13268
+ type: string
13269
+ businessEntityTypeEnum:
13270
+ description: "The type of registered business. If no option is applicable, please\
13271
+ \ provide \"SOLE_PROPRIETOR\" as a value. Optional until early 2026; required\
13272
+ \ if `businessRegistrationNumber` is provided. Available starting October\
13273
+ \ 1st, 2025."
13274
+ enum:
13275
+ - SOLE_PROPRIETOR
13276
+ - PRIVATE_PROFIT
13277
+ - PUBLIC_PROFIT
13278
+ - NON_PROFIT
13279
+ - GOVERNMENT
13280
+ nullable: true
13281
+ type: string
13282
+ helpMessageResponse:
13283
+ description: A message that gets sent to users requesting help.
13284
+ example: Please contact support for assistance.
13285
+ maxLength: 500
13286
+ nullable: true
13287
+ type: string
13288
+ ageGatedContent:
13289
+ description: Indicates whether the content is age-gated.
13290
+ example: false
13291
+ type: boolean
13195
13292
additionalDenialReason:
13196
13293
properties:
13197
13294
statusCode:
@@ -13300,6 +13397,29 @@ components:
13300
13397
description: The company 'Doing Business As'.
13301
13398
example: Another Company Name Inc.
13302
13399
type: string
13400
+ businessRegistrationNumber:
13401
+ description: "US Federal Tax ID Number (EIN) or Canada Business Number (CBN).\
13402
+ \ Optional until early 2026. If a value is provided for this field, a\
13403
+ \ value must be provided for `businessRegistrationType` and `businessEntityType`.\
13404
+ \ Available starting October 1st, 2025."
13405
+ example: 12-3456789
13406
+ maxLength: 500
13407
+ nullable: true
13408
+ type: string
13409
+ businessRegistrationType:
13410
+ $ref: '#/components/schemas/businessRegistrationTypeEnum'
13411
+ businessEntityType:
13412
+ $ref: '#/components/schemas/businessEntityTypeEnum'
13413
+ helpMessageResponse:
13414
+ description: A message that gets sent to users requesting help.
13415
+ example: Please contact support for assistance.
13416
+ maxLength: 500
13417
+ nullable: true
13418
+ type: string
13419
+ ageGatedContent:
13420
+ description: Indicates whether the content is age-gated.
13421
+ example: false
13422
+ type: boolean
13303
13423
required:
13304
13424
- businessAddress
13305
13425
- businessContact
@@ -13371,6 +13491,29 @@ components:
13371
13491
description: The company 'Doing Business As'.
13372
13492
example: Another Company Name Inc.
13373
13493
type: string
13494
+ businessRegistrationNumber:
13495
+ description: "US Federal Tax ID Number (EIN) or Canada Business Number (CBN).\
13496
+ \ Optional until early 2026. If a value is provided for this field, a\
13497
+ \ value must be provided for `businessRegistrationType` and `businessEntityType`.\
13498
+ \ Available starting October 1st, 2025."
13499
+ example: 12-3456789
13500
+ maxLength: 500
13501
+ nullable: true
13502
+ type: string
13503
+ businessRegistrationType:
13504
+ $ref: '#/components/schemas/businessRegistrationTypeEnum'
13505
+ businessEntityType:
13506
+ $ref: '#/components/schemas/businessEntityTypeEnum'
13507
+ helpMessageResponse:
13508
+ description: A message that gets sent to users requesting help.
13509
+ example: Please contact support for assistance.
13510
+ maxLength: 500
13511
+ nullable: true
13512
+ type: string
13513
+ ageGatedContent:
13514
+ description: Indicates whether the content is age-gated.
13515
+ example: false
13516
+ type: boolean
13374
13517
required:
13375
13518
- businessAddress
13376
13519
- businessContact
@@ -13665,6 +13808,7 @@ components:
13665
13808
imageUrls:
13666
13809
- https://www.example.com/path/to/resource
13667
13810
- https://www.example.com/path/to/resource
13811
+ confirmationResponse: Thank you for opting in!
13668
13812
description: Opt In Flow
13669
13813
nullable: false
13670
13814
properties:
@@ -13684,6 +13828,12 @@ components:
13684
13828
.[a-z]{2,6}\\b([-a-zA-Z0-9@:%_\\+.~#()?&//=]*)"
13685
13829
type: string
13686
13830
type: array
13831
+ confirmationResponse:
13832
+ example: Thank you for opting in!
13833
+ maxLength: 500
13834
+ minLength: 0
13835
+ nullable: true
13836
+ type: string
13687
13837
required:
13688
13838
- description
13689
13839
- imageUrls
@@ -13994,16 +14144,26 @@ components:
13994
14144
modifiedDateTime: 2021-06-08T06:45:13Z
13995
14145
submission:
13996
14146
additionalInformation: Any additional information
13997
- useCase : 2FA
13998
14147
termsAndConditionsUrl: http://your-company.com/termsAndConditions
13999
14148
businessDba: Another Company Name Inc.
14000
- isvReseller : Test ISV
14001
14149
businessContact:
14002
14150
firstName: John
14003
14151
lastName: Doe
14004
14152
phoneNumber: "+19192654500"
14005
14153
email: foo@bar.com
14006
14154
messageVolume: 10000
14155
+ businessEntityType: SOLE_PROPRIETOR
14156
+ businessRegistrationType: EIN
14157
+ privacyPolicyUrl: http://your-company.com/privacyPolicy
14158
+ optInWorkflow:
14159
+ imageUrls:
14160
+ - https://www.example.com/path/to/resource
14161
+ - https://www.example.com/path/to/resource
14162
+ confirmationResponse: Thank you for opting in!
14163
+ description: Opt In Flow
14164
+ useCase: 2FA
14165
+ isvReseller: Test ISV
14166
+ businessRegistrationNumber: 12-3456789
14007
14167
productionMessageContent: Production message content
14008
14168
businessAddress:
14009
14169
zip: "27606"
@@ -14013,13 +14173,7 @@ components:
14013
14173
name: Bandwidth Inc.
14014
14174
state: NC
14015
14175
url: https://www.example.com/path/to/resource
14016
- privacyPolicyUrl : http://your-company.com/privacyPolicy
14017
14176
useCaseSummary: Text summarizing the use case for the toll-free number
14018
- optInWorkflow :
14019
- imageUrls :
14020
- - https://www.example.com/path/to/resource
14021
- - https://www.example.com/path/to/resource
14022
- description : Opt In Flow
14023
14177
declineReasonDescription: Invalid Information - Can't Validate URL - Website
14024
14178
is not accessible / not available
14025
14179
status: VERIFIED
@@ -14078,16 +14232,26 @@ components:
14078
14232
tfvSubmissionInfo:
14079
14233
example:
14080
14234
additionalInformation: Any additional information
14081
- useCase : 2FA
14082
14235
termsAndConditionsUrl: http://your-company.com/termsAndConditions
14083
14236
businessDba: Another Company Name Inc.
14084
- isvReseller : Test ISV
14085
14237
businessContact:
14086
14238
firstName: John
14087
14239
lastName: Doe
14088
14240
phoneNumber: "+19192654500"
14089
14241
email: foo@bar.com
14090
14242
messageVolume: 10000
14243
+ businessEntityType: SOLE_PROPRIETOR
14244
+ businessRegistrationType: EIN
14245
+ privacyPolicyUrl: http://your-company.com/privacyPolicy
14246
+ optInWorkflow:
14247
+ imageUrls:
14248
+ - https://www.example.com/path/to/resource
14249
+ - https://www.example.com/path/to/resource
14250
+ confirmationResponse: Thank you for opting in!
14251
+ description: Opt In Flow
14252
+ useCase: 2FA
14253
+ isvReseller: Test ISV
14254
+ businessRegistrationNumber: 12-3456789
14091
14255
productionMessageContent: Production message content
14092
14256
businessAddress:
14093
14257
zip: "27606"
@@ -14097,13 +14261,7 @@ components:
14097
14261
name: Bandwidth Inc.
14098
14262
state: NC
14099
14263
url: https://www.example.com/path/to/resource
14100
- privacyPolicyUrl : http://your-company.com/privacyPolicy
14101
14264
useCaseSummary: Text summarizing the use case for the toll-free number
14102
- optInWorkflow :
14103
- imageUrls :
14104
- - https://www.example.com/path/to/resource
14105
- - https://www.example.com/path/to/resource
14106
- description : Opt In Flow
14107
14265
properties:
14108
14266
businessAddress:
14109
14267
$ref: '#/components/schemas/address'
@@ -14164,6 +14322,19 @@ components:
14164
14322
description: The company 'Doing Business As'.
14165
14323
example: Another Company Name Inc.
14166
14324
type: string
14325
+ businessRegistrationNumber:
14326
+ description: "US Federal Tax ID Number (EIN) or Canada Business Number (CBN).\
14327
+ \ Optional until early 2026. If a value is provided for this field, a\
14328
+ \ value must be provided for `businessRegistrationType` and `businessEntityType`.\
14329
+ \ Available starting October 1st, 2025."
14330
+ example: 12-3456789
14331
+ maxLength: 500
14332
+ nullable: true
14333
+ type: string
14334
+ businessRegistrationType:
14335
+ $ref: '#/components/schemas/businessRegistrationTypeEnum'
14336
+ businessEntityType:
14337
+ $ref: '#/components/schemas/businessEntityTypeEnum'
14167
14338
type: object
14168
14339
tfvStatusEnum:
14169
14340
enum:
0 commit comments