import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: 'My API Key',
});
const response = await client.countryCoverage.retrieveCountry('US');
console.log(response.data);{
"data": {
"United States of America": {
"code": "US",
"numbers": true,
"features": [
"hd_voice",
"emergency",
"voice",
"mms",
"fax",
"sms",
"international_sms"
],
"phone_number_type": [
"local",
"local",
"local",
"local",
"toll_free"
],
"reservable": true,
"quickship": true,
"international_sms": true,
"p2p": true,
"local": {
"features": [
"hd_voice",
"voice",
"international_sms",
"mms",
"fax",
"sms",
"emergency"
],
"reservable": true,
"quickship": false,
"international_sms": true,
"p2p": true,
"full_pstn_replacement": true
},
"toll_free": {
"features": [
"voice",
"mms",
"fax",
"sms",
"emergency"
],
"reservable": true,
"quickship": true,
"international_sms": false,
"p2p": false,
"full_pstn_replacement": false
},
"mobile": {},
"national": {},
"inventory_coverage": true,
"shared_cost": {},
"region": "AMER"
}
}
}Get coverage for a specific country
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: 'My API Key',
});
const response = await client.countryCoverage.retrieveCountry('US');
console.log(response.data);{
"data": {
"United States of America": {
"code": "US",
"numbers": true,
"features": [
"hd_voice",
"emergency",
"voice",
"mms",
"fax",
"sms",
"international_sms"
],
"phone_number_type": [
"local",
"local",
"local",
"local",
"toll_free"
],
"reservable": true,
"quickship": true,
"international_sms": true,
"p2p": true,
"local": {
"features": [
"hd_voice",
"voice",
"international_sms",
"mms",
"fax",
"sms",
"emergency"
],
"reservable": true,
"quickship": false,
"international_sms": true,
"p2p": true,
"full_pstn_replacement": true
},
"toll_free": {
"features": [
"voice",
"mms",
"fax",
"sms",
"emergency"
],
"reservable": true,
"quickship": true,
"international_sms": false,
"p2p": false,
"full_pstn_replacement": false
},
"mobile": {},
"national": {},
"inventory_coverage": true,
"shared_cost": {},
"region": "AMER"
}
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Country ISO code.
"US"
Response for specific country coverage
Show child attributes
Country ISO code
Set of features supported
Phone number type
Supports reservable
Supports quickship
Indicates whether country can be queried with inventory coverage endpoint
Geographic region (e.g., AMER, EMEA, APAC)
{
"United States of America": {
"code": "US",
"numbers": true,
"features": [
"hd_voice",
"emergency",
"voice",
"mms",
"fax",
"sms",
"international_sms"
],
"phone_number_type": [
"local",
"local",
"local",
"local",
"toll_free"
],
"reservable": true,
"quickship": true,
"international_sms": true,
"p2p": true,
"local": {
"features": [
"hd_voice",
"voice",
"international_sms",
"mms",
"fax",
"sms",
"emergency"
],
"reservable": true,
"quickship": false,
"international_sms": true,
"p2p": true,
"full_pstn_replacement": true
},
"toll_free": {
"features": ["voice", "mms", "fax", "sms", "emergency"],
"reservable": true,
"quickship": true,
"international_sms": false,
"p2p": false,
"full_pstn_replacement": false
},
"mobile": {},
"national": {},
"inventory_coverage": true,
"shared_cost": {},
"region": "AMER"
}
}Was this page helpful?