SendListMessage#

Este método destina-se a enviar uma mensagem com um botão de escolha a partir de uma lista de valores para um chat pessoal ou em grupo. A mensagem será enfileirada para envio. As mensagens enfileiradas para envio são armazenadas por 24 horas na fila e serão enviadas assim que o telefone for autorizado. A velocidade de envio das mensagens enfileiradas é controlada pelo parâmetro Intervalo de Envio de Mensagens.

Requisição#

Para enviar, é necessário fazer uma solicitação para o seguinte endereço:

POST https://api.green-api.com/waInstance{{idInstance}}/SendListMessage/{{apiTokenInstance}}

Para obter os parâmetros da solicitação idInstance e apiTokenInstance, consulte a seção Antes de Começar.

Recursos ao Trabalhar com Botões#

O número de botões pode variar de 3 a 10;
O nome de um botão pode ter até 24 caracteres;
Os nomes dos itens do menu podem se repetir.

Parâmetros da Solicitação#

Parâmetro	Tipo	Obrigatório	Descrição
`chatId`	string	Sim	Identificador do chat
`message`	string	Sim	Texto da mensagem. Emojis são suportados 😃
`title`	string	Não	Título da mensagem.
`footer`	string	Não	Rodapé da mensagem. Útil para destacar visualmente o texto relacionado aos botões.
`buttonText`	string	Sim	Texto na lista de botões de escolha.
`sections`	array	Sim	Valores da lista de escolha.
`quotedMessageId`	string	Não	Identificador da mensagem citada. Se especificado, a mensagem será enviada com citação da mensagem especificada no chat.
`archiveChat`	boolean	Não	Arquiva o chat para o qual a mensagem é enviada. Pode ser true

Campos do array sections

Parâmetro	Tipo	Descrição
`title`	string	Título da lista de escolha.
`rows`	array	Valores da lista de escolha.

Campos do array rows

Parâmetro	Tipo	Descrição
`title`	string	Texto do valor da lista.
`rowId`	string	Identificador do valor da lista.

O comprimento máximo de uma mensagem de texto é 4096 caracteres.

Exemplo de Corpo de Solicitação#

Enviando uma mensagem para um chat pessoal:

{{
    "chatId": "11001234567@c.us",
    "message": "Texto da mensagem",
    "title": "Título",
    "footer": "Rodapé",
    "buttonText": "Lista de Ações",
    "sections": [
        {
            "title": "Seção 1",
            "rows": [
                {
                    "title": "Opção 1",
                    "rowId": "option1"
                },
                {
                    "title": "Opção 2",
                    "rowId": "option2",
                    "description": "Explicação"
                }
            ]
        },
        {
            "title": "Seção 2",
            "rows": [
                {
                    "title": "Opção 3",
                    "rowId": "option3"
                },
                {
                    "title": "Opção 4",
                    "rowId": "option4",
                    "description": "Explicação"
                }
            ]
        }
    ]
}

Resposta#

Campos da resposta#

Campo	Tipo	Descrição
`idMessage`	string	Identificador da mensagem enviada

Exemplo de corpo de resposta#

{
    "idMessage": "3EB0C767D097B7C7C030"
}

Exemplo de Exibição para o Destinatário#

Exemplo de lista de ações

Erros em SendListMessage#

Consulte a seção Erros Comuns para uma lista de erros que são comuns a todos os métodos.

Possíveis Erros

Ao usar o método SendListMessage, as mensagens podem não ser exibidas nas versões web, desktop e móvel do aplicativo. A capacidade de enviar mensagens com botões foi implementada por nós de maneira de baixo nível. O cliente oficial do WhatsApp Web não oferece a funcionalidade de envio de botões. A estabilidade do método SendListMessage depende principalmente das constantes mudanças feitas pelo WhatsApp em seu funcionamento.

Recomendamos sempre duplicar os botões usando mensagens regulares.

Por exemplo, use números para indicar a escolha.

Escolha a ação:

1 - ação 1

2 - ação 2

3 - ação 3

Exemplo de curl#

curl --location --request POST 'https://api.green-api.com/waInstance{{idInstance}}/sendListMessage/{{apiTokenInstance}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "chatId": "11001234567@c.us",
    "message": "Texto da mensagem",
    "buttonText": "Lista de Ações",
    "title": "Título",
    "footer": "Rodapé",
    "sections": [
        {
            "title": "Seção 1",
            "rows": [
                {
                    "title": "Opção 1",
                    "rowId": "option1"
                },
                {
                    "title": "Opção 2",
                    "rowId": "option2",
                    "description": "Explicação"
                }
            ]
        },
        {
            "title": "Seção 2",
            "rows": [
                {
                    "title": "Opção 3",
                    "rowId": "option3"
                },
                {
                    "title": "Opção 4",
                    "rowId": "option4",
                    "description": "Explicação"
                }
            ]
        }
    ]
}'