import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
const countryCoverage = await client.countryCoverage.retrieve();
console.log(countryCoverage.data);{
"data": {
"Afghanistan": {
"code": "AF",
"numbers": false,
"features": [],
"phone_number_type": [],
"reservable": false,
"quickship": false,
"international_sms": false,
"p2p": false,
"local": {},
"toll_free": {},
"mobile": {},
"national": {},
"region": null,
"inventory_coverage": false
},
"Aland Islands": {
"code": "AX",
"numbers": false,
"features": [],
"phone_number_type": [],
"reservable": false,
"quickship": false,
"international_sms": false,
"p2p": false,
"local": {},
"toll_free": {},
"mobile": {},
"national": {},
"region": null,
"inventory_coverage": false
},
"Albania": {
"code": "AL",
"numbers": true,
"features": [
"voice",
"fax"
],
"phone_number_type": [
"local",
"toll_free"
],
"reservable": false,
"quickship": false,
"international_sms": false,
"p2p": false,
"local": {
"features": [
"fax",
"voice"
],
"reservable": false,
"full_pstn_replacement": false,
"quickship": false,
"international_sms": false,
"p2p": false
},
"toll_free": {
"features": [
"fax",
"voice"
],
"reservable": false,
"full_pstn_replacement": false,
"quickship": false,
"international_sms": false,
"p2p": false
},
"mobile": {},
"national": {},
"region": "EMEA",
"inventory_coverage": false,
"shared_cost": {}
},
"Algeria": {
"code": "DZ",
"numbers": false,
"features": [],
"phone_number_type": [],
"reservable": false,
"quickship": false,
"international_sms": false,
"p2p": false,
"local": {},
"toll_free": {},
"mobile": {},
"national": {},
"region": null,
"inventory_coverage": false
}
}
}Get country coverage
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
const countryCoverage = await client.countryCoverage.retrieve();
console.log(countryCoverage.data);{
"data": {
"Afghanistan": {
"code": "AF",
"numbers": false,
"features": [],
"phone_number_type": [],
"reservable": false,
"quickship": false,
"international_sms": false,
"p2p": false,
"local": {},
"toll_free": {},
"mobile": {},
"national": {},
"region": null,
"inventory_coverage": false
},
"Aland Islands": {
"code": "AX",
"numbers": false,
"features": [],
"phone_number_type": [],
"reservable": false,
"quickship": false,
"international_sms": false,
"p2p": false,
"local": {},
"toll_free": {},
"mobile": {},
"national": {},
"region": null,
"inventory_coverage": false
},
"Albania": {
"code": "AL",
"numbers": true,
"features": [
"voice",
"fax"
],
"phone_number_type": [
"local",
"toll_free"
],
"reservable": false,
"quickship": false,
"international_sms": false,
"p2p": false,
"local": {
"features": [
"fax",
"voice"
],
"reservable": false,
"full_pstn_replacement": false,
"quickship": false,
"international_sms": false,
"p2p": false
},
"toll_free": {
"features": [
"fax",
"voice"
],
"reservable": false,
"full_pstn_replacement": false,
"quickship": false,
"international_sms": false,
"p2p": false
},
"mobile": {},
"national": {},
"region": "EMEA",
"inventory_coverage": false,
"shared_cost": {}
},
"Algeria": {
"code": "DZ",
"numbers": false,
"features": [],
"phone_number_type": [],
"reservable": false,
"quickship": false,
"international_sms": false,
"p2p": false,
"local": {},
"toll_free": {},
"mobile": {},
"national": {},
"region": null,
"inventory_coverage": false
}
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response for country coverage
Show child attributes
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?