Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ docs/AnswerCallback.md
docs/BlockedWebhook.md
docs/BridgeCompleteCallback.md
docs/BridgeTargetCompleteCallback.md
docs/BusinessEntityTypeEnum.md
docs/BusinessRegistrationTypeEnum.md
docs/CallDirectionEnum.md
docs/CallRecordingMetadata.md
docs/CallState.md
Expand Down Expand Up @@ -111,6 +113,7 @@ docs/OptInWorkflow.md
docs/PageInfo.md
docs/PhoneNumberLookupApi.md
docs/PriorityEnum.md
docs/ProductTypeEnum.md
docs/RbmActionBase.md
docs/RbmActionDial.md
docs/RbmActionOpenUrl.md
Expand Down Expand Up @@ -186,6 +189,8 @@ models/answer-callback.ts
models/blocked-webhook.ts
models/bridge-complete-callback.ts
models/bridge-target-complete-callback.ts
models/business-entity-type-enum.ts
models/business-registration-type-enum.ts
models/call-direction-enum.ts
models/call-recording-metadata.ts
models/call-state-enum.ts
Expand Down Expand Up @@ -269,6 +274,7 @@ models/multi-channel-message-response-data.ts
models/opt-in-workflow.ts
models/page-info.ts
models/priority-enum.ts
models/product-type-enum.ts
models/rbm-action-base.ts
models/rbm-action-dial.ts
models/rbm-action-open-url.ts
Expand Down
112 changes: 105 additions & 7 deletions api/messages-api.ts

Large diffs are not rendered by default.

254 changes: 254 additions & 0 deletions bandwidth.yml
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,18 @@ paths:
- $ref: '#/components/parameters/fromDateTime'
- $ref: '#/components/parameters/toDateTime'
- $ref: '#/components/parameters/campaignId'
- $ref: '#/components/parameters/fromBwLatency'
- $ref: '#/components/parameters/bwQueued'
- $ref: '#/components/parameters/product'
- $ref: '#/components/parameters/location'
- $ref: '#/components/parameters/carrierQueued'
- $ref: '#/components/parameters/fromCarrierLatency'
- $ref: '#/components/parameters/callingNumberCountryA3'
- $ref: '#/components/parameters/calledNumberCountryA3'
- $ref: '#/components/parameters/fromSegmentCount'
- $ref: '#/components/parameters/toSegmentCount'
- $ref: '#/components/parameters/fromMessageSize'
- $ref: '#/components/parameters/toMessageSize'
- $ref: '#/components/parameters/sort'
- $ref: '#/components/parameters/pageToken'
- $ref: '#/components/parameters/limit'
Expand Down Expand Up @@ -1716,7 +1728,22 @@ components:
enum:
- sms
- mms
- rcs
example: sms
productTypeEnum:
type: string
description: The type of product associated with the message.
enum:
- LOCAL_A2P
- P2P
- SHORT_CODE_REACH
- TOLL_FREE
- HOSTED_SHORT_CODE
- ALPHA_NUMERIC
- RBM_MEDIA
- RBM_RICH
- RBM_CONVERSATIONAL
example: P2P
fieldError:
type: object
properties:
Expand Down Expand Up @@ -1819,6 +1846,41 @@ components:
description: The campaign ID of the message if it has one.
nullable: true
example: CJEUMDK
bwLatency:
type: integer
description: >-
The Bandwidth latency of the message in seconds. Only available for
accounts with the Advanced Quality Metrics feature enabled.
nullable: true
example: 20
carrierLatency:
type: integer
description: >-
The carrier latency of the message in seconds. Only available for
OUTBOUND messages from accounts with the Advanced Quality Metrics
feature enabled.
nullable: true
example: 20
callingNumberCountryA3:
type: string
description: The A3 country code of the calling number.
nullable: true
example: USA
calledNumberCountryA3:
type: string
description: The A3 country code of the called number.
nullable: true
example: USA
product:
type: string
description: The messaging product associated with the message.
nullable: true
example: P2P
location:
type: string
description: The location ID associated with this message.
nullable: true
example: 123ID
pageInfo:
title: PageInfo
type: object
Expand Down Expand Up @@ -5478,6 +5540,50 @@ components:
description: The company 'Doing Business As'.
example: Another Company Name Inc.
type: string
businessRegistrationNumber:
type: string
description: >-
US Federal Tax ID Number (EIN) or Canada Business Number (CBN). Optional
until early 2026. If a value is provided for this field, a value must be
provided for `businessRegistrationType` and `businessEntityType`.
Available starting October 1st, 2025.
nullable: true
maxLength: 500
example: 12-3456789
businessRegistrationTypeEnum:
type: string
description: >-
The type of business registration number. Optional until early 2026;
required if `businessRegistrationNumber` is provided. Available starting
October 1st, 2025.
enum:
- EIN
- CBN
nullable: true
businessEntityTypeEnum:
type: string
description: >-
The type of registered business. If no option is applicable, please
provide "SOLE_PROPRIETOR" as a value. Optional until early 2026;
required if `businessRegistrationNumber` is provided. Available starting
October 1st, 2025.
enum:
- SOLE_PROPRIETOR
- PRIVATE_PROFIT
- PUBLIC_PROFIT
- NON_PROFIT
- GOVERNMENT
nullable: true
helpMessageResponse:
type: string
description: A message that gets sent to users requesting help.
nullable: true
maxLength: 500
example: Please contact support for assistance.
ageGatedContent:
type: boolean
description: Indicates whether the content is age-gated.
example: false
additionalDenialReason:
properties:
statusCode:
Expand Down Expand Up @@ -5564,6 +5670,16 @@ components:
$ref: '#/components/schemas/termsAndConditionsUrl'
businessDba:
$ref: '#/components/schemas/businessDba'
businessRegistrationNumber:
$ref: '#/components/schemas/businessRegistrationNumber'
businessRegistrationType:
$ref: '#/components/schemas/businessRegistrationTypeEnum'
businessEntityType:
$ref: '#/components/schemas/businessEntityTypeEnum'
helpMessageResponse:
$ref: '#/components/schemas/helpMessageResponse'
ageGatedContent:
$ref: '#/components/schemas/ageGatedContent'
verificationUpdateRequest:
type: object
required:
Expand Down Expand Up @@ -5603,6 +5719,16 @@ components:
$ref: '#/components/schemas/termsAndConditionsUrl'
businessDba:
$ref: '#/components/schemas/businessDba'
businessRegistrationNumber:
$ref: '#/components/schemas/businessRegistrationNumber'
businessRegistrationType:
$ref: '#/components/schemas/businessRegistrationTypeEnum'
businessEntityType:
$ref: '#/components/schemas/businessEntityTypeEnum'
helpMessageResponse:
$ref: '#/components/schemas/helpMessageResponse'
ageGatedContent:
$ref: '#/components/schemas/ageGatedContent'
tfvBasicAuthentication:
type: object
properties:
Expand Down Expand Up @@ -5806,6 +5932,12 @@ components:
example: https://www.example.com/path/to/resource
pattern: >-
^$|(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,253}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#()?&//=]*)
confirmationResponse:
type: string
minLength: 0
maxLength: 500
nullable: true
example: Thank you for opting in!
isvReseller:
type: string
description: ISV name.
Expand Down Expand Up @@ -6079,6 +6211,22 @@ components:
$ref: '#/components/schemas/termsAndConditionsUrl'
businessDba:
$ref: '#/components/schemas/businessDba'
businessRegistrationNumber:
$ref: '#/components/schemas/businessRegistrationNumber'
description: >-
US Federal Tax ID Number (EIN) or Canada Business Number (CBN).
Available starting October 1st, 2025.
businessRegistrationType:
$ref: '#/components/schemas/businessRegistrationTypeEnum'
description: >-
The type of business registration number. Available starting October
1st, 2025.
businessEntityType:
$ref: '#/components/schemas/businessEntityTypeEnum'
description: >-
The type of registered business. If no option is applicable, please
provide "SOLE_PROPRIETOR" as a value. Available starting October
1st, 2025.
tfvStatusEnum:
type: string
enum:
Expand Down Expand Up @@ -6940,6 +7088,112 @@ components:
example: CJEUMDK
schema:
type: string
fromBwLatency:
in: query
name: fromBwLatency
required: false
description: >-
The minimum Bandwidth latency of the message in seconds. Only available
for accounts with the Advanced Quality Metrics feature enabled.
example: 5
schema:
type: integer
bwQueued:
in: query
name: bwQueued
required: false
description: >-
A boolean value indicating whether the message is queued in the
Bandwidth network.
example: true
schema:
type: boolean
product:
in: query
name: product
required: false
description: Messaging product associated with the message.
example: P2P
schema:
$ref: '#/components/schemas/productTypeEnum'
location:
in: query
name: location
required: false
description: Location Id associated with the message.
example: 123ABC
schema:
type: string
carrierQueued:
in: query
name: carrierQueued
required: false
description: >-
A boolean value indicating whether the message is queued in the carrier
network. Only available for OUTBOUND messages from accounts with the
Advanced Quality Metrics feature enabled.
example: true
schema:
type: boolean
fromCarrierLatency:
in: query
name: fromCarrierLatency
required: false
description: >-
The minimum carrier latency of the message in seconds. Only available
for OUTBOUND messages from accounts with the Advanced Quality Metrics
feature enabled.
example: 50
schema:
type: integer
callingNumberCountryA3:
in: query
name: callingNumberCountryA3
required: false
description: Calling number country in A3 format.
example: USA
schema:
type: string
calledNumberCountryA3:
in: query
name: calledNumberCountryA3
required: false
description: Called number country in A3 format.
example: USA
schema:
type: string
fromSegmentCount:
in: query
name: fromSegmentCount
required: false
description: Segment count (start range).
example: 1
schema:
type: integer
toSegmentCount:
in: query
name: toSegmentCount
required: false
description: Segment count (end range).
example: 3
schema:
type: integer
fromMessageSize:
in: query
name: fromMessageSize
required: false
description: Message size (start range).
example: 100
schema:
type: integer
toMessageSize:
in: query
name: toMessageSize
required: false
description: Message size (end range).
example: 120
schema:
type: integer
sort:
in: query
name: sort
Expand Down
17 changes: 17 additions & 0 deletions docs/BusinessEntityTypeEnum.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# BusinessEntityTypeEnum

The type of registered business. If no option is applicable, please provide \"SOLE_PROPRIETOR\" as a value. Optional until early 2026; required if `businessRegistrationNumber` is provided. Available starting October 1st, 2025.

## Enum

* `SoleProprietor` (value: `'SOLE_PROPRIETOR'`)

* `PrivateProfit` (value: `'PRIVATE_PROFIT'`)

* `PublicProfit` (value: `'PUBLIC_PROFIT'`)

* `NonProfit` (value: `'NON_PROFIT'`)

* `Government` (value: `'GOVERNMENT'`)

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11 changes: 11 additions & 0 deletions docs/BusinessRegistrationTypeEnum.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# BusinessRegistrationTypeEnum

The type of business registration number. Optional until early 2026; required if `businessRegistrationNumber` is provided. Available starting October 1st, 2025.

## Enum

* `Ein` (value: `'EIN'`)

* `Cbn` (value: `'CBN'`)

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
Loading