Pular para o conteúdo principal
GET
/
api
/
chat
/
poll
/
:instance
Votos de enquete
curl --request GET \
  --url https://api.example.com/api/chat/poll/:instance

Documentation Index

Fetch the complete documentation index at: https://docs.ryzeapi.cloud/llms.txt

Use this file to discover all available pages before exploring further.

Auth: TokenAccount ou TokenInstance • Rate-limit: Global (100/min) • Idempotente: sim

​
Descrição

Retorna os votos de uma enquete enviada pela instância. A resposta inclui:
  • Agregados por opção (votes[]), nome da opção e total.
  • Detalhamento voto a voto (voteDetails[]), quem votou, em qual opção, quando.
optionHash é o SHA256(optionName) em uppercase, usado pelo WhatsApp para anonimizar votos no protocolo. Útil para correlacionar votos brutos com suas opções.

​
Exemplo

curl -X GET "https://ryzeapi.cloud/api/chat/poll/$Instance_Name?messageId=3EB08FCF27E532F1B0F5" \
  -H "token: $Token_Instance"

​
Resposta de sucesso

O envelope traz messageId da enquete e o objeto data (PollResult) com a pergunta em name, a contagem agregada por opção em votes e a lista detalhada de votos em voteDetails. Use votes[].optionVoteCount para totais por opção e voteDetails quando precisar saber quem votou em quê.
200 OK
{
  "success": true,
  "message": "Poll votes retrieved successfully",
  "messageId": "3EB08FCF27E532F1B0F5",
  "data": {
    "messageId": "3EB08FCF27E532F1B0F5",
    "name": "Qual sabor?",
    "votes": [
      { "optionName": "Chocolate", "optionVoteCount": 5 },
      { "optionName": "Baunilha", "optionVoteCount": 3 }
    ],
    "voteDetails": [
      {
        "optionHash": "A1B2C3D4E5F6...",
        "optionName": "Chocolate",
        "senderJid": "5511999999999",
        "voteMessageId": "msg_abc",
        "createdAt": "2026-04-28T10:00:00Z"
      }
    ]
  }
}

​
Parâmetros de rota

​
instance
string
obrigatório
Nome da instância.

​
Query params

​
messageId
string
obrigatório
ID da mensagem da enquete.

​
Headers

NomeObrigatórioExemploDescrição
tokensim (ou Authorization)a1b2c3d4-...TokenAccount ou TokenInstance.

​
Respostas de erro

HTTPerror.messageQuando ocorre
400Instance name is required—
400messageId query parameter is required—
401Invalid token—
404Instance not found—
404Poll not foundmessageId não corresponde a uma enquete.
Erro 404
{
  "success": false,
  "error": { "message": "Poll not found" }
}

​
Relacionados

Enviar enquete

Criar uma enquete.

Buscar mensagem

Recuperar a enquete original.