Send List Message API

Api Docs Sending List Messages

Method : POST | GET

Endpoint: {{ url('/') }}/send-list

Request Body : (JSON If POST)

Parameter Type Required Description
api_key string Yes API Key
sender string Yes Number of your device
number string Yes Recipient number ex 72888xxxx | 62888xxxx
name string Yes Name of your list
footer string No Footer of your message
title string Yes Title of your list
buttontext string Yes Text of your button list
message string Yes Text of your message
sections array Yes List of your message (min 1, max 5)
full number No Show full response from WhatsApp

Example Without full

JSON Request

{
    "api_key" : "123456789",
    "sender" : "6281222xxxxx",
    "number" : "628222xxxxxx",
    "name" : "Message list",
    "footer" : "optional",
    "title" : "title list",
    "buttontext" : "Menu",
    "message" : "Hello, this is a list button message",
    "sections": [
        {
            "title": "Main Options",
            "description": "Select a basic option to proceed.",
            "rows": [
                {
                    "title": "Option 1",
                    "rowId": "id1",
                    "description": "Description for option 1"
                },
                {
                    "title": "Option 2",
                    "rowId": "id2",
                    "description": "Description for option 2"
                }
            ]
        },
        {
            "title": "Advanced Options",
            "description": "Explore advanced settings.",
            "rows": [
                {
                    "title": "Option 3",
                    "rowId": "id3",
                    "description": "Description for option 3"
                }
            ]
        }
    ]
}

URL Request

{{ url('/') }}/send-list?api_key=123456789&sender=6281222xxxxxx&number=201111xxxxxx&name=Message list&footer=optional&title=title list&buttontext=Menu&message=Hello, this is a list button message§ions=[{title:Main Options,rows:[{title:Option 1,rowId:id1},{title:Option 2,rowId:id2}]},{title:Advanced Options,rows:[{title:Option 3,rowId:id3}]}]

JSON Response

{
    "status": true,
    "msg": "Message sent successfully!"
}

Example With full

JSON Request

{
    "api_key" : "123456789",
    "sender" : "6281222xxxxx",
    "number" : "628222xxxxxx",
    "name" : "Message list",
    "footer" : "optional",
    "title" : "title list",
    "buttontext" : "Menu",
    "message" : "Hello, this is a list button message",
    "sections": [
        {
            "title": "Main Options",
            "rows": [
                {
                    "title": "Option 1",
                    "rowId": "id1",
                    "description": "Description for option 1"
                },
                {
                    "title": "Option 2",
                    "rowId": "id2",
                    "description": "Description for option 2"
                }
            ]
        },
        {
            "title": "Advanced Options",
            "rows": [
                {
                    "title": "Option 3",
                    "rowId": "id3",
                    "description": "Description for option 3"
                }
            ]
        }
    ],
    "full": 1
}

URL Request

{{ url('/') }}/send-list?api_key=123456789&sender=6281222xxxxxx&number=201111xxxxxx&name=Message list&footer=optional&title=title list&buttontext=Menu&message=Hello, this is a list button message§ions=[{title:Main Options,rows:[{title:Option 1,rowId:id1},{title:Option 2,rowId:id2}]},{title:Advanced Options,rows:[{title:Option 3,rowId:id3}]}]&full=1

JSON Response

{
  "status": true,
  "data": {
    "key": {
      "remoteJid": "628222xxxxxx@c.us",
      "fromMe": true,
      "id": "3EB0310FB8CEXXXXXXXXX"
    },
    "message": {
      "listMessage": {
        "title": "Message list",
        "description": "Hello, this is a list button message",
        "buttonText": "menu",
        "listType": "PRODUCT_LIST",
        "sections": [
          {
            "title": "Main Options",
            "rows": [
              {
                "title": "Option 1",
                "description": "Description for option 1",
                "rowId": "id68a4cecc12968"
              },
              {
                "title": "Option 2",
                "description": "Description for option 2",
                "rowId": "id68a4cecc12969"
              }
            ]
          },
          {
            "title": "Advanced Options",
            "rows": [
              {
                "title": "Option 3",
                "description": "Description for option 3",
                "rowId": "id68a4cecc1296b"
              }
            ]
          }
        ],
        "footerText": "optional",
        "contextInfo": {
          "expiration": 604800
        }
      }
    },
    "messageTimestamp": "1755631308"
  }
}