Skip to main content
POST
/
portability_checks
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const response = await client.portabilityChecks.run();

console.log(response.data);
{
  "data": [
    {
      "record_type": "portability_check_result",
      "fast_portable": true,
      "not_portable_reason": "No coverage",
      "phone_number": "+13125550123",
      "portable": true
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
phone_numbers
string[]

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

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

Response

PortabilityCheck Response

​
data
object[]