Retrieve country coverage
Returns the full coverage record for one country: accepted sender types, registration requirements and lead time, link rules, prohibited topics, the permitted sending window and free-text market notes.
curl --request GET \
--url https://api.vobiz.ai/api/v1/sms/coverage/{country} \
--header 'X-Auth-ID: <api-key>' \
--header 'X-Auth-Token: <api-key>'from vobiz import Vobiz
client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")
client.sms.coverage.get_coverage(
country="US",
)
const options = {
method: 'GET',
headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};
fetch('https://api.vobiz.ai/api/v1/sms/coverage/{country}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"country": "IN",
"name": "India",
"region": "South-central Asia",
"dialCode": "91",
"mcc": "405",
"numberPortability": true,
"localVsInternationalTraffic": false,
"senders": {
"alphanumeric": {
"local": true,
"international": true
},
"shortCode": {
"local": false,
"international": true
},
"longNumber": {
"local": false,
"international": true
}
},
"registration": {
"required": {
"local": false,
"international": false
},
"durationDays": null,
"informationRequired": null,
"documentsRequired": null,
"alphanumericExtraSteps": "Register the Principal Entity, the sender header and each content template on a TRAI DLT portal before sending local traffic."
},
"urls": {
"allowed": {
"local": true,
"international": true
},
"whitelistingRequired": {
"local": false,
"international": false
}
},
"optOutMandatory": false,
"twoWay": true,
"prohibitedTopics": [
"Regulatory",
"Other Scams",
"Gambling",
"Explicit Content",
"Phishing"
],
"prohibitedNotes": "Gambling - only OTP allowed. Political and adult content is not allowed.",
"sendWindow": {
"weekday": "MON - FRI: 10:00:00 - 21:00:00; Timezone from MSISDN",
"saturday": "SAT: 10:00:00 - 21:00:00; Timezone from MSISDN",
"sunday": "SUN: 10:00:00 - 21:00:00; Timezone from MSISDN"
},
"marketNotes": "DLT registration applies to all local SMS traffic types (promotional, transactional and OTP).",
"updatedAt": "2026-10-09T09:49:01Z"
}{
"error": "missing or invalid credentials"
}{
"error": "country not found"
}{
"error": "internal error"
}Authorizations
Your Vobiz account Auth ID (MA_XXXXXXXX).
Your Vobiz account Auth Token.
Path Parameters
ISO 3166-1 alpha-2 code of the destination country, for example US, GB or IN. Case-insensitive. Three-letter codes and dial codes return 404.
Response
The country's coverage record.
The full coverage record for one destination country, returned by GET /coverage/{country}.
ISO 3166-1 alpha-2 code of the country.
"US"
English name of the country or territory, for example United States.
"United States"
Geographic region the country belongs to, for example Northern America. Use this value with the region filter on GET /coverage. null when not assigned.
"Northern America"
Country calling code without the +, for example 1 or 44.
"1"
Mobile country code (MCC) of the country's networks, for example 311. null when not published.
"311"
true when subscribers can keep their number when they change network, null when unknown.
true when the country applies different rules to local (in-country) and international senders. When true, read the local and international values of each rule separately.
Which sender types the country accepts, for local and international traffic.
Show child attributes
Show child attributes
Whether senders must be registered, and what registration involves.
Show child attributes
Show child attributes
Rules for links in message bodies.
Show child attributes
Show child attributes
true when messages must offer an opt-out, such as replying STOP. null when unknown.
true when recipients can reply to your messages, false when they cannot, null when unknown.
Content categories that may not be sent to the country, for example Gambling or Phishing. Empty array when none are listed.
[
"Phishing",
"Other Scams",
"Explicit Content",
"Gambling"
]
Free-text detail on prohibited or restricted content. null when none.
Hours during which you may send, by day type. null when the country has no sending window.
Show child attributes
Show child attributes
Free-text guidance on sending to this market, such as sender behaviour and local rules. null when none.
When the coverage dataset was last refreshed (ISO 8601).
"2026-10-09T09:49:01Z"
Was this page helpful?
curl --request GET \
--url https://api.vobiz.ai/api/v1/sms/coverage/{country} \
--header 'X-Auth-ID: <api-key>' \
--header 'X-Auth-Token: <api-key>'from vobiz import Vobiz
client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")
client.sms.coverage.get_coverage(
country="US",
)
const options = {
method: 'GET',
headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};
fetch('https://api.vobiz.ai/api/v1/sms/coverage/{country}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"country": "IN",
"name": "India",
"region": "South-central Asia",
"dialCode": "91",
"mcc": "405",
"numberPortability": true,
"localVsInternationalTraffic": false,
"senders": {
"alphanumeric": {
"local": true,
"international": true
},
"shortCode": {
"local": false,
"international": true
},
"longNumber": {
"local": false,
"international": true
}
},
"registration": {
"required": {
"local": false,
"international": false
},
"durationDays": null,
"informationRequired": null,
"documentsRequired": null,
"alphanumericExtraSteps": "Register the Principal Entity, the sender header and each content template on a TRAI DLT portal before sending local traffic."
},
"urls": {
"allowed": {
"local": true,
"international": true
},
"whitelistingRequired": {
"local": false,
"international": false
}
},
"optOutMandatory": false,
"twoWay": true,
"prohibitedTopics": [
"Regulatory",
"Other Scams",
"Gambling",
"Explicit Content",
"Phishing"
],
"prohibitedNotes": "Gambling - only OTP allowed. Political and adult content is not allowed.",
"sendWindow": {
"weekday": "MON - FRI: 10:00:00 - 21:00:00; Timezone from MSISDN",
"saturday": "SAT: 10:00:00 - 21:00:00; Timezone from MSISDN",
"sunday": "SUN: 10:00:00 - 21:00:00; Timezone from MSISDN"
},
"marketNotes": "DLT registration applies to all local SMS traffic types (promotional, transactional and OTP).",
"updatedAt": "2026-10-09T09:49:01Z"
}{
"error": "missing or invalid credentials"
}{
"error": "country not found"
}{
"error": "internal error"
}