WhatsApp Business Bot

Get WhatsApp Business Bot Details

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.

get/{Version}/{WABA-Bot-ID}

Request

  • Base URL
    https://graph.facebook.com
  • URL
    https://graph.facebook.com/{Version}/{WABA-Bot-ID}
  • Auth
    HTTP bearer

Path parameters

Versionstring required

Graph API version to use for this request. Determines the API behavior and available features.

WABA-Bot-IDstring required

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.

Query parameters

fieldsstring

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

Headers

User-Agentstring
Example:Meta-Business-Messaging-OpenAPI/1.0.0;spec=2025-10-21

The user agent string identifying the client software making the request.

Authorizationstring required
Example:Bearer EAABwzLixnjYBOzYmNMJJGfHq9DgNh...

Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token.

Response

Successfully retrieved WhatsApp Business Bot details

idstring required

Unique identifier for the WhatsApp Business Bot

promptsstring[]

List of bot prompts and automated responses

enable_welcome_messageboolean

Whether the welcome message is enabled for this bot

Example response

{
  "id": "1234567890123456",
  "prompts": [
    "Welcome to our service!",
    "How can I help you today?"
  ],
  "commands": [
    {
      "command_name": "help",
      "command_description": "Display available commands and help information"
    }
  ],
  "enable_welcome_message": true
}

Changes

No recorded changes to this operation across all 5 revisions of this API.