Wozapfy/ docsAbrir painel ↗

Enviar mensagem com lista de opções

Enviar mensagem com lista de opções para um número ou grupo no WhatsApp.

A mensagem é persistida e o id retornado identifica-a nos webhooks NEW-MESSAGE e MESSAGE-UPDATED.

POSThttps://api.wozapfy.com/v1/instance/{instanceKey}/token/{instanceToken}/message?type=list

Path Parameters

NomeTipoDescrição
instanceKey*StringKey de identificação da instância.
instanceToken*StringToken de acesso da instância.

Query Parameters

NomeTipoDescrição
type*StringValor deve ser list.

Request Body

NomeTipoDescrição
destination*StringTelefone com DDI e DDD, formatado ou não (ex.: +55 61 9551-4650), ou JID de grupo terminado em @g.us.
text*StringTexto a ser enviado (até 65.536 caracteres).
sections*ListSection[]1 a 10 seções { title, rows: [{ id, title }] }, até 10 linhas por seção.
buttonTextStringTexto do botão que abre a lista (até 20 caracteres).
titleStringTítulo da lista.
footerStringTexto do rodapé.

Exemplo de body

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

Respostas

200 Mensagem agendada

{
  "result": {
    "id": "c67fad44-c6eb-4ba2-9f4e-ddc5b526dbe9"
  },
  "message": "MESSAGE_SCHEDULED",
  "isValid": true
}
Diferença conhecida: title de cada seção é obrigatório na Wozapfy.