Skip to content

Send List

List Messages May Stop Working Anytime

List Messages are fragile creatures and may stop working at any time.

We recommend adding fallback logic using Send Text or 📶 Polls.

Only Direct Message Chats

List Messages can only be sent to direct chats (1:1).

The chatId must be one of the following formats: phone, [email protected], {number}@lids.

Usage

The Message facade's sendList method may be used to send an interactive list message to a chat.

php
use NjoguAmos\Waha\Facades\Message;
use NjoguAmos\Waha\Dto\MessageListData;
use NjoguAmos\Waha\Dto\MessageListRowData;
use NjoguAmos\Waha\Dto\MessageListSectionData;

$data = new MessageListData(
    chatId: '[email protected]',
    title: 'Simple Menu',
    button: 'Choose',
    sections: [
        new MessageListSectionData(
            title: 'Main',
            rows: [
                new MessageListRowData(title: 'Option 1', rowId: 'option1'),
                new MessageListRowData(title: 'Option 2', rowId: 'option2', description: 'Second option'),
            ],
        ),
    ],
    description: 'Please choose an option',
    footer: 'Thank you!',
);

/** @var \Saloon\Http\Response $response */
$response = Message::sendList(data: $data);

Response

The response returned by the sendList method is an instance of Saloon\Http\Response. You may use the json method to retrieve the response as an array:

php
/** @var \Saloon\Http\Response $response */

$response->status(); // 201
$response->json();   // ["id" => "[email protected]_BAE6A33293978B16", "timestamp" => 1629200000, ...]

Engines

WEBJSWPPNOWEBGOWS

References

Released under the MIT License.