WhatsApp WhatsApp Business Bot API

openapi: 3.2.0
info:
  title: Meta Graph API - Application Connected Client Businesses…
  version: v23.0
  description: 'API for retrieving connected client businesses associated with a Meta application.


    This endpoint allows applications to retrieve information about businesses that have

    established client connections through the application. This is essential for managing

    business relationships and understanding client business configurations.'
  contact:
    name: Meta Business Platform Team
    url: https://developers.facebook.com/support
  license:
    name: Meta Platform Terms
    url: https://developers.facebook.com/terms
  termsOfService: https://developers.facebook.com/terms
servers:
- url: https://graph.facebook.com
  description: Production Graph API server
- url: https://graph.facebook.com
- url: https://graph.facebook.com
  description: WhatsApp Business Cloud API
- url: https://graph.facebook.com
  description: Meta Graph API production server
tags:
- name: WhatsApp Business Bot
  description: APIs for managing WhatsApp Business Bot configuration and details
paths:
  /{Version}/{WABA-Bot-ID}:
    get:
      summary: Get WhatsApp Business Bot Details
      description: 'Retrieve comprehensive details about a WhatsApp Business Bot, including its prompts,

        commands, and welcome message configuration.


        **Use Cases:**

        - Retrieve bot configuration and automated response settings

        - Monitor available bot commands and their descriptions

        - Check welcome message enablement status

        - Validate bot state before implementing automation

        - Audit bot configuration for business compliance


        **Rate Limiting:**

        Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff.


        **Caching:**

        Bot details can be cached for moderate periods, but configuration may change

        when bot settings are updated. Implement appropriate cache invalidation strategies.'
      operationId: getWhatsAppBusinessBotDetails
      tags:
      - WhatsApp Business Bot
      parameters:
      - $ref: '#/components/parameters/UserAgent'
      - $ref: '#/components/parameters/Authorization'
      - name: Version
        in: path
        required: true
        description: 'Graph API version to use for this request. Determines the API behavior and available features.

          '
        schema:
          type: string
          pattern: ^v[0-9]+\.[0-9]+$
        example: v23.0
      - name: WABA-Bot-ID
        in: path
        required: true
        description: 'Your WhatsApp Business Bot ID. This ID is provided when you create the bot

          and can be found in your Business Manager or through bot management APIs.

          '
        schema:
          type: string
          pattern: ^[0-9]+$
        example: '1234567890123456'
      - name: fields
        in: query
        required: false
        description: 'Comma-separated list of fields to include in the response. If not specified,

          default fields will be returned (prompts, commands, enable_welcome_message).

          Available fields: id, prompts, commands, enable_welcome_message

          '
        schema:
          type: string
        example: id,prompts,commands,enable_welcome_message
      responses:
        '200':
          description: Successfully retrieved WhatsApp Business Bot details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WhatsAppBusinessBot'
              examples:
                full_bot_config:
                  summary: Complete bot configuration with all features
                  value:
                    id: '1234567890123456'
                    prompts:
                    - Welcome to our customer service!
                    - How can I assist you today?
                    - Please select from the options below
                    commands:
                    - command_name: help
                      command_description: Display available commands and help information
                    - command_name: status
                      command_description: Check your order status
                    - command_name: support
                      command_description: Connect with customer support
                    enable_welcome_message: true
                minimal_bot_config:
                  summary: Basic bot configuration
                  value:
                    id: '2345678901234567'
                    prompts:
                    - Hello! I'm here to help
                    commands: []
                    enable_welcome_message: false
        '400':
          description: Bad Request - Invalid parameters or malformed request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GraphAPIError'
              example:
                error:
                  message: 'Invalid parameter: waba_bot_id must be a valid numeric string'
                  type: OAuthException
                  code: 100
                  fbtrace_id: AXsgnV2Cm3ZMGF3dF_cfYIn
        '401':
          description: Unauthorized - Invalid or missing access token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GraphAPIError'
              example:
                error:
                  message: Invalid OAuth access token
                  type: OAuthException
                  code: 190
                  error_subcode: 463
                  fbtrace_id: AXsgnV2Cm3ZMGF3dF_cfYIn
        '403':
          description: Forbidden - Insufficient permissions or access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GraphAPIError'
              example:
                error:
                  message: Your app doesn't have permission to access this WhatsApp Business Bot
                  type: OAuthException
                  code: 200
                  error_subcode: 1349174
                  fbtrace_id: AXsgnV2Cm3ZMGF3dF_cfYIn
                  error_user_title: Permission Denied
                  error_user_msg: Your app doesn't have permission to access this resource
        '404':
          description: Not Found - Bot ID does not exist or is not accessible
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GraphAPIError'
              example:
                error:
                  message: WhatsApp Business Bot not found
                  type: GraphMethodException
                  code: 803
                  fbtrace_id: AXsgnV2Cm3ZMGF3dF_cfYIn
        '422':
          description: Unprocessable Entity - Request parameters are valid but cannot be processed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GraphAPIError'
              example:
                error:
                  message: The requested fields are not available for this bot
                  type: GraphMethodException
                  code: 100
                  fbtrace_id: AXsgnV2Cm3ZMGF3dF_cfYIn
        '429':
          description: Too Many Requests - Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GraphAPIError'
              example:
                error:
                  message: Application request limit reached
                  type: OAuthException
                  code: 4
                  error_subcode: 2446079
                  fbtrace_id: AXsgnV2Cm3ZMGF3dF_cfYIn
                  is_transient: true
        '500':
          description: Internal Server Error - Unexpected server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GraphAPIError'
              example:
                error:
                  message: An unexpected error occurred. Please retry your request
                  type: GraphMethodException
                  code: 2
                  fbtrace_id: AXsgnV2Cm3ZMGF3dF_cfYIn
                  is_transient: true
      security:
      - bearerAuth: []
components:
  parameters:
    Authorization:
      name: Authorization
      in: header
      description: 'Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token.

        '
      required: true
      schema:
        type: string
        pattern: ^Bearer\s+[A-Za-z0-9\-_.]+.*$
        example: Bearer EAABwzLixnjYBOzYmNMJJGfHq9DgNh...
    UserAgent:
      name: User-Agent
      in: header
      description: The user agent string identifying the client software making the request.
      required: false
      schema:
        type: string
        default: Meta-Business-Messaging-OpenAPI/1.0.0;spec=2025-10-21
        pattern: ^[a-zA-Z0-9\-_]+\/[0-9]+\.[0-9]+\.[0-9]+(;[a-zA-Z0-9\-=\.]+)?(\s+[a-zA-Z0-9\-_]+\/[0-9\-\.]+)?$
        example: Meta-Business-Messaging-OpenAPI/1.0.0;spec=2025-10-21
  schemas:
    GraphAPIError:
      type: object
      description: Standard Graph API error response
      required:
      - error
      properties:
        error:
          type: object
          required:
          - message
          - type
          - code
          properties:
            message:
              type: string
              description: Human-readable error message
              example: Invalid parameter
            type:
              type: string
              description: Error category type
              example: OAuthException
            code:
              type: integer
              description: Numeric error code
              example: 100
            error_subcode:
              type: integer
              description: More specific error subcode when available
              example: 33
            fbtrace_id:
              type: string
              description: Unique identifier for debugging and support requests with Meta
              example: AXsgnV2Cm3ZMGF3dF_cfYIn
            is_transient:
              type: boolean
              description: Indicates whether this error is temporary and the request should be retried
              example: false
            error_user_title:
              type: string
              description: User-friendly error title for display purposes
              example: Permission Denied
            error_user_msg:
              type: string
              description: User-friendly error message for display purposes
              example: Your app doesn't have permission to access this resource
    WhatsAppBusinessBotCommand:
      type: object
      description: Bot command configuration with name and description
      required:
      - command_name
      - command_description
      properties:
        command_name:
          type: string
          description: Name of the bot command
          example: help
        command_description:
          type: string
          description: Description of what the command does
          example: Display available commands and help information
    WhatsAppBusinessBot:
      type: object
      description: WhatsApp Business Bot configuration and details
      required:
      - id
      properties:
        id:
          type: string
          description: Unique identifier for the WhatsApp Business Bot
          example: '1234567890123456'
        prompts:
          type: array
          description: List of bot prompts and automated responses
          items:
            type: string
          example:
          - Welcome to our service!
          - How can I help you today?
        commands:
          type: array
          description: List of available bot commands and their descriptions
          items:
            $ref: '#/components/schemas/WhatsAppBusinessBotCommand'
        enable_welcome_message:
          type: boolean
          description: Whether the welcome message is enabled for this bot
          example: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'System user access token with whatsapp_business_management permission. Format: Bearer YOUR_SYSTEM_USER_ACCESS_TOKEN

        '