Get coverage for a specific country

GET 
/country_coverage/countries/:country_code

Get coverage for a specific country

Path Parameters

country_code stringrequired

Country ISO code.

200: Response for specific country coverage

application/json

• Schema
• Example (from schema)

Schema

data

object

code string

Country ISO code

numbers boolean

features string[]

Set of features supported

phone_number_type string[]

Phone number type

reservable boolean

Supports reservable

quickship boolean

Supports quickship

international_sms boolean

p2p boolean

local

object

features string[]

reservable boolean

quickship boolean

international_sms boolean

p2p boolean

toll_free

object

features string[]

reservable boolean

quickship boolean

international_sms boolean

p2p boolean

mobile object

national object

inventory_coverage boolean

Indicates whether country can be queried with inventory coverage endpoint

shared_cost object

{
  "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
      },
      "toll_free": {
        "features": [
          "voice",
          "mms",
          "fax",
          "sms",
          "emergency"
        ],
        "reservable": true,
        "quickship": true,
        "international_sms": false,
        "p2p": false
      },
      "mobile": {},
      "national": {},
      "inventory_coverage": true,
      "shared_cost": {}
    }
  }
}

default: Unexpected error

application/json

• Schema
• Example (from schema)

Schema

errors

Error[]

Array [

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"
      }
    }
  ]
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/v2/country_coverage/countries/:country_code' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

• 200
• default

---

{
  "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
      },
      "toll_free": {
        "features": [
          "voice",
          "mms",
          "fax",
          "sms",
          "emergency"
        ],
        "reservable": true,
        "quickship": true,
        "international_sms": false,
        "p2p": false
      },
      "mobile": {},
      "national": {},
      "inventory_coverage": true,
      "shared_cost": {}
    }
  }
}

{
  "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"
      }
    }
  ]
}