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

# One API request

> One call with its request body and our reply (each cut at 10 KB; request_cut / reply_cut say when), the error, and the live status of the message it made. Never an API key, an Authorization header or a secret; for a file upload, each file's name, type and size only. Calls to /v1/requests keep no reply.

Permission: A Full key.



## OpenAPI

````yaml /openapi.json get /v1/requests/{id}
openapi: 3.1.0
info:
  title: GetReply API
  version: 1.0.0
  description: >-
    Send WhatsApp messages, templates, OTPs and campaigns from your own
    software. Every request needs an API key (Developer → API keys) as a Bearer
    token.


    Requests sent here are real and charged like any other.
servers:
  - url: https://api.getreply.in
    description: GetReply
security:
  - bearerAuth: []
tags:
  - name: Account
  - name: Messages
  - name: Templates
  - name: Contacts
  - name: Inbox
  - name: Campaigns
  - name: Webhooks
  - name: Request log
paths:
  /v1/requests/{id}:
    get:
      tags:
        - Request log
      summary: One API request
      description: >-
        One call with its request body and our reply (each cut at 10 KB;
        request_cut / reply_cut say when), the error, and the live status of the
        message it made. Never an API key, an Authorization header or a secret;
        for a file upload, each file's name, type and size only. Calls to
        /v1/requests keep no reply.


        Permission: A Full key.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The id.
      responses:
        '200':
          description: The call.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestDetail'
              example:
                id: string
                time: '2026-10-26T11:20:00+05:30'
                method: POST
                path: /v1/messages/template
                status: 201
                succeeded: true
                error:
                  code: string
                  field: string
                  reason: string
                took_ms: 1
                ip: string
                key:
                  id: string
                  name: string
                key_deleted: true
                to: string
                reference: string
                idempotency_key: string
                message_id: string
                campaign_id: string
                request: string
                request_cut: true
                reply: string
                reply_cut: true
                message:
                  id: string
                  status: queued
                  failure:
                    code: string
                    message: string
        '401':
          description: 'unauthorized: API key is missing or not valid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                unauthorized:
                  value:
                    error:
                      code: unauthorized
                      message: API key is missing or not valid.
        '403':
          description: >-
            key_off: This API key is switched off. · forbidden_scope: This API
            key isn't allowed to do this. · ip_not_allowed: Requests from this
            IP address aren't allowed for this key. · needs_pro_plan: The API
            needs the Pro plan. · plan_ended: Your plan has ended. Renew it to
            send messages.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                key_off:
                  value:
                    error:
                      code: key_off
                      message: This API key is switched off.
                forbidden_scope:
                  value:
                    error:
                      code: forbidden_scope
                      message: This API key isn't allowed to do this.
                ip_not_allowed:
                  value:
                    error:
                      code: ip_not_allowed
                      message: >-
                        Requests from this IP address aren't allowed for this
                        key.
                needs_pro_plan:
                  value:
                    error:
                      code: needs_pro_plan
                      message: The API needs the Pro plan.
                plan_ended:
                  value:
                    error:
                      code: plan_ended
                      message: Your plan has ended. Renew it to send messages.
        '404':
          description: 'not_found: Not found.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                not_found:
                  value:
                    error:
                      code: not_found
                      message: Not found.
        '429':
          description: 'rate_limited: Too many requests. Try again in a few seconds.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                rate_limited:
                  value:
                    error:
                      code: rate_limited
                      message: Too many requests. Try again in a few seconds.
        '500':
          description: 'server_error: Something went wrong on our side. Try again.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                server_error:
                  value:
                    error:
                      code: server_error
                      message: Something went wrong on our side. Try again.
components:
  schemas:
    RequestDetail:
      type: object
      properties:
        id:
          type: string
        time:
          type: string
          format: date-time
          description: When the call came in (India time).
        method:
          type: string
          example: POST
        path:
          type: string
          example: /v1/messages/template
        status:
          type: integer
          example: 201
        succeeded:
          type: boolean
          description: true when the status is below 400.
        error:
          type:
            - object
            - 'null'
          description: null when the call succeeded.
          properties:
            code:
              type: string
            field:
              type:
                - string
                - 'null'
            reason:
              type:
                - string
                - 'null'
              description: The message we answered.
        took_ms:
          type: integer
        ip:
          type:
            - string
            - 'null'
        key:
          type:
            - object
            - 'null'
          properties:
            id:
              type: string
            name:
              type:
                - string
                - 'null'
        key_deleted:
          type: boolean
          description: >-
            true when the call's key has since been deleted (its calls stay in
            the log).
        to:
          type:
            - string
            - 'null'
          description: A message send's customer; null for every other call.
        reference:
          type:
            - string
            - 'null'
        idempotency_key:
          type:
            - string
            - 'null'
        message_id:
          type:
            - string
            - 'null'
          description: The message the call made.
        campaign_id:
          type:
            - string
            - 'null'
          description: The campaign the call made.
        request:
          type:
            - string
            - 'null'
          description: The request body as sent (JSON text); null when there was none.
        request_cut:
          type: boolean
        reply:
          type:
            - string
            - 'null'
          description: Our reply (JSON text); null for calls to /v1/requests.
        reply_cut:
          type: boolean
        message:
          type:
            - object
            - 'null'
          description: The message the call made, as it is now.
          properties:
            id:
              type: string
            status:
              type: string
              enum:
                - queued
                - sending
                - accepted
                - sent
                - delivered
                - read
                - failed
                - not_sent
                - not_confirmed
            failure:
              type:
                - object
                - 'null'
              properties:
                code:
                  type: string
                message:
                  type: string
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
            message:
              type: string
            field:
              type: string
              description: The one field that is wrong, when there is one.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Your API key, e.g. gr_live_…

````

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