Verify phone number portability
POST/origination/porting/portability_checks
Verifies the portability of a list of phone numbers.
Example request body
{
"phone_numbers": [
{
"phone_number": "+13125354200"
},
{
"phone_number": "+13125354500"
}
]
}
Request
- application/json
Body
required
List of phone numbers to check portability on
Array [
]
phone_numbers
undefined[]
required
List of phone numbers to check phone numbers
E164 formatted phone number
Responses
201: Portability check response
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
]
]
phone_numbers
undefined[]
required
List of phone numbers to check phone numbers on
The phone number as it was submitted
The phone number parsed into e164 format
Is the number portable?
Possible values: [pending
, confirmed
, provisional
]
Specifies whether Telnyx was able to confirm portability for the rate center for this number
The underlying carrier associated with the phone number
Possible values: [nanp_generic
, nanp_toll_free
, international
, invalid
]
Category of phone number. 'nanp_toll_free' indicates a toll free number on the North American Numbering Plan (NANP). 'nanp_generic' indicates a non toll-free NANP phone number. 'international' indicates a non-NANP phone number.
Possible values: [invalid_phone_number
, lrn_data_not_found
, no_coverage
, already_being_ported
, telnyx_number
]
Reason the phone number is not portable
[
{
"phone_numbers": [
{
"raw_number": "string",
"e164_number": "string",
"portable": true,
"portability_status": "pending",
"carrier_name": "string",
"coverage_category": "nanp_generic",
"non_portable_reason": "invalid_phone_number"
}
]
}
]
401: Unauthorized
422: Unprocessable entity. Check message field in response for details.