vértice
Produto Preços Painel
Mensagens

Enviar uma enquete

Envia uma enquete com 2 a 12 opções e define quantas podem ser selecionadas.

API key Escopo write
Exemplo de requisição
curl -X POST "https://seu-dominio/instances/:id/messages/poll" \
  -H "x-api-key: $VERTICE_API_KEY" \
  -H "content-type: application/json" \
  -d '{"to":"5511999999999","name":"Qual o melhor horário?","options":["Manhã","Tarde"],"selectableCount":1}'
POST /instances/{id}/messages/poll
API key
Entenda

Conceituação

Envia uma enquete com 2 a 12 opções e define quantas podem ser selecionadas.

A operação exige que a instância esteja conectada ao WhatsApp. Caso o socket esteja desconectado, a API responde 409 not_connected.

Corpo JSON. Os campos abaixo são exemplos; campos marcados como obrigatórios precisam ser enviados.
Contrato

Atributos

Header

x-api-key string obrigatório

API key do workspace (vtc_live_...). Também aceita Authorization: Bearer.

content-type string obrigatório

application/json.

Path

id string obrigatório

ID da instância.

Body

to string obrigatório

Telefone com DDI e DDD, ou JID de grupo terminando em @g.us.

name string obrigatório

Nome exibido do recurso, contato, enquete ou grupo.

options array<string> obrigatório

Lista com 2 a 12 opções da enquete.

selectableCount integer opcional

Quantas opções o participante pode selecionar.

Payload

Request Body

{
  "to": "5511999999999",
  "name": "Qual o melhor horário?",
  "options": [
    "Manhã",
    "Tarde"
  ],
  "selectableCount": 1
}
Contrato

Resposta

200
{
  "data": {
    "ok": true
  }
}

Respostas de sucesso são envelopadas em data.

Erros comuns

400 Corpo, query ou parâmetro inválido. A resposta traz error.code e error.message.
401 Credencial ausente, inválida ou sessão expirada.
403 Escopo insuficiente, IP não autorizado ou workspace suspenso.
404 Recurso não encontrado ou pertence a outro workspace.
409 Instância não conectada ou conflito de estado.