The coverage object
GET /coverage/{country} returns the full record for one country. GET /coverage returns a summary row per country with country, name, region, dialCode, senders, registrationRequired, twoWay, optOutMandatory and hasSendWindow.
Local and international rules
Rules that can differ by sender origin use a{ "local": ..., "international": ... } pair. local applies when you send from a sender in the destination country, and international when you send from abroad. Each value is true, false or null when unknown. This shape is used by every field under senders, registration.required and urls, and by registrationRequired in list rows.
Endpoints
Filtering the list
All filters onGET /coverage combine, and the result is sorted by country name with a total count.
The boolean filters accept
true/false, 1/0 and t/f. Any other value returns 400, for example twoWay must be true or false. An unknown code on GET /coverage/{country} returns 404 with country not found.
Example
cURL
Response
Using coverage before you send
- Pick a sender. Read
sendersfor the destination. Wherealphanumericisfalse, send from a number; wherelongNumber.internationalisfalse, use a local or short-code sender. - Register first. Where
registration.requiredistrue, complete registration before you send.durationDays,informationRequiredanddocumentsRequiredtell you what to prepare. For US traffic see US 10DLC and for India see India DLT. - Respect the window. When
hasSendWindowistrue, readsendWindowand schedule sends inside it.Timezone from MSISDNmeans the recipient’s local time. - Check content and links. Keep messages clear of
prohibitedTopics, and checkurlsbefore you include a link. - Offer an opt-out. Where
optOutMandatoryistrue, include STOP instructions and honour opt-outs.
Related
Messaging compliance
Registration paths by country and sender type.
SMS channel
Encoding, segments and sender options for SMS.
Numbers guide
Buy a number for the countries you send to.
India DLT
Register entities, headers and templates for Indian traffic.