> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ugatext.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Gateway Health Check



## OpenAPI

````yaml https://ugatext.com/api/v1/openapi.json get /health
openapi: 3.0.3
info:
  title: UgaText Developer Communications API
  version: 1.0.0
  description: >-
    Official REST API for UgaText (https://ugatext.com/api/v1). Supports single
    and bulk SMS dispatch across Uganda (+256 via Pandora), Kenya (+254 via Ping
    Africa), Tanzania (+255 via SwalaSMS), and DR Congo (+243 via Coussema SMS
    Gateway), real-time queued → sent → delivered status polling, SMS scheduling
    with recurrence (none, daily, weekly, monthly), bulk campaigns, wallet
    balance queries, Sender ID lifecycle management, opt-out management,
    HMAC-SHA256 webhooks, UCC 21-rule compliance inspection, and OTP
    verification. Rate limit: 600 requests/minute (10 req/sec). Free sandbox
    numbers: +256700000000, +254700000000, +255700000000, or +243810000000.
  contact:
    name: UgaText Developer Support
    url: https://docs.ugatext.com
    email: support@ugatext.com
servers:
  - url: https://ugatext.com/api/v1
    description: UgaText Production API Gateway
security:
  - ClientIdHeader: []
    ClientSecretHeader: []
tags:
  - name: System
    description: Gateway health, route index, and OpenAPI specification
  - name: Authentication
    description: API key verification, generation, configuration, and revocation
  - name: SMS
    description: Single and bulk SMS dispatch, status polling, history, and wallet balance
  - name: Scheduling
    description: Future SMS scheduling, recurrence, rescheduling, and cancellation
  - name: Campaigns
    description: Bulk SMS campaign creation, listing, details, and cancellation
  - name: Verify
    description: OTP verification sessions, services/apps, and analytics
  - name: Sender IDs
    description: >-
      Alphanumeric Sender ID registration, regulatory documents, wallet payment,
      and lifecycle
  - name: Webhooks
    description: Real-time HMAC-SHA256 delivery receipt webhooks and test dispatch
  - name: Opt-Outs
    description: Recipient opt-out suppression list management
  - name: Compliance
    description: Pre-flight 21-rule UCC SMS compliance and GSM segmentation inspection
paths:
  /health:
    get:
      tags:
        - System
      summary: Gateway Health Check
      responses:
        '200':
          description: Gateway is operational
      security:
        - ClientIdHeader: []
          ClientSecretHeader: []
components:
  securitySchemes:
    ClientIdHeader:
      type: apiKey
      in: header
      name: Client-ID
      description: >-
        Your UgaText Client-ID (e.g. uga_...). Accepted header aliases:
        X-Client-ID, or combined in Authorization: Bearer
        <Client-ID>:<Client-Secret> / X-API-Key: <Client-ID>:<Client-Secret>.
    ClientSecretHeader:
      type: apiKey
      in: header
      name: Client-Secret
      description: >-
        Your UgaText Client-Secret (e.g. sk_live_...). Accepted header alias:
        X-Client-Secret.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.