This is the API V2 documentation. To switch out of beta revert back to our API V1.

Open SidemenuAPI Reference
API Reference
Close Sidemenu

Phone Number Porting

Run a portability checkpostPortabilityCheck

post https://api.telnyx.com/v2/portability_checks

Runs a portability check, returning the results immediately.

curl -X POST \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --data '{"phone_numbers":["+13035550000","+13035550001","+13035550002"]}' \
  https://api.telnyx.com/v2/portability_checks
Parameters
In body
phone_numbers
array of string
optional

The list of +E.164 formatted phone numbers to check for portability

Example: [ "+13035550000", "+13035550001", "+13035550002" ]
Responses
201

PortabilityCheck Response

401

Unauthorized

422

Unprocessable entity. Check message field in response for details.

Success Response
{
  "data": [
    {
      "fast_portable": true,
      "not_portable_reason": "No coverage",
      "phone_number": "+13125550123",
      "portable": true,
      "record_type": "portability_check_result"
    }
  ]
}
Previous: Number Portout

Was this section helpful?was-this-page-helpful