Skip to main content
POST
Responder lista de opções

Conceituação

Este endpoint permite responder uma lista de opções, simulando o toque do usuário em uma das opções enviadas anteriormente via send-option-list.
A lista precisa ter sido enviada ou recebida previamente. O ID da opção deve ser o mesmo id definido para essa opção no momento do envio da lista ou no webhook recebido.

Exemplo no WhatsApp


Atributos

string
obrigatório
ID da sua instância. Disponível no painel Z-API em Instâncias.
string
obrigatório
Token da sua instância Z-API.

Obrigatórios

string
obrigatório
Telefone (ou ID do grupo) no formato DDI DDD NÚMERO. Ex: 551199999999
string
obrigatório
ID da mensagem de lista de opções que está sendo respondida.
string
obrigatório
ID da opção escolhida. Deve ser o mesmo id definido na lista ao enviá-la.

Request Body

Response

200

string
id no z-api
string
id no whatsapp
string
Adicionado para compatibilidade com zapier, ele tem o mesmo valor do messageId

400

Verifique se o body da requisição foi enviado e se os campos obrigatórios (phone, messageId e responseOptionId) estão preenchidos.

405

Verifique se o método HTTP utilizado está correto (POST).

415

Certifique-se de enviar o header Content-Type: application/json.