> ## 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.

# Query Delivery Status of an SMS Message (queued → sent → delivered)



## OpenAPI

````yaml https://ugatext.com/api/v1/openapi.json get /sms/status/{id}
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), and DR Congo (+243 via Coussema SMS Gateway), real-time queued →
    sent → delivered status polling, wallet balance queries, UCC 21-rule
    compliance inspection, and OTP verification. Rate limit: 600 requests/minute
    (10 req/sec). Free sandbox numbers: +256700000000, +254700000000, or
    +243810000000.
  contact:
    name: UgaText Developer Support
    url: https://ugatext.com/api-docs
    email: support@ugatext.com
servers:
  - url: https://ugatext.com/api/v1
    description: UgaText Production API Gateway
security:
  - ClientIdHeader: []
    ClientSecretHeader: []
paths:
  /sms/status/{id}:
    get:
      summary: Query Delivery Status of an SMS Message (queued → sent → delivered)
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            example: msg_1760425200000_a1b2c3d4
          description: >-
            The message_id (format msg_<13-digit-unix-ms>_<8-hex-chars>)
            returned when the SMS was sent
      responses:
        '200':
          description: >-
            Message delivery lifecycle details including provider_reference and
            delivered_at
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageStatusResponse'
        '401':
          description: INVALID_API_KEY
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: NOT_FOUND
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    MessageStatusResponse:
      type: object
      properties:
        success:
          type: boolean
          example: true
        message_id:
          type: string
          example: msg_1760425200000_a1b2c3d4
        recipient:
          type: string
          example: '+256750625684'
        phone:
          type: string
          example: '+256750625684'
        sender_id:
          type: string
          example: UGATEXT
        message:
          type: string
          example: Your verification code is 482910.
        status:
          type: string
          enum:
            - queued
            - sent
            - delivered
            - failed
          example: delivered
        segments:
          type: integer
          example: 1
        cost_ugx:
          type: number
          example: 25
        cost_kes:
          type: number
          example: 0.4
        cost_usd:
          type: number
          example: 0.035
        currency:
          type: string
          enum:
            - UGX
            - KES
            - USD
          example: UGX
        network:
          type: string
          example: Airtel
        carrier_network:
          type: string
          example: Airtel
        mode:
          type: string
          enum:
            - live
            - sandbox
          example: live
        created_at:
          type: string
          format: date-time
          example: '2026-10-14T07:00:00.000Z'
        queued_at:
          type: string
          format: date-time
          example: '2026-10-14T07:00:00.000Z'
        sent_at:
          type: string
          format: date-time
          nullable: true
          example: '2026-10-14T07:00:00.120Z'
        delivered_at:
          type: string
          format: date-time
          nullable: true
          example: '2026-10-14T07:00:00.720Z'
        failed_at:
          type: string
          format: date-time
          nullable: true
          example: null
        failure_reason:
          type: string
          nullable: true
          example: null
        provider_reference:
          type: string
          nullable: false
          example: pdr_1760425200120_a1b2c3d4
    ErrorResponse:
      type: object
      required:
        - success
        - error
      properties:
        success:
          type: boolean
          example: false
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              enum:
                - INVALID_API_KEY
                - INVALID_REQUEST
                - INVALID_PHONE_NUMBER
                - INSUFFICIENT_BALANCE
                - COMPLIANCE_BLOCKED
                - SENDER_ID_NOT_APPROVED
                - RATE_LIMIT_EXCEEDED
                - NOT_FOUND
            message:
              type: string
              example: >-
                Authentication failed. Provide a valid 'Client-ID' and
                'Client-Secret' in the request headers.
  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.