openapi: 3.0.3
info:
  title: 'WhatsApp Business API Documentation'
  description: 'OpenAPI spec for WhatsApp Business API'
  version: 1.0.0
servers:
  -
    url: 'https://digichat.digiworld-dev.com'
tags:
  -
    name: 'WhatsApp API'
    description: ''
paths:
  '/api/whatsapp/{token}/ping':
    get:
      summary: 'Ping the server'
      operationId: pingTheServer
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            text/plain:
              schema:
                type: string
                example: 'Server is running'
        401:
          description: ''
          content:
            text/plain:
              schema:
                type: string
                example: 'Invalid or expired token'
        429:
          description: ''
          content:
            text/plain:
              schema:
                type: string
                example: 'Too many requests'
      tags:
        - 'WhatsApp API'
    parameters:
      -
        in: path
        name: token
        description: 'Your API access token'
        example: consequatur
        required: true
        schema:
          type: string
  '/api/whatsapp/{token}/status':
    get:
      summary: 'Get session status'
      operationId: getSessionStatus
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  success: true
                  state: CONNECTED
                  message: session_connected
                properties:
                  success:
                    type: boolean
                    example: true
                  state:
                    type: string
                    example: CONNECTED
                  message:
                    type: string
                    example: session_connected
        401:
          description: ''
          content:
            text/plain:
              schema:
                type: string
                example: 'Invalid or expired token'
        429:
          description: ''
          content:
            text/plain:
              schema:
                type: string
                example: 'Too many requests'
      tags:
        - 'WhatsApp API'
    parameters:
      -
        in: path
        name: token
        description: 'Your API access token'
        example: consequatur
        required: true
        schema:
          type: string
  '/api/whatsapp/{token}/terminate':
    get:
      summary: 'Terminate session'
      operationId: terminateSession
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  success: true
                  message: 'Logged out successfully'
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: 'Logged out successfully'
        401:
          description: ''
          content:
            text/plain:
              schema:
                type: string
                example: 'Invalid or expired token'
        429:
          description: ''
          content:
            text/plain:
              schema:
                type: string
                example: 'Too many requests'
      tags:
        - 'WhatsApp API'
    parameters:
      -
        in: path
        name: token
        description: 'Your API access token'
        example: consequatur
        required: true
        schema:
          type: string
  '/api/whatsapp/{token}/qr':
    get:
      summary: 'Get QR code'
      operationId: getQRCode
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            text/plain:
              schema:
                type: string
                example: 'QR code data'
        401:
          description: ''
          content:
            text/plain:
              schema:
                type: string
                example: 'Invalid or expired token'
        429:
          description: ''
          content:
            text/plain:
              schema:
                type: string
                example: 'Too many requests'
      tags:
        - 'WhatsApp API'
    parameters:
      -
        in: path
        name: token
        description: 'Your API access token'
        example: consequatur
        required: true
        schema:
          type: string
  '/api/whatsapp/{token}/qr/image':
    get:
      summary: 'Get QR code image'
      operationId: getQRCodeImage
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            text/plain:
              schema:
                type: string
                example: image/png
        401:
          description: ''
          content:
            text/plain:
              schema:
                type: string
                example: 'Invalid or expired token'
        429:
          description: ''
          content:
            text/plain:
              schema:
                type: string
                example: 'Too many requests'
      tags:
        - 'WhatsApp API'
    parameters:
      -
        in: path
        name: token
        description: 'Your API access token'
        example: consequatur
        required: true
        schema:
          type: string
  '/api/whatsapp/{token}/sendMessage':
    post:
      summary: 'Send message'
      operationId: sendMessage
      description: ''
      parameters:
        -
          in: header
          name: X-API-Timestamp
          description: ''
          example: 'integer required Unix timestamp in milliseconds. Should match the client time when the request is made.'
          schema:
            type: string
        -
          in: header
          name: X-API-Signature
          description: ''
          example: 'string required HMAC-SHA256 signature of (timestamp + token + request body) using your API secret.'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  success: true
                  message_id: ABC123456
                  message: 'Message sent successfully'
                properties:
                  success:
                    type: boolean
                    example: true
                  message_id:
                    type: string
                    example: ABC123456
                  message:
                    type: string
                    example: 'Message sent successfully'
        400:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  success: false
                  message: 'Invalid request data'
                properties:
                  success:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Invalid request data'
        401:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  success: false
                  message: 'Invalid or expired token'
                properties:
                  success:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Invalid or expired token'
        429:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  success: false
                  message: 'Too many requests'
                properties:
                  success:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: 'Too many requests'
      tags:
        - 'WhatsApp API'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                phone:
                  type: string
                  description: 'Recipient phone number in format `9639xxxxxxxx`.'
                  example: '"963912345678"'
                  nullable: false
                message:
                  type: string
                  description: 'Text message content to send.'
                  example: '"Hello from our API!"'
                  nullable: false
              required:
                - phone
                - message
    parameters:
      -
        in: path
        name: token
        description: 'Your API access token (included in URL).'
        example: consequatur
        required: true
        schema:
          type: string