Envio de lista de opções

POST/rest/sendMessage/{{instance_key}}/listMessage

CONCEITO

Envie uma mensagem de modelo interativa com listMessage para um usuário do WhatsApp

Request Body

Atributos	Tipo	Descrição
to	string	Contato whatsapp que vai receber a mensagem
buttonText	string	Titulo do botão
text	string	Mensagem
title	string	Titulo da mensagem
description	string	Descrição
sections	array	Lista de sessões
title	string	Titulo da sessão
rows	array	Lista de itens
title	string	Titulo do iten
description	string	Descrição do iten
rowId	string	ID do iten

Response 200

Atributos	Tipo	Descrição
error	boolean	Status do retorno
message	string	Mensagem do retorno da requisição
remoteJid	string	Contato que recebeu a mensagem
formMe	boolean	true - Mensagem Enviada false- Mensagem Recebida
id	string	ID da mensagem
title	string	Titulo
description	string	Descrição
buttonText	string	Titulo do botão
listType	string	Tipo da lista enviada
sections	array	Lista todos os itens que foram criados dentro da sessão
footerText	string	Texto do rodapé
messageTimestamp	string	Data e Hora do arquivo enviado

Request

Authorization: Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Exemplo

Authorization: Bearer 2f68dbbf-519d-4f01-9636-e2421b68f379

Parâmetros Header

Authorization

string

requerido

Exemplo:

Bearer {{token}}

Content-Type

string

opcional

Exemplo:

application/json

Parâmetros Bodytext/plain

Exemplo:{ "messageData": { "to": "551199999999@s.whatsapp.net", "buttonText": "Escolha", "text": "Testanto", "title": "TEste", "description": "Selecione uma forma de pagamento", "sections": [ { "title": "PIX", "rows": [ { "title": "PIX", "description": "pagamento via pix", "rowId": "01" } ] } ], "listType": 0 } }

Request samples

Respostas

listMessage(200)

HTTP Code: 200

Content Type : JSONapplication/json

error

boolean

requerido

message

string

requerido

messageData

object

requerido

key

object

requerido

message

object

requerido

messageTimestamp

string

requerido

status

string

requerido

{
  "error": false,
  "message": "Message sent",
  "messageData": {
    "key": {
      "remoteJid": "5511999999999@s.whatsapp.net",
      "fromMe": true,
      "id": "BAE5403BBB515C2F"
    },
    "message": {
      "listMessage": {
        "title": "TEste",
        "description": "Testanto",
        "buttonText": "Escolha",
        "listType": "SINGLE_SELECT",
        "sections": [
          {
            "title": "PIX",
            "rows": [
              {
                "title": "PIX",
                "description": "pagamento via pix",
                "rowId": "01"
              }
            ]
          }
        ],
        "footerText": "Selecione uma forma de pagamento"
      }
    },
    "messageTimestamp": "1658283308",
    "status": "PENDING"
  }
}