Saltar al contenido principal
GET
/
api
/
chat
/
poll
/
:instance
Votos de la encuesta
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 o TokenInstance • Rate-limit: Global (100/min) • Idempotente: sí

​
Descripción

Devuelve los votos de una encuesta enviada por la instancia. La respuesta incluye:
  • Agregados por opción (votes[]), nombre de la opción y total.
  • Detalle voto por voto (voteDetails[]), quién votó, en qué opción, cuándo.
optionHash es el SHA256(optionName) en mayúsculas, usado por WhatsApp para anonimizar los votos en el protocolo. Útil para correlacionar votos crudos con sus opciones.

​
Ejemplo

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

​
Respuesta exitosa

El envoltorio trae messageId de la encuesta y el objeto data (PollResult) con la pregunta en name, el conteo agregado por opción en votes y la lista detallada de votos en voteDetails. Usa votes[].optionVoteCount para los totales por opción y voteDetails cuando necesites saber quién votó por qué.
200 OK
{
  "success": true,
  "message": "Poll votes retrieved successfully",
  "messageId": "3EB08FCF27E532F1B0F5",
  "data": {
    "messageId": "3EB08FCF27E532F1B0F5",
    "name": "Which flavor?",
    "votes": [
      { "optionName": "Chocolate", "optionVoteCount": 5 },
      { "optionName": "Vanilla", "optionVoteCount": 3 }
    ],
    "voteDetails": [
      {
        "optionHash": "A1B2C3D4E5F6...",
        "optionName": "Chocolate",
        "senderJid": "5511999999999",
        "voteMessageId": "msg_abc",
        "createdAt": "2026-04-28T10:00:00Z"
      }
    ]
  }
}

​
Parámetros de ruta

​
instance
string
requerido
Nombre de la instancia.

​
Parámetros de consulta

​
messageId
string
requerido
ID del mensaje de encuesta.

​
Cabeceras

NombreRequeridoEjemploDescripción
tokensí (o Authorization)a1b2c3d4-...TokenAccount o TokenInstance.

​
Respuestas de error

HTTPerror.messageCuándo ocurre
400Instance name is required—
400messageId query parameter is required—
401Invalid token—
404Instance not found—
404Poll not foundEl messageId no corresponde a una encuesta.
Error 404
{
  "success": false,
  "error": { "message": "Poll not found" }
}

​
Relacionados

Enviar encuesta

Crea una encuesta.

Buscar mensaje

Recupera la encuesta original.