Send WhatsApp Interactive List Message

Endpoint

POST /api/messages/send

Base URL

https://api.rampwin.com

Description

This API allows you to send list-based interactive messages where users can choose one option from a structured list.
Useful for menus, selections, and guided user flows.

When to Use

Use this API when you want to:

Show multiple selectable options
Create menus (e.g., services, categories)
Guide users through structured choices

Authentication

API Key

Query Parameters

Parameter	Type	Required	Description
dontShowInChatList	boolean	No	Hide message from chat list (default: false)

Headers

Header	Type	Required	Description
X-API-Key	string	Yes	Your Rampwin API key
Content-Type	string	Yes	application/json

Request Body

{
  "channel_id": "CHANNEL_ID",
  "phone_number": "919999999999",
  "hide_from_chat": false,
  "interactive": {
    "type": "list",
    "body": {
      "text": "Hello"
    },
    "action": {
      "button": "Select",
      "sections": [
        {
          "title": "Section 1",
          "rows": [
            {
              "id": "row_1",
              "title": "Row 1",
              "description": "desc"
            },
            {
              "id": "row_2",
              "title": "Row 2",
              "description": "desc"
            }
          ]
        },
        {
          "title": "Section 2",
          "rows": [
            {
              "id": "row_3",
              "title": "Row 3",
              "description": "desc"
            },
            {
              "id": "row_4",
              "title": "Row 4",
              "description": "desc"
            }
          ]
        }
      ]
    },
    "footer": {
      "text": "Thank You"
    }
  }
}

Request Parameters

Field	Type	Required	Description
channel_id	string	Yes	WhatsApp channel ID
phone_number	string	Yes	Recipient phone number (with country code)
hide_from_chat	boolean	No	Hide message in chat UI
interactive	object	Yes	Interactive list object

Example Request

curl --location 'https://api.rampwin.com/api/messages/send?dontShowInChatList=false' \
--header 'X-API-Key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
  "channel_id": "YOUR_CHANNEL_ID",
  "phone_number": "919999999999",
  "hide_from_chat": false,
  "interactive": {
    "type": "list",
    "body": {
      "text": "Hello"
    },
    "action": {
      "button": "Select",
      "sections": [
        {
          "title": "Section 1",
          "rows": [
            {
              "id": "row_1",
              "title": "Row 1",
              "description": "desc"
            },
            {
              "id": "row_2",
              "title": "Row 2",
              "description": "desc"
            }
          ]
        }
      ]
    },
    "footer": {
      "text": "Thank You"
    }
  }
}'

Response

Success (200)

{
  "success": true,
  "message": "Interactive list message sent successfully"
}

Error (400)

{
  "success": false,
  "message": "Invalid interactive list payload"
}

Common Errors

Error	Description
Invalid sections	गलत section/row structure
Missing button	Action button text required
Too many rows	Exceeds WhatsApp limits
Unauthorized	Invalid API key