Run a portability check

posthttps://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 (application/json)
phone_numbers
array of string
()
optional
The list of +E.164 formatted phone numbers to check for portability

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"
    }
  ]
}
Was this page helpful?