Referência da APIMensagens
Envia uma enquete
Enfileira o envio de uma enquete (poll nativa do WhatsApp) com a pergunta em name e as alternativas em options (de 2 a 12). selectableCount define quantas opcoes o destinatario pode marcar (1 = escolha unica). O envio e assincrono (resposta 202).
Authorization
bearerAuth AuthorizationBearer <token>
API key enviada como Authorization Bearer pzk_live_... ou pzk_test_...
In: header
Path Parameters
id*string
Identificador da instancia.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/instances/cm5x8a9k20001abc123def456/messages/poll" \ -H "Content-Type: application/json" \ -d '{ "to": "5511999999999", "name": "Qual o melhor horario para o atendimento?", "options": [ "Manha", "Tarde", "Noite" ], "selectableCount": 1 }'{
"queued": true,
"to": "5511999999999"
}{
"error": {
"code": "BAD_REQUEST",
"message": "Body invalido"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "API key ausente ou invalida"
}
}{
"error": {
"code": "PAYMENT_REQUIRED",
"message": "E necessario um plano ativo para usar este recurso. Assine em \"Meu plano\"."
}
}{
"error": {
"code": "FORBIDDEN",
"message": "Projeto inativo ou sem permissao"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Instancia nao encontrada"
}
}{
"error": {
"code": "CONFLICT",
"message": "limite de numeros do plano atingido — adicione um numero em \"Meu plano\""
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "limite diario do sandbox (100 mensagens/dia) atingido. Para volume real, use o ambiente de producao com um plano ativo."
}
}