Run a portability check

Runs a portability check, returning the results immediately.

POST /portability_checks

JavaScript

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);

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
response = client.portability_checks.run()
print(response.data)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	response, err := client.PortabilityChecks.Run(context.TODO(), telnyx.PortabilityCheckRunParams{})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.portabilitychecks.PortabilityCheckRunParams;
import com.telnyx.sdk.models.portabilitychecks.PortabilityCheckRunResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        PortabilityCheckRunResponse response = client.portabilityChecks().run();
    }
}

require "telnyx"

telnyx = Telnyx::Client.new(api_key: "My API Key")

response = telnyx.portability_checks.run

puts(response)

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $response = $client->portabilityChecks->run(
    phoneNumbers: ['[phone]', '[phone]', '[phone]']
  );

  var_dump($response);
} catch (APIException $e) {
  echo $e->getMessage();
}

telnyx portability-checks run \
  --api-key 'My API Key'

curl --request POST \
  --url https://api.telnyx.com/v2/portability_checks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone_numbers": [
    "[phone]",
    "[phone]",
    "[phone]"
  ]
}
'

201

{
  "data": [
    {
      "record_type": "portability_check_result",
      "fast_portable": true,
      "not_portable_reason": "No coverage",
      "phone_number": "[phone]",
      "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:

[
  "[phone]",
  "[phone]",
  "[phone]"
]

Response

201

application/json

PortabilityCheck Response

data · object[]

Show child attributes