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

# Get a message

> Reads a message's current status and timestamps. Statuses arrive from Meta within about a minute; `error` is set when the message failed. A message belongs to the key's application; any other id answers `404`.



## OpenAPI

````yaml https://tawked.com/openapi.json get /v1/whatsapp/messages/{id}
openapi: 3.1.0
info:
  title: Tawked Verify API
  version: 2026-09
  summary: >-
    OTP verification for Saudi mobile numbers over SMS or WhatsApp, in two
    calls.
  description: >-
    Tawked is a Saudi OTP verification API: one request sends a code by SMS or
    WhatsApp to a Saudi mobile number, one request checks it. Built in Jeddah,
    billed only per delivered code. SAR 0.09 per delivered SMS code, prepaid;
    failed sends are not charged. Authenticate with a Bearer API key from the
    dashboard (tk_live_ for production, tk_test_ for the sandbox, tk_partner_
    for partners). Both /v1/... and /api/v1/... answer identically. Rate limit:
    120 requests per minute per key.
  termsOfService: https://tawked.com/en/terms
  license:
    name: Proprietary (Tawked terms of service)
    url: https://tawked.com/en/terms
  contact:
    name: Tawked support
    email: support@tawked.com
    url: https://tawked.com/en/contact
servers:
  - url: https://tawked.com
    description: Production (the sandbox is a tk_test_ key on the same host)
  - url: https://tawked.com/api
    description: The same API under /api/v1/..., kept for older integrations
security:
  - bearerKey: []
  - headerKey: []
tags:
  - name: Verify
    description: Send and check one-time codes.
  - name: WhatsApp
    description: >-
      Send approved WhatsApp templates through the number connected to an
      application; any approved application connects its own number from the
      dashboard.
externalDocs:
  description: Developer docs, with code samples
  url: https://tawked.com/en/docs
paths:
  /v1/whatsapp/messages/{id}:
    get:
      tags:
        - WhatsApp
      summary: Get a message
      description: >-
        Reads a message's current status and timestamps. Statuses arrive from
        Meta within about a minute; `error` is set when the message failed. A
        message belongs to the key's application; any other id answers `404`.
      operationId: whatsapp_message
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: application
          in: query
          required: false
          description: >-
            Partner keys only: passed as a query parameter (`?application=…`)
            since a GET request has no body.
          schema:
            type: string
      responses:
        '200':
          description: Delivered / Failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  status:
                    type: string
                  to:
                    type: string
                  template:
                    type: string
                  lang:
                    type: string
                  reference:
                    type: string
                  price_halalas:
                    type: integer
                  error:
                    type:
                      - object
                      - 'null'
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                  created_at:
                    type: string
                    format: date-time
                  sent_at:
                    type:
                      - string
                      - 'null'
                    format: date-time
                  delivered_at:
                    type:
                      - string
                      - 'null'
                    format: date-time
                  read_at:
                    type:
                      - string
                      - 'null'
                  failed_at:
                    type:
                      - string
                      - 'null'
                    format: date-time
              examples:
                delivered:
                  summary: Delivered
                  value:
                    id: 0f4c9c0e-6d2b-4b8a-9c3e-7a1d2e3f4a5b
                    status: delivered
                    to: '+966550000000'
                    template: order_received_v1
                    lang: ar
                    reference: order-1042
                    price_halalas: 0
                    error: null
                    created_at: '2026-09-06T12:00:00+03:00'
                    sent_at: '2026-09-06T12:00:01+03:00'
                    delivered_at: '2026-09-06T12:00:04+03:00'
                    read_at: null
                    failed_at: null
                failed:
                  summary: Failed
                  value:
                    id: 0f4c9c0e-6d2b-4b8a-9c3e-7a1d2e3f4a5b
                    status: failed
                    to: '+966550000000'
                    template: order_received_v1
                    lang: ar
                    reference: order-1042
                    price_halalas: 0
                    error:
                      code: '131026'
                      message: Message undeliverable
                    created_at: '2026-09-06T12:00:00+03:00'
                    sent_at: null
                    delivered_at: null
                    read_at: null
                    failed_at: '2026-09-06T12:00:03+03:00'
        '400':
          description: >-
            `service_required`: Partner key used with no `application` (or
            `service`) in the request body.; `invalid_json`: The request body is
            not valid JSON.; `invalid_request`: start: `to` (and `phone`) both
            missing or blank. check: `id` or `code` missing.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Error'
                  - properties:
                      error:
                        enum:
                          - service_required
                          - invalid_json
                          - invalid_request
        '401':
          description: >-
            `unauthorized`: Missing, unknown, revoked, or mode-mismatched key;
            or an unknown/suspended partner.; `key_expired`: The key's
            `expires_at` has passed. Checked right after the key is recognised,
            before the IP allowlist or scope.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Error'
                  - properties:
                      error:
                        enum:
                          - unauthorized
                          - key_expired
        '403':
          description: >-
            `account_not_active`: The application is not approved yet, the
            account is banned, or a partner disabled this application. All four
            causes share this one response.; `ip_not_allowed`: The caller's IP
            does not match the key's `ip_allowlist` (exact IPs and/or CIDR
            ranges, IPv4 and IPv6).; `live_key_required`: A sandbox (tk_test_)
            key. WhatsApp has no sandbox yet; use the application's live key.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Error'
                  - properties:
                      error:
                        enum:
                          - account_not_active
                          - ip_not_allowed
                          - live_key_required
        '404':
          description: >-
            Unknown id / `service_not_found`: Partner key, but
            `application`/`service` does not match any of that partner's
            provisioned applications.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Error'
                  - properties:
                      error:
                        enum:
                          - service_not_found
                          - not_found
              examples:
                unknown_id:
                  summary: Unknown id
                  value:
                    error: not_found
        '429':
          description: >-
            `too_many_requests`: Per-key rate limit exceeded (default 120
            requests/minute, fixed 60s window). Checked before authentication.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Error'
                  - properties:
                      error:
                        enum:
                          - too_many_requests
        '500':
          description: >-
            `internal_error`: An unhandled server error. Quote the X-Request-Id
            header if you report it.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Error'
                  - properties:
                      error:
                        enum:
                          - internal_error
components:
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: A stable machine-readable code; the docs list every one.
      additionalProperties: true
  securitySchemes:
    bearerKey:
      type: http
      scheme: bearer
      description: 'Authorization: Bearer <api key>'
    headerKey:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        The same API key, as a header, for clients that cannot set
        Authorization.

````