Returns regulatory requirements for number ordering, porting, or other supported actions. Results can be filtered by phone number, requirement group, country, number type, and action.
GET
/
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 regulatoryRequirement = await client.regulatoryRequirements.retrieve();
console.log(regulatoryRequirement.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
)
regulatory_requirement = client.regulatory_requirements.retrieve()
print(regulatory_requirement.data)
{ "data": [ { "country_code": "DE", "phone_number_type": "local", "action": "ordering", "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", "name": "Address matching the DID area code", "field_type": "address_id", "acceptance_criteria": { "locality_limit": "Identical locality as the numbers desired", "time_limit": "Less than 5 months old", "regex": "regex field value must match", "case_sensitive": "Whether field value is case sensitive", "acceptable_characters": "Characters that can be included in field value", "acceptable_values": [ "<string>" ], "max_length": "10", "min_length": "5" } } ] } ]}
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
const regulatoryRequirement = await client.regulatoryRequirements.retrieve();
console.log(regulatoryRequirement.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
)
regulatory_requirement = client.regulatory_requirements.retrieve()
print(regulatory_requirement.data)
{ "data": [ { "country_code": "DE", "phone_number_type": "local", "action": "ordering", "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", "name": "Address matching the DID area code", "field_type": "address_id", "acceptance_criteria": { "locality_limit": "Identical locality as the numbers desired", "time_limit": "Less than 5 months old", "regex": "regex field value must match", "case_sensitive": "Whether field value is case sensitive", "acceptable_characters": "Characters that can be included in field value", "acceptable_values": [ "<string>" ], "max_length": "10", "min_length": "5" } } ] } ]}