Zapfy
  • 😎Introdução
  • Integrando com a API
    • 🤖Instance
      • 🤖Introdução
      • ▶️Conectar à uma instância
      • 🧐Buscar status da instância
      • ⛔Desconectar uma instância
      • 🌐Atualizar url de webhook delivery
    • 📱Messages
      • 🥳Introdução
      • 📱Enviar uma mensagem de texto simples
      • 🗺️Enviar uma mensagem de localização
      • ▶️Enviar mensagem com botões
      • ▶️Enviar mensagem com enquete
      • 📖Enviar mensagem com lista de opções
      • 📸Enviar mensagem com imagem
      • 📹Enviar mensagem com video
      • 📹Enviar mensagem de áudio
      • 📄Enviar mensagem de documento
      • ❌Excluir a mensagem
      • ✏️Editar uma mensagem
    • 🙋‍♂️Profile
      • 🥳Introdução
      • 🧐Verificar se um determinado número está no WhatsApp
      • 🤓Buscar status de determinado número
      • 🙆‍♂️Atualizar o status do número conectado na instância
      • ✏️Atualizar o nome do número conectado na instância
      • 🖼️Obter imagem do perfil de um determinado número
      • 🔓Bloquear um perfil através do número
      • 🕊️Desbloquear um perfil através do número
      • 👨‍💼Pesquisar detalhes de um perfil comercial
    • 🫂Grupos
      • 🥳Introdução
      • 👥Criar um novo grupo
      • ✏️Alterar nome de um grupo
      • ✍️Alterar descrição de um grupo
      • 🕵️Buscar informações de um grupo através de seu id
      • 👨‍💻Criar convite do grupo através de seu id
      • 🆕Gerar um novo convite do grupo através de seu id
      • 👀Visualizar detalhes de um grupo através de um convite
      • ✅Aceitar convite de um grupo
      • 🤝Alterar membros de um grupo
      • ⚙️Alterar configurações do grupo
  • Webhooks
    • 🌐Envio/Recebimento de mensagens
      • 🤝Introdução
      • 📱Envio/recebimento de text message
      • ▶️Envio de buttons message
      • 📖Envio de list message
      • 🗺️Envio de location message
      • 📸Envio de image message
      • 📹Envio de video message
      • 🎙️Envio de audio message
      • 📄Envio de document message
      • 👣Alteração de status da mensagem
    • 🤖Alteração de status da Instância
      • 🟢Instância conectada
      • 🔴Instância desconectada
      • 🟠Instância recebeu qualquer tipo de alteração no status
Powered by GitBook
On this page
  • Um pouco sobre lista de opções
  • Exemplo de body a ser enviado:
  • Enviar uma mensagem de lista de opções com texto
  • Webhooks disparados após o envio
  1. Integrando com a API
  2. Messages

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.

PreviousEnviar mensagem com enqueteNextEnviar mensagem com imagem

Last updated 2 years ago

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

📱
📖