📖Enviar mensagem com lista de opções

Permite enviar uma mensagem de lista de opções com texto simples para um número cadastrado no WhatsApp.

Um pouco sobre lista de opções

Neste método você poderá enviar mensagens de texto com lista de opções, o conteúdo da lista de opções poderá ser escolhido pelo usuário e será utilizado como resposta da mensagem enviada junto com os botões.

Exemplo de body a ser enviado:

{
    "text": "Lista de frutas.",
    "buttonText": "Visualizar opções",
    "title": "Selecionar uma fruta",
    "destination": "+55 61 9551-4650",
    "sections": [
        {
            "title": "Lista de produtos",
            "rows": [
                { "id": "apple", "title": "Apple" },
                { "id": "mango", "title": "Mango" },
                { "id": "banana", "title": "Banana" }
            ]
        }
    ]
}

Enviar uma mensagem de lista de opções com texto

POST https://api.zapfy.me/v1/instance/{{instanceKey}}/token/{{instanceToken}}/message?type=list

Permite enviar uma mensagem de opções via rest para um contato no WhatsApp, note que essa mensagem será adicionada à uma fila e no momento da requisição será devolvido um id de identificação dessa mensagem, essa fila irá processar o envio da mensagem e depois irá chamar o webhookde delivery da instância que enviou a mensagem.

Após o envio, você receberá um webhook no método post na url da sua instância, veja a página de webhooks que temos aqui na documentação para melhor entendimento do que será enviado:

Webhooks

Path Parameters

Name
Type
Description

instanceKey*

String

instanceToken*

String

Query Parameters

Name
Type
Description

type*

String

Para envio de botões, valor deve ser list

Request Body

Name
Type
Description

text*

String

Texto a ser enviado

destination*

String

Número de telefone do usuário ou id de um grupo.

Exemplo: (556195514650)

Necessário conter DD e DDI.

footer

String

Texto que aparecerá no footer da mensagem

sections*

ListSection[]

Array contendo sessões da lista

buttonText

String

Texto que será exibido no botão para visualizar o conteúdo da lista

{
    "result": {
        "id": "5a8ac0c7-f299-4b7f-a197-3fa4c7ae4dc9"
    },
    "message": "MESSAGE_SCHEDULED",
    "isValid": true
}

Webhooks disparados após o envio

O envio dessa mensagem resultará em webhooks do tipo Envio de list message e Alteração de status da mensagem

Last updated