> ## Documentation Index
> Fetch the complete documentation index at: https://onextel-09023014.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a message

> Read a message, its current status and the time of every status change.

`events` lists each status with the time it was recorded, so you can see how long delivery and
read took. A message never moves backwards: a late `delivered` receipt after `read` is ignored.


## OpenAPI

````yaml api-reference/truecaller/openapi.yaml GET /v1/messages/{id}
openapi: 3.1.0
info:
  title: OneXtel Truecaller Business Messaging API
  version: 1.0.0
  description: >
    Send verified business messages to Truecaller users: single messages,
    templates with

    personalisation, images, files and buttons, and campaigns to contact lists.


    Every request carries a workspace API key in the `x-api-key` header. Create
    one in the

    Truecaller campaigns portal under **Developers → API keys**.


    Errors are JSON with a single `error` string (and `details` for validation
    errors):


    ```json

    { "error": "invalid phone number" }

    ```
servers:
  - url: https://truecaller.udchowdhury.me
    description: Production
security:
  - apiKey: []
tags:
  - name: Messages
    description: Send one message and read its status.
  - name: Templates
    description: Reusable messages with variables, media and buttons.
  - name: Media
    description: Upload files to attach to templates.
  - name: Contact lists
    description: Audiences for campaigns.
  - name: Campaigns
    description: Send a template to a whole contact list, now or later.
  - name: Senders
    description: The verified business profiles your workspace sends from.
paths:
  /v1/messages/{id}:
    get:
      tags:
        - Messages
      summary: Get a message
      description: The message, its current status and every status change with its time.
      operationId: getMessage
      parameters:
        - $ref: '#/components/parameters/Id'
      responses:
        '200':
          description: The message.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Message'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    Id:
      in: path
      name: id
      required: true
      schema:
        type: string
        format: uuid
  schemas:
    Message:
      type: object
      properties:
        id:
          type: string
          format: uuid
        to:
          type: string
          example: '+919999999999'
        sender_id:
          type: string
        category:
          type: string
          enum:
            - promotional
            - transactional
            - service
        template_id:
          type:
            - string
            - 'null'
          format: uuid
        campaign_id:
          type:
            - string
            - 'null'
          format: uuid
        body:
          type: string
        extras:
          type:
            - object
            - 'null'
          description: Media and buttons sent with the message.
        status:
          $ref: '#/components/schemas/MessageStatus'
        error:
          type:
            - string
            - 'null'
          example: null
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        events:
          type: array
          items:
            type: object
            properties:
              status:
                type: string
              created_at:
                type: string
                format: date-time
    MessageStatus:
      type: string
      enum:
        - queued
        - sent
        - delivered
        - read
        - failed
        - blocked
      description: >-
        `sent` means Truecaller accepted it, `blocked` means a limit or opt-out
        skipped it.
    Error:
      type: object
      properties:
        error:
          type: string
        details:
          type: array
          items:
            type: object
  responses:
    NotFound:
      description: Not found in this workspace.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: not found
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Workspace API key from **Developers → API keys**. It starts with
        `tc_live_`.

````

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