Retrieve regulartory requirements
GET/phone_numbers_regulatory_requirements
Retrieve regulartory requirements
Request
Query Parameters
filter[phone_number] stringrequired
Record type phone number/ phone numbers
Responses
200: An array of Regulatory Requiremenst Responses
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
]
Array [
]
]
data
RegulatoryRequirements[]
phone_number string
phone_number_type string
region_information
object[]
region_name string
region_type string
record_type string
regulatory_requirements
object[]
description string
id uuid
example string
label string
field_type string
acceptance_criteria
object
locality_limit string
field_value string
field_type string
record_type string
meta
object
total_pages integer
total_results integer
page_number integer
page_size integer
{
"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": "311 W Superior St, Chicago, IL 60654",
"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
}
}
default: Unexpected error
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
errors
Error[]
code integerrequired
title stringrequired
detail string
source
object
pointer json-pointer
JSON pointer (RFC6901) to the offending entity.
parameter string
Indicates which query parameter caused the error.
meta
object
url string
URL with additional information on the error.
{
"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"
}
}
]
}
Loading...