> ## Documentation Index > Fetch the complete documentation index at: https://www.vobiz.ai/docs/llms.txt > Use this file to discover all available pages before exploring further. # 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. ## OpenAPI ````yaml openapi-sms.yaml GET /coverage/{country} openapi: 3.0.3 info: title: Vobiz Messaging API description: > Send and receive SMS, MMS and RCS messages, buy messaging numbers, register for US 10DLC and toll-free, run broadcasts, manage conversations, opt-outs and webhooks. **Base URL:** `https://api.vobiz.ai/api/v1/sms` **Authentication:** every request needs the `X-Auth-ID` and `X-Auth-Token` headers. The account is taken from your credentials; you never put an account ID in a path or body. Field names in this API are camelCase. version: '1.0' contact: email: support@vobiz.ai url: https://vobiz.ai servers: - url: https://api.vobiz.ai/api/v1/sms description: Production security: - AuthID: [] AuthToken: [] tags: - name: Messages description: Send messages and inspect their delivery state. - name: Numbers description: >- Messaging-capable numbers on your account, inventory search, purchase and release. - name: Coverage description: Where you can send, per country. - name: Conversations description: Two-way threads between one of your numbers and a contact. - name: Opt-outs description: Numbers that must not receive messages on a channel. - name: Webhooks description: Subscriptions that deliver message and broadcast events to your server. - name: Broadcasts description: Bulk sends from an uploaded recipient list. - name: RCS Senders description: RCS sender (agent) identities and their message templates. - name: 10DLC Brands description: US 10DLC brand registration. - name: 10DLC Campaigns description: US 10DLC campaigns, toll-free verification and supporting documents. paths: /coverage/{country}: get: tags: - Coverage summary: Retrieve country coverage description: >- 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. Read it before your first send to a new country so your sender, content and send times match the local rules. An unknown code returns `404` with `country not found`. operationId: get-coverage parameters: - name: country in: path required: true description: >- 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`. schema: type: string example: US responses: '200': description: The country's coverage record. content: application/json: schema: $ref: '#/components/schemas/CoverageDetail' example: 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' '401': $ref: '#/components/responses/Unauthorized' '404': description: No coverage record for that code. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: country not found '500': $ref: '#/components/responses/ServerError' x-codeSamples: - lang: typescript label: Node SDK source: > import { VobizClient } from "@vobiz/sdk"; const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" }); await client.sms.coverage.getCoverage({ country: "US" }) - lang: python label: Python SDK source: | from vobiz import Vobiz client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN") client.sms.coverage.get_coverage( country="US", ) - lang: go label: Go SDK source: | import ( "context" vobiz "github.com/vobiz-ai/Vobiz-Go-SDK" "github.com/vobiz-ai/Vobiz-Go-SDK/client" "github.com/vobiz-ai/Vobiz-Go-SDK/option" "github.com/vobiz-ai/Vobiz-Go-SDK/sms" ) c := client.NewClient( option.WithAPIKey("MA_XXXXXXXX"), option.WithAuthToken("YOUR_AUTH_TOKEN"), ) request := &sms.GetCoverageRequest{ Country: "US", } c.Sms.Coverage.GetCoverage( context.TODO(), request, ) - lang: java label: Java SDK source: | import com.vobiz.api.VobizApiClient; VobizApiClient client = VobizApiClient .builder() .apiKey("MA_XXXXXXXX") .authToken("YOUR_AUTH_TOKEN") .build(); client.sms().coverage().getCoverage( "US", GetCoverageRequest .builder() .build() ); - lang: ruby label: Ruby SDK source: > require 'vobiz' client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN') client.sms.coverage.get_coverage(country: "US") - lang: csharp label: C# SDK source: > using Vobiz; using Vobiz.Sms; var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX"); await client.Sms.Coverage.GetCoverageAsync(new GetCoverageRequest { Country = "US" }); - lang: php label: PHP SDK source: > sms->coverage->getCoverage( 'US', ); components: schemas: CoverageDetail: type: object description: >- The full coverage record for one destination country, returned by `GET /coverage/{country}`. properties: country: type: string example: US description: ISO 3166-1 alpha-2 code of the country. name: type: string example: United States description: >- English name of the country or territory, for example `United States`. region: type: string nullable: true example: Northern America description: >- Geographic region the country belongs to, for example `Northern America`. Use this value with the `region` filter on `GET /coverage`. `null` when not assigned. dialCode: type: string description: Country calling code without the `+`, for example `1` or `44`. example: '1' mcc: type: string nullable: true description: >- Mobile country code (MCC) of the country's networks, for example `311`. `null` when not published. example: '311' numberPortability: type: boolean nullable: true description: >- `true` when subscribers can keep their number when they change network, `null` when unknown. localVsInternationalTraffic: type: boolean nullable: true description: >- `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. senders: allOf: - $ref: '#/components/schemas/CoverageSenders' description: >- Which sender types the country accepts, for local and international traffic. registration: allOf: - $ref: '#/components/schemas/CoverageRegistration' description: Whether senders must be registered, and what registration involves. urls: allOf: - $ref: '#/components/schemas/CoverageUrls' description: Rules for links in message bodies. optOutMandatory: type: boolean nullable: true description: >- `true` when messages must offer an opt-out, such as replying STOP. `null` when unknown. twoWay: type: boolean nullable: true description: >- `true` when recipients can reply to your messages, `false` when they cannot, `null` when unknown. prohibitedTopics: type: array items: type: string example: - Phishing - Other Scams - Explicit Content - Gambling description: >- Content categories that may not be sent to the country, for example `Gambling` or `Phishing`. Empty array when none are listed. prohibitedNotes: type: string nullable: true description: >- Free-text detail on prohibited or restricted content. `null` when none. sendWindow: allOf: - $ref: '#/components/schemas/CoverageSendWindow' description: >- Hours during which you may send, by day type. `null` when the country has no sending window. marketNotes: type: string nullable: true description: >- Free-text guidance on sending to this market, such as sender behaviour and local rules. `null` when none. updatedAt: type: string format: date-time description: When the coverage dataset was last refreshed (ISO 8601). example: '2026-10-09T09:49:01Z' Error: type: object description: >- The body of every error response: a flat object with one `error` string that explains what went wrong. Use the HTTP status code to decide how to handle the error, and log `error` for diagnosis. required: - error properties: error: type: string example: 'recipient has opted out: +14155550123' description: >- Human-readable explanation of the error, for example `phoneNumber is required` or `recipient has opted out: +14155550123`. Branch on the HTTP status code rather than on this text. CoverageSenders: type: object description: >- Which sender types a destination accepts, each split into local and international traffic. properties: alphanumeric: allOf: - $ref: '#/components/schemas/LocalIntl' description: >- Whether alphanumeric sender IDs (a brand name such as `ACME` in place of a number) are accepted. shortCode: allOf: - $ref: '#/components/schemas/LocalIntl' description: Whether short codes (5 or 6 digit numbers) are accepted as senders. longNumber: allOf: - $ref: '#/components/schemas/LocalIntl' description: >- Whether long numbers (standard-length phone numbers, such as US 10DLC numbers) are accepted as senders. CoverageRegistration: type: object description: >- Sender registration requirements for a destination country. The text fields are free-form and may prefix values with `LOCAL:` or `INTERNATIONAL:` when they differ by traffic type. properties: required: allOf: - $ref: '#/components/schemas/LocalIntl' description: >- Whether senders must be registered before sending, for local and international traffic. durationDays: type: string nullable: true description: >- Typical registration lead time as published for the country, for example `LOCAL: +20`. Free text; `null` when not published. informationRequired: type: string nullable: true description: >- Information you must supply to register a sender, for example sample messages. `null` when not published. documentsRequired: type: string nullable: true description: >- Documents you must supply to register a sender, for example a letter of authorization. `null` when not published. alphanumericExtraSteps: type: string nullable: true description: >- Additional steps that apply to alphanumeric sender IDs, such as DLT registration in India. `null` when none. CoverageUrls: type: object description: Rules for links in message bodies sent to a destination country. properties: allowed: allOf: - $ref: '#/components/schemas/LocalIntl' description: >- Whether message bodies may contain URLs, for local and international traffic. whitelistingRequired: allOf: - $ref: '#/components/schemas/LocalIntl' description: >- Whether the domains you link to must be registered (whitelisted) in advance, for local and international traffic. CoverageSendWindow: type: object nullable: true description: >- The hours during which messages may be sent to the country. Each value is a text range with its timezone rule, for example `MON - FRI: 10:00:00 - 21:00:00; Timezone from MSISDN`, which means the recipient's local time. properties: weekday: type: string example: 'MON - FRI: 10:00:00 - 21:00:00; Timezone from MSISDN' description: Permitted sending hours Monday to Friday, with the timezone rule. saturday: type: string example: 'SAT: 10:00:00 - 21:00:00; Timezone from MSISDN' description: Permitted sending hours on Saturday, with the timezone rule. sunday: type: string example: 'SUN: 10:00:00 - 21:00:00; Timezone from MSISDN' description: Permitted sending hours on Sunday, with the timezone rule. LocalIntl: type: object description: >- A coverage rule that can differ for local (in-country) and international senders. Each value is `true`, `false`, or `null` when unknown. properties: local: type: boolean nullable: true description: >- Value of the rule for local (in-country) traffic. `null` when unknown. international: type: boolean nullable: true description: >- Value of the rule for international traffic, sent from outside the country. `null` when unknown. responses: Unauthorized: description: Missing or invalid `X-Auth-ID` / `X-Auth-Token`. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: missing or invalid credentials ServerError: description: Unexpected error. Retry with the same idempotency key where one applies. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: internal error securitySchemes: AuthID: type: apiKey in: header name: X-Auth-ID description: Your Vobiz account Auth ID (`MA_XXXXXXXX`). AuthToken: type: apiKey in: header name: X-Auth-Token description: Your Vobiz account Auth Token. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.