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
148 changes: 120 additions & 28 deletions api/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4740,6 +4740,10 @@ paths:
$ref: "#/components/examples/lookupCompleteWithDniExample"
lookupCompleteExample:
$ref: "#/components/examples/lookupCompleteExample"
lookupCompleteWithRcsExample:
$ref: "#/components/examples/lookupCompleteWithRcsExample"
lookupCompleteWithRcsErrorExample:
$ref: "#/components/examples/lookupCompleteWithRcsErrorExample"
lookupPartialExample:
$ref: "#/components/examples/lookupPartialExample"
lookupFailedExample:
Expand Down Expand Up @@ -4801,8 +4805,8 @@ paths:
content:
application/json:
examples:
lookupInProgressExample:
$ref: "#/components/examples/lookupInProgressExample"
lookupAcceptedExample:
$ref: "#/components/examples/lookupAcceptedExample"
schema:
$ref: "#/components/schemas/createAsyncBulkLookupResponse"
description: Accepted
Expand Down Expand Up @@ -6220,25 +6224,31 @@ components:
phoneNumbers:
- "+19196104423"
- "+19196104424"
lookupInProgressExample:
summary: Numbers Lookup In Progress
lookupAcceptedExample:
summary: Numbers Lookup Accepted
value:
links:
- href: href
rel: rel
- href: /accounts/9912345/phoneNumberLookup/bulk/004223a0-8b17-41b1-bf81-20732adf5590
rel: createdRequest
method: GET
data:
requestId: 004223a0-8b17-41b1-bf81-20732adf5590
status: IN_PROGRESS
results: []
errors: []
lookupInProgressExample:
summary: Numbers Lookup In Progress
value:
links: []
data:
requestId: 004223a0-8b17-41b1-bf81-20732adf5590
status: IN_PROGRESS
results: []
errors: []
lookupFailedExample:
summary: Numbers Lookup Failed
value:
links:
- href: href
rel: rel
method: GET
links: []
data:
requestId: 004223a0-8b17-41b1-bf81-20732adf5590
status: FAILED
Expand All @@ -6256,10 +6266,7 @@ components:
lookupPartialExample:
summary: Numbers Lookup Partial Complete
value:
links:
- href: href
rel: rel
method: GET
links: []
data:
requestId: 004223a0-8b17-41b1-bf81-20732adf5590
status: PARTIAL_COMPLETE
Expand Down Expand Up @@ -6287,10 +6294,7 @@ components:
lookupCompleteExample:
summary: Numbers Lookup Complete (without DNI)
value:
links:
- href: href
rel: rel
method: GET
links: []
data:
requestId: 004223a0-8b17-41b1-bf81-20732adf5590
status: COMPLETE
Expand All @@ -6309,10 +6313,7 @@ components:
lookupCompleteWithDniExample:
summary: Numbers Lookup Complete (with DNI)
value:
links:
- href: href
rel: rel
method: GET
links: []
data:
requestId: 20732adf-bf81-8b17-41b1-004223a05590
status: COMPLETE
Expand Down Expand Up @@ -6350,6 +6351,58 @@ components:
deactivationEvent: DEACTIVATED
latestMessageDeliveryStatus: NOT_ENABLED
errors: []
lookupCompleteWithRcsExample:
summary: Numbers Lookup Complete (with RCS)
value:
links: []
data:
requestId: 004223a0-8b17-41b1-bf81-20732adf5590
status: COMPLETE
results:
- phoneNumber: "+10072904497"
lineType: MOBILE
messagingProvider: Verizon Wireless
voiceProvider: Verizon Wireless
countryCodeA3: USA
rcsEnabled: true
- phoneNumber: "+10072904498"
lineType: MOBILE
messagingProvider: T-Mobile USA
voiceProvider: T-Mobile USA
countryCodeA3: USA
rcsEnabled: false
errors: []
lookupCompleteWithRcsErrorExample:
summary: Numbers Lookup Complete (with RCS error)
value:
links: []
data:
requestId: 004223a0-8b17-41b1-bf81-20732adf5590
status: COMPLETE
results:
- phoneNumber: "+10072904497"
lineType: MOBILE
messagingProvider: Verizon Wireless
voiceProvider: Verizon Wireless
countryCodeA3: USA
- phoneNumber: "+10072904498"
lineType: MOBILE
messagingProvider: T-Mobile USA
voiceProvider: T-Mobile USA
countryCodeA3: USA
errors:
- code: RCS_SERVICE_UNAVAILABLE
type: rcs-error
description: An exception was thrown during the async RCS service call.
meta:
phoneNumbers:
- "+10072904497"
- code: MISSING_FROM_RESPONSE
type: rcs-error
description: The phone number was absent from the RCS service response.
meta:
phoneNumbers:
- "+10072904498"
badRequestExample:
summary: Example Bad Request Error
value:
Expand Down Expand Up @@ -7847,6 +7900,10 @@ components:
$ref: "#/components/examples/lookupCompleteWithDniExample"
lookupCompleteExample:
$ref: "#/components/examples/lookupCompleteExample"
lookupCompleteWithRcsExample:
$ref: "#/components/examples/lookupCompleteWithRcsExample"
lookupCompleteWithRcsErrorExample:
$ref: "#/components/examples/lookupCompleteWithRcsErrorExample"
lookupPartialExample:
$ref: "#/components/examples/lookupPartialExample"
lookupFailedExample:
Expand All @@ -7858,8 +7915,8 @@ components:
content:
application/json:
examples:
lookupInProgressExample:
$ref: "#/components/examples/lookupInProgressExample"
lookupAcceptedExample:
$ref: "#/components/examples/lookupAcceptedExample"
schema:
$ref: "#/components/schemas/createAsyncBulkLookupResponse"
description: Accepted
Expand Down Expand Up @@ -13374,6 +13431,10 @@ components:
type: string
meta:
$ref: "#/components/schemas/lookupErrorSchema_meta"
required:
- code
- description
- type
type: object
syncLookupRequest:
properties:
Expand Down Expand Up @@ -13413,6 +13474,7 @@ components:
phoneNumber: "+10072904498"
countryCodeA3: USA
initialMessageDeliveryStatusDate: 2025-06-20
rcsEnabled: true
lineType: MOBILE
deactivationReporter: deactivationReporter
voiceProvider: Verizon Wireless
Expand All @@ -13424,6 +13486,7 @@ components:
phoneNumber: "+10072904498"
countryCodeA3: USA
initialMessageDeliveryStatusDate: 2025-06-20
rcsEnabled: true
lineType: MOBILE
deactivationReporter: deactivationReporter
voiceProvider: Verizon Wireless
Expand Down Expand Up @@ -13518,6 +13581,7 @@ components:
phoneNumber: "+10072904498"
countryCodeA3: USA
initialMessageDeliveryStatusDate: 2025-06-20
rcsEnabled: true
lineType: MOBILE
deactivationReporter: deactivationReporter
voiceProvider: Verizon Wireless
Expand All @@ -13529,6 +13593,7 @@ components:
phoneNumber: "+10072904498"
countryCodeA3: USA
initialMessageDeliveryStatusDate: 2025-06-20
rcsEnabled: true
lineType: MOBILE
deactivationReporter: deactivationReporter
voiceProvider: Verizon Wireless
Expand Down Expand Up @@ -13604,6 +13669,23 @@ components:
$ref: "#/components/schemas/lookupErrorSchema"
type: array
type: object
rcsErrorEnum:
description: |-
[RCS-Only](#section/RCS-Only). Error encountered during RCS capability lookup. Appears as the `code` field in the top-level `errors` array.

**RCS service pass-through codes:**
- `REQUEST_FAILED`: The RCS service returned this error code.
- `UNKNOWN_CODE`: The RCS service returned this error code.
- `INVALID_DESTINATION_ADDRESS`: The RCS service returned this error code.
- `UNKNOWN_STATUS: <code>`: The RCS service returned an unrecognized status code, where `<code>` is the raw value.

**Service-level errors:**
- `MISSING_FROM_RESPONSE`: The phone number was absent from the RCS service response.
- `RCS_SERVICE_UNAVAILABLE`: An exception was thrown during the async RCS service call.
- `RCS_SERVICE_DISABLED`: RCS lookup is disabled in configuration.
- `EMPTY_RESPONSE`: The RCS service returned a null or empty response body.
example: RCS_SERVICE_UNAVAILABLE
type: string
lookupResult:
description: Carrier information results for the specified telephone number.
example:
Expand All @@ -13614,6 +13696,7 @@ components:
phoneNumber: "+10072904498"
countryCodeA3: USA
initialMessageDeliveryStatusDate: 2025-06-20
rcsEnabled: true
lineType: MOBILE
deactivationReporter: deactivationReporter
voiceProvider: Verizon Wireless
Expand Down Expand Up @@ -13662,13 +13745,18 @@ components:
format: date
type: string
latestMessageDeliveryStatusDate:
description: "[DNI-Only](#section/DNI-Only). The date bandwidth last received\
\ delivery status information for this phone number. \nUse this field\
\ to understand how up-to-date the `latestMessageDeliveryStatus` is.\n\
Value resets every time the `latestMessageDeliveryStatus` changes."
description: |-
[DNI-Only](#section/DNI-Only). The date bandwidth last received delivery status information for this phone number.
Use this field to understand how up-to-date the `latestMessageDeliveryStatus` is.
Value resets every time the `latestMessageDeliveryStatus` changes.
example: 2025-06-21
format: date
type: string
rcsEnabled:
description: |
[RCS-Only](#section/RCS-Only). Indicates whether the phone number is capable of receiving RCS messages. Value will be null if account has RCS, but no value was returned. Absent when account does not have RCS.
example: true
type: boolean
type: object
accountId1:
description: User's account ID.
Expand Down Expand Up @@ -15010,6 +15098,7 @@ components:
phoneNumber: "+10072904498"
countryCodeA3: USA
initialMessageDeliveryStatusDate: 2025-06-20
rcsEnabled: true
lineType: MOBILE
deactivationReporter: deactivationReporter
voiceProvider: Verizon Wireless
Expand All @@ -15021,6 +15110,7 @@ components:
phoneNumber: "+10072904498"
countryCodeA3: USA
initialMessageDeliveryStatusDate: 2025-06-20
rcsEnabled: true
lineType: MOBILE
deactivationReporter: deactivationReporter
voiceProvider: Verizon Wireless
Expand Down Expand Up @@ -15067,6 +15157,7 @@ components:
phoneNumber: "+10072904498"
countryCodeA3: USA
initialMessageDeliveryStatusDate: 2025-06-20
rcsEnabled: true
lineType: MOBILE
deactivationReporter: deactivationReporter
voiceProvider: Verizon Wireless
Expand All @@ -15078,6 +15169,7 @@ components:
phoneNumber: "+10072904498"
countryCodeA3: USA
initialMessageDeliveryStatusDate: 2025-06-20
rcsEnabled: true
lineType: MOBILE
deactivationReporter: deactivationReporter
voiceProvider: Verizon Wireless
Expand Down
Loading