Skip to main content
GET
/
api
/
chat
/
poll
/
:instance
Poll votes
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 or TokenInstance • Rate-limit: Global (100/min) • Idempotent: yes

​
Description

Returns the votes for a poll sent by the instance. The response includes:
  • Aggregated by option (votes[]), option name and total.
  • Detail vote by vote (voteDetails[]), who voted, on which option, when.
optionHash is the SHA256(optionName) in uppercase, used by WhatsApp to anonymize votes in the protocol. Useful to correlate raw votes with their options.

​
Example

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

​
Success response

The envelope brings messageId of the poll and the data object (PollResult) with the question in name, the aggregated count per option in votes, and the detailed vote list in voteDetails. Use votes[].optionVoteCount for per-option totals and voteDetails when you need to know who voted for what.
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"
      }
    ]
  }
}

​
Path parameters

​
instance
string
required
Instance name.

​
Query params

​
messageId
string
required
ID of the poll message.

​
Headers

NameRequiredExampleDescription
tokenyes (or Authorization)a1b2c3d4-...TokenAccount or TokenInstance.

​
Error responses

HTTPerror.messageWhen it happens
400Instance name is required—
400messageId query parameter is required—
401Invalid token—
404Instance not found—
404Poll not foundmessageId does not correspond to a poll.
Error 404
{
  "success": false,
  "error": { "message": "Poll not found" }
}

Send poll

Create a poll.

Find message

Retrieve the original poll.