Skip to main content
GET
/
phone_numbers
/
regulatory_requirements
JavaScript
import Telnyx from 'telnyx';

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

const phoneNumbersRegulatoryRequirement =
  await client.phoneNumbersRegulatoryRequirements.retrieve();

console.log(phoneNumbersRegulatoryRequirement.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
)
phone_numbers_regulatory_requirement = client.phone_numbers_regulatory_requirements.retrieve()
print(phone_numbers_regulatory_requirement.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"),
)
phoneNumbersRegulatoryRequirement, err := client.PhoneNumbersRegulatoryRequirements.Get(context.TODO(), telnyx.PhoneNumbersRegulatoryRequirementGetParams{})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", phoneNumbersRegulatoryRequirement.Data)
}
package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.phonenumbersregulatoryrequirements.PhoneNumbersRegulatoryRequirementRetrieveParams;
import com.telnyx.sdk.models.phonenumbersregulatoryrequirements.PhoneNumbersRegulatoryRequirementRetrieveResponse;

public final class Main {
private Main() {}

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

PhoneNumbersRegulatoryRequirementRetrieveResponse phoneNumbersRegulatoryRequirement = client.phoneNumbersRegulatoryRequirements().retrieve();
}
}
require "telnyx"

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

phone_numbers_regulatory_requirement = telnyx.phone_numbers_regulatory_requirements.retrieve

puts(phone_numbers_regulatory_requirement)
<?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 {
$phoneNumbersRegulatoryRequirement = $client
->phoneNumbersRegulatoryRequirements
->retrieve(filter: ['phoneNumber' => '+41215470622,+41215470633']);

var_dump($phoneNumbersRegulatoryRequirement);
} catch (APIException $e) {
echo $e->getMessage();
}
telnyx phone-numbers-regulatory-requirements retrieve \
--api-key 'My API Key'
curl --request GET \
--url https://api.telnyx.com/v2/phone_numbers/regulatory_requirements \
--header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "phone_number": "+41215471644",
      "phone_number_type": "local",
      "region_information": [
        {
          "region_name": "CH",
          "region_type": "country_code"
        }
      ],
      "record_type": "phone_number_regulatory_requirements",
      "regulatory_requirements": [
        {
          "description": "Address matching the DID area code (street, building number, postal code, city and country)",
          "id": "12ade33a-21c0-473b-b055-b3c836e1c292",
          "example": "600 Congress Avenue, 14th Floor, Austin, TX 78701",
          "label": "Address matching the DID area code",
          "field_type": "address_id",
          "acceptance_criteria": {
            "locality_limit": "Identical locality as the numbers desired",
            "field_value": "45f45a04-b4be-4592-95b1-9306b9db2b21",
            "field_type": "address"
          },
          "record_type": "regulatory_requirement"
        }
      ]
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}
{
"errors": [
{
"code": "10007",
"title": "Unexpected error",
"detail": "An unexpected error occured.",
"source": {
"pointer": "/base",
"parameter": "<string>"
},
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10015"
}
}
]
}
{
"errors": [
{
"code": "10009",
"title": "Authentication failed",
"detail": "Could not understand the provided credentials.",
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10009"
}
}
]
}
{
"errors": [
{
"code": "10007",
"title": "Unexpected error",
"detail": "An unexpected error occured.",
"source": {
"pointer": "/base",
"parameter": "<string>"
},
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10015"
}
}
]
}
{
"errors": [
{
"code": "10007",
"title": "Unexpected error",
"detail": "An unexpected error occured.",
"source": {
"pointer": "/base",
"parameter": "<string>"
},
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10015"
}
}
]
}
{
"errors": [
{
"code": "10007",
"title": "Unexpected error",
"detail": "An unexpected error occured.",
"source": {
"pointer": "/base",
"parameter": "<string>"
},
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10015"
}
}
]
}

Authorizations

Authorization
string
header
required

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

Query Parameters

filter
object

Consolidated filter parameter (deepObject style). Originally: filter[phone_number]

Response

An array of Regulatory Requirements Responses

data
object[]
meta
object