> ## 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.

# Votos de enquete

> Retorna os votos agregados e o detalhamento por votante de uma enquete

**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.

<Info>
  `optionHash` é o `SHA256(optionName)` em uppercase, usado pelo WhatsApp para anonimizar votos no protocolo. Útil para correlacionar votos brutos com suas opções.
</Info>

## Exemplo

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET "https://ryzeapi.cloud/api/chat/poll/$Instance_Name?messageId=3EB08FCF27E532F1B0F5" \
    -H "token: $Token_Instance"
  ```

  ```javascript JavaScript theme={null}
  await fetch(`https://ryzeapi.cloud/api/chat/poll/${process.env.Instance_Name}?messageId=3EB08FCF27E532F1B0F5`, {
    method: "GET",
    headers: {
      "token": process.env.Token_Instance
    }
  });
  ```

  ```python Python theme={null}
  import os, requests

  requests.get(
      f"https://ryzeapi.cloud/api/chat/poll/{os.environ['Instance_Name']}?messageId=3EB08FCF27E532F1B0F5",
      headers={"token": os.environ["Token_Instance"]}
  )
  ```

  ```go Go theme={null}
  package main

  import (
      "net/http"
      "os"
  )

  func main() {
      req, _ := http.NewRequest("GET", "https://ryzeapi.cloud/api/chat/poll/"+os.Getenv("Instance_Name")+"?messageId=3EB08FCF27E532F1B0F5", nil)
      req.Header.Set("token", os.Getenv("Token_Instance"))
      http.DefaultClient.Do(req)
  }
  ```
</CodeGroup>

## 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ê.

```json 200 OK theme={null}
{
  "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

<ParamField path="instance" type="string" required>
  Nome da instância.
</ParamField>

## Query params

<ParamField query="messageId" type="string" required>
  ID da mensagem da enquete.
</ParamField>

## Headers

| Nome    | Obrigatório              | Exemplo        | Descrição                      |
| ------- | ------------------------ | -------------- | ------------------------------ |
| `token` | sim (ou `Authorization`) | `a1b2c3d4-...` | TokenAccount ou TokenInstance. |

## Respostas de erro

| HTTP | `error.message`                         | Quando ocorre                              |
| ---- | --------------------------------------- | ------------------------------------------ |
| 400  | `Instance name is required`             | ,                                          |
| 400  | `messageId query parameter is required` | ,                                          |
| 401  | `Invalid token`                         | ,                                          |
| 404  | `Instance not found`                    | ,                                          |
| 404  | `Poll not found`                        | `messageId` não corresponde a uma enquete. |

```json Erro 404 theme={null}
{
  "success": false,
  "error": { "message": "Poll not found" }
}
```

## Relacionados

<CardGroup cols={2}>
  <Card title="Enviar enquete" href="/pt/api/messages/poll">
    Criar uma enquete.
  </Card>

  <Card title="Buscar mensagem" href="/pt/api/chat/find-message">
    Recuperar a enquete original.
  </Card>
</CardGroup>