@@ -549,6 +549,28 @@ paths:
549549 schema:
550550 type: string
551551 style: form
552+ - description: A boolean value indicating whether the message is queued in the
553+ carrier network. Only available for OUTBOUND messages from accounts with
554+ the Advanced Quality Metrics feature enabled.
555+ example: true
556+ explode: true
557+ in: query
558+ name: carrierQueued
559+ required: false
560+ schema:
561+ type: boolean
562+ style: form
563+ - description: The minimum carrier latency of the message in seconds. Only available
564+ for OUTBOUND messages from accounts with the Advanced Quality Metrics feature
565+ enabled.
566+ example: 50
567+ explode: true
568+ in: query
569+ name: fromCarrierLatency
570+ required: false
571+ schema:
572+ type: integer
573+ style: form
552574 - description: Calling number country in A3 format.
553575 example: USA
554576 explode: true
@@ -6371,6 +6393,30 @@ components:
63716393 schema:
63726394 type: string
63736395 style: form
6396+ carrierQueued:
6397+ description: A boolean value indicating whether the message is queued in the
6398+ carrier network. Only available for OUTBOUND messages from accounts with the
6399+ Advanced Quality Metrics feature enabled.
6400+ example: true
6401+ explode: true
6402+ in: query
6403+ name: carrierQueued
6404+ required: false
6405+ schema:
6406+ type: boolean
6407+ style: form
6408+ fromCarrierLatency:
6409+ description: The minimum carrier latency of the message in seconds. Only available
6410+ for OUTBOUND messages from accounts with the Advanced Quality Metrics feature
6411+ enabled.
6412+ example: 50
6413+ explode: true
6414+ in: query
6415+ name: fromCarrierLatency
6416+ required: false
6417+ schema:
6418+ type: integer
6419+ style: form
63746420 callingNumberCountryA3:
63756421 description: Calling number country in A3 format.
63766422 example: USA
@@ -7835,6 +7881,7 @@ components:
78357881 receiveTime: 2020-04-07T14:03:07Z
78367882 accountId: "9900000"
78377883 messageDirection: INBOUND
7884+ carrierLatency: 20
78387885 messageType: sms
78397886 carrierName: other
78407887 recipientCount: 1
@@ -7857,6 +7904,7 @@ components:
78577904 receiveTime: 2020-04-07T14:03:07Z
78587905 accountId: "9900000"
78597906 messageDirection: INBOUND
7907+ carrierLatency: 20
78607908 messageType: sms
78617909 carrierName: other
78627910 recipientCount: 1
@@ -7896,6 +7944,7 @@ components:
78967944 receiveTime: 2020-04-07T14:03:07Z
78977945 accountId: "9900000"
78987946 messageDirection: INBOUND
7947+ carrierLatency: 20
78997948 messageType: sms
79007949 carrierName: other
79017950 recipientCount: 1
@@ -7982,6 +8031,13 @@ components:
79828031 example: 20
79838032 nullable: true
79848033 type: integer
8034+ carrierLatency:
8035+ description: The carrier latency of the message in seconds. Only available
8036+ for OUTBOUND messages from accounts with the Advanced Quality Metrics
8037+ feature enabled.
8038+ example: 20
8039+ nullable: true
8040+ type: integer
79858041 callingNumberCountryA3:
79868042 description: The A3 country code of the calling number.
79878043 example: USA
@@ -13070,6 +13126,47 @@ components:
1307013126 description: The company 'Doing Business As'.
1307113127 example: Another Company Name Inc.
1307213128 type: string
13129+ businessRegistrationNumber:
13130+ description: "US Federal Tax ID Number (EIN) or Canada Business Number (CBN).\
13131+ \ Optional until early 2026. If a value is provided for this field, a value\
13132+ \ must be provided for `businessRegistrationType` and `businessEntityType`.\
13133+ \ Available starting October 1st, 2025."
13134+ example: 12-3456789
13135+ maxLength: 500
13136+ nullable: true
13137+ type: string
13138+ businessRegistrationTypeEnum:
13139+ description: "The type of business registration number. Optional until early\
13140+ \ 2026; required if `businessRegistrationNumber` is provided. Available starting\
13141+ \ October 1st, 2025."
13142+ enum:
13143+ - EIN
13144+ - CBN
13145+ nullable: true
13146+ type: string
13147+ businessEntityTypeEnum:
13148+ description: "The type of registered business. If no option is applicable, please\
13149+ \ provide \"SOLE_PROPRIETOR\" as a value. Optional until early 2026; required\
13150+ \ if `businessRegistrationNumber` is provided. Available starting October\
13151+ \ 1st, 2025."
13152+ enum:
13153+ - SOLE_PROPRIETOR
13154+ - PRIVATE_PROFIT
13155+ - PUBLIC_PROFIT
13156+ - NON_PROFIT
13157+ - GOVERNMENT
13158+ nullable: true
13159+ type: string
13160+ helpMessageResponse:
13161+ description: A message that gets sent to users requesting help.
13162+ example: Please contact support for assistance.
13163+ maxLength: 500
13164+ nullable: true
13165+ type: string
13166+ ageGatedContent:
13167+ description: Indicates whether the content is age-gated.
13168+ example: false
13169+ type: boolean
1307313170 additionalDenialReason:
1307413171 properties:
1307513172 statusCode:
@@ -13178,6 +13275,29 @@ components:
1317813275 description: The company 'Doing Business As'.
1317913276 example: Another Company Name Inc.
1318013277 type: string
13278+ businessRegistrationNumber:
13279+ description: "US Federal Tax ID Number (EIN) or Canada Business Number (CBN).\
13280+ \ Optional until early 2026. If a value is provided for this field, a\
13281+ \ value must be provided for `businessRegistrationType` and `businessEntityType`.\
13282+ \ Available starting October 1st, 2025."
13283+ example: 12-3456789
13284+ maxLength: 500
13285+ nullable: true
13286+ type: string
13287+ businessRegistrationType:
13288+ $ref: '#/components/schemas/businessRegistrationTypeEnum'
13289+ businessEntityType:
13290+ $ref: '#/components/schemas/businessEntityTypeEnum'
13291+ helpMessageResponse:
13292+ description: A message that gets sent to users requesting help.
13293+ example: Please contact support for assistance.
13294+ maxLength: 500
13295+ nullable: true
13296+ type: string
13297+ ageGatedContent:
13298+ description: Indicates whether the content is age-gated.
13299+ example: false
13300+ type: boolean
1318113301 required:
1318213302 - businessAddress
1318313303 - businessContact
@@ -13249,6 +13369,29 @@ components:
1324913369 description: The company 'Doing Business As'.
1325013370 example: Another Company Name Inc.
1325113371 type: string
13372+ businessRegistrationNumber:
13373+ description: "US Federal Tax ID Number (EIN) or Canada Business Number (CBN).\
13374+ \ Optional until early 2026. If a value is provided for this field, a\
13375+ \ value must be provided for `businessRegistrationType` and `businessEntityType`.\
13376+ \ Available starting October 1st, 2025."
13377+ example: 12-3456789
13378+ maxLength: 500
13379+ nullable: true
13380+ type: string
13381+ businessRegistrationType:
13382+ $ref: '#/components/schemas/businessRegistrationTypeEnum'
13383+ businessEntityType:
13384+ $ref: '#/components/schemas/businessEntityTypeEnum'
13385+ helpMessageResponse:
13386+ description: A message that gets sent to users requesting help.
13387+ example: Please contact support for assistance.
13388+ maxLength: 500
13389+ nullable: true
13390+ type: string
13391+ ageGatedContent:
13392+ description: Indicates whether the content is age-gated.
13393+ example: false
13394+ type: boolean
1325213395 required:
1325313396 - businessAddress
1325413397 - businessContact
@@ -13543,6 +13686,7 @@ components:
1354313686 imageUrls:
1354413687 - https://www.example.com/path/to/resource
1354513688 - https://www.example.com/path/to/resource
13689+ confirmationResponse: Thank you for opting in!
1354613690 description: Opt In Flow
1354713691 nullable: false
1354813692 properties:
@@ -13562,6 +13706,12 @@ components:
1356213706 .[a-z]{2,6}\\b([-a-zA-Z0-9@:%_\\+.~#()?&//=]*)"
1356313707 type: string
1356413708 type: array
13709+ confirmationResponse:
13710+ example: Thank you for opting in!
13711+ maxLength: 500
13712+ minLength: 0
13713+ nullable: true
13714+ type: string
1356513715 required:
1356613716 - description
1356713717 - imageUrls
@@ -13872,16 +14022,26 @@ components:
1387214022 modifiedDateTime: 2021-06-08T06:45:13Z
1387314023 submission:
1387414024 additionalInformation: Any additional information
13875- useCase : 2FA
1387614025 termsAndConditionsUrl: http://your-company.com/termsAndConditions
1387714026 businessDba: Another Company Name Inc.
13878- isvReseller : Test ISV
1387914027 businessContact:
1388014028 firstName: John
1388114029 lastName: Doe
1388214030 phoneNumber: "+19192654500"
13883140311388414032 messageVolume: 10000
14033+ businessEntityType: SOLE_PROPRIETOR
14034+ businessRegistrationType: EIN
14035+ privacyPolicyUrl: http://your-company.com/privacyPolicy
14036+ optInWorkflow:
14037+ imageUrls:
14038+ - https://www.example.com/path/to/resource
14039+ - https://www.example.com/path/to/resource
14040+ confirmationResponse: Thank you for opting in!
14041+ description: Opt In Flow
14042+ useCase: 2FA
14043+ isvReseller: Test ISV
14044+ businessRegistrationNumber: 12-3456789
1388514045 productionMessageContent: Production message content
1388614046 businessAddress:
1388714047 zip: "27606"
@@ -13891,13 +14051,7 @@ components:
1389114051 name: Bandwidth Inc.
1389214052 state: NC
1389314053 url: https://www.example.com/path/to/resource
13894- privacyPolicyUrl : http://your-company.com/privacyPolicy
1389514054 useCaseSummary: Text summarizing the use case for the toll-free number
13896- optInWorkflow :
13897- imageUrls :
13898- - https://www.example.com/path/to/resource
13899- - https://www.example.com/path/to/resource
13900- description : Opt In Flow
1390114055 declineReasonDescription: Invalid Information - Can't Validate URL - Website
1390214056 is not accessible / not available
1390314057 status: VERIFIED
@@ -13956,16 +14110,26 @@ components:
1395614110 tfvSubmissionInfo:
1395714111 example:
1395814112 additionalInformation: Any additional information
13959- useCase : 2FA
1396014113 termsAndConditionsUrl: http://your-company.com/termsAndConditions
1396114114 businessDba: Another Company Name Inc.
13962- isvReseller : Test ISV
1396314115 businessContact:
1396414116 firstName: John
1396514117 lastName: Doe
1396614118 phoneNumber: "+19192654500"
13967141191396814120 messageVolume: 10000
14121+ businessEntityType: SOLE_PROPRIETOR
14122+ businessRegistrationType: EIN
14123+ privacyPolicyUrl: http://your-company.com/privacyPolicy
14124+ optInWorkflow:
14125+ imageUrls:
14126+ - https://www.example.com/path/to/resource
14127+ - https://www.example.com/path/to/resource
14128+ confirmationResponse: Thank you for opting in!
14129+ description: Opt In Flow
14130+ useCase: 2FA
14131+ isvReseller: Test ISV
14132+ businessRegistrationNumber: 12-3456789
1396914133 productionMessageContent: Production message content
1397014134 businessAddress:
1397114135 zip: "27606"
@@ -13975,13 +14139,7 @@ components:
1397514139 name: Bandwidth Inc.
1397614140 state: NC
1397714141 url: https://www.example.com/path/to/resource
13978- privacyPolicyUrl : http://your-company.com/privacyPolicy
1397914142 useCaseSummary: Text summarizing the use case for the toll-free number
13980- optInWorkflow :
13981- imageUrls :
13982- - https://www.example.com/path/to/resource
13983- - https://www.example.com/path/to/resource
13984- description : Opt In Flow
1398514143 properties:
1398614144 businessAddress:
1398714145 $ref: '#/components/schemas/address'
@@ -14042,6 +14200,19 @@ components:
1404214200 description: The company 'Doing Business As'.
1404314201 example: Another Company Name Inc.
1404414202 type: string
14203+ businessRegistrationNumber:
14204+ description: "US Federal Tax ID Number (EIN) or Canada Business Number (CBN).\
14205+ \ Optional until early 2026. If a value is provided for this field, a\
14206+ \ value must be provided for `businessRegistrationType` and `businessEntityType`.\
14207+ \ Available starting October 1st, 2025."
14208+ example: 12-3456789
14209+ maxLength: 500
14210+ nullable: true
14211+ type: string
14212+ businessRegistrationType:
14213+ $ref: '#/components/schemas/businessRegistrationTypeEnum'
14214+ businessEntityType:
14215+ $ref: '#/components/schemas/businessEntityTypeEnum'
1404514216 type: object
1404614217 tfvStatusEnum:
1404714218 enum:
![band-swi-release-engineering[bot]](https://avatars.githubusercontent.com/u/20689391?v=4&size=40){kind=avatar}
0 commit comments