> ## 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. # List coverage > Returns one summary row per destination country, sorted by country name: the sender types it accepts, whether sender registration is required, two-way support, opt-out rules and whether a sending window applies. ## OpenAPI ````yaml openapi-sms.yaml GET /coverage 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: get: tags: - Coverage summary: List coverage description: >- Returns one summary row per destination country, sorted by country name: the sender types it accepts, whether sender registration is required, two-way support, opt-out rules and whether a sending window applies. Use it to plan where to send and which sender to use before you buy numbers or register. Filters combine, so `region` plus `twoWay=true` returns only two-way countries in that region. For the full record of one country, call `GET /coverage/{country}`. operationId: list-coverage parameters: - name: q in: query description: >- Search text, case-insensitive. Matches a substring of the country name (`united`), an exact ISO 3166-1 alpha-2 code (`GB`) or the start of the dial code (`44` or `+44`); spaces and a leading `+` are ignored. schema: type: string example: united - name: region in: query description: >- Exact region name, case-insensitive, for example `Northern America`, `Western Europe` or `South-central Asia`. Partial names match nothing; read the `region` values from an unfiltered list to see the full set. schema: type: string example: Northern America - name: twoWay in: query description: >- `true` returns only countries where recipients can reply; `false` returns the rest, including countries where two-way support is unknown. Also accepts `1`/`0` and `t`/`f`; any other value returns `400` with `twoWay must be true or false`. schema: type: boolean - name: registrationRequired in: query description: >- `true` returns countries that require sender registration for local or international traffic; `false` returns countries that require neither. Accepts the same values as `twoWay`; anything else returns `400` with `registrationRequired must be true or false`. schema: type: boolean responses: '200': description: Coverage rows and the dataset timestamp. content: application/json: schema: $ref: '#/components/schemas/CoverageList' example: countries: - country: GB name: United Kingdom region: Northern Europe dialCode: '44' senders: alphanumeric: local: true international: true shortCode: local: true international: true longNumber: local: true international: true registrationRequired: local: true international: true twoWay: true optOutMandatory: false hasSendWindow: false - country: US name: United States region: Northern America dialCode: '1' senders: alphanumeric: local: false international: false shortCode: local: true international: true longNumber: local: true international: true registrationRequired: local: true international: true twoWay: true optOutMandatory: true hasSendWindow: false total: 2 updatedAt: '2026-10-09T09:49:01Z' '400': description: A boolean filter has a value other than `true` or `false`. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: twoWay must be true or false '401': $ref: '#/components/responses/Unauthorized' '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.listCoverage({ q: "united", region: "Northern America" }) - lang: python label: Python SDK source: | from vobiz import Vobiz client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN") client.sms.coverage.list_coverage( q="united", region="Northern America", ) - 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.ListCoverageRequest{ Q: vobiz.String( "united", ), Region: vobiz.String( "Northern America", ), } c.Sms.Coverage.ListCoverage( 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().listCoverage( ListCoverageRequest .builder() .q("united") .region("Northern America") .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.list_coverage( q: "united", region: "Northern America" ) - lang: csharp label: C# SDK source: | using Vobiz; using Vobiz.Sms; var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX"); await client.Sms.Coverage.ListCoverageAsync( new ListCoverageRequest { Q = "united", Region = "Northern America" } ); - lang: php label: PHP SDK source: > sms->coverage->listCoverage( new ListCoverageRequest([ 'q' => 'united', 'region' => 'Northern America', ]), ); components: schemas: CoverageList: type: object properties: countries: type: array items: $ref: '#/components/schemas/CoverageSummary' description: >- One summary row per matching country, sorted by country name. Empty array when nothing matches. total: type: integer description: Number of rows in `countries` after filtering. example: 253 updatedAt: type: string format: date-time description: When the coverage dataset was last refreshed (ISO 8601). example: '2026-10-09T09:49:01Z' description: Coverage summary rows for every country that matches your filters. 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. CoverageSummary: type: object description: >- One row of the coverage list, with the key rules for a destination country. Call `GET /coverage/{country}` for the full record. properties: country: type: string description: >- ISO 3166-1 alpha-2 code of the country. Pass it to `GET /coverage/{country}`. example: US 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`. `null` when not assigned. dialCode: type: string description: Country calling code without the `+`, for example `1` or `44`. example: '1' senders: allOf: - $ref: '#/components/schemas/CoverageSenders' description: >- Which sender types the country accepts, for local and international traffic. registrationRequired: allOf: - $ref: '#/components/schemas/LocalIntl' description: >- Whether senders must be registered before sending, for local and international traffic. twoWay: type: boolean nullable: true description: >- `true` when recipients can reply to your messages, `false` when they cannot, `null` when unknown. optOutMandatory: type: boolean nullable: true description: >- `true` when messages must offer an opt-out, such as replying STOP. `null` when unknown. hasSendWindow: type: boolean description: >- `true` when the country restricts sending to certain hours. Read `sendWindow` on `GET /coverage/{country}` for the hours. 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. 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.