Sign in

v1

latestOpenAPI 3.1.02026-07-1413113265.9 KB
message

get poll votes

Retrieves the vote information for a specific poll message, including who voted for which options and the original poll message details.

post/instances/{id}/client/action/get-poll-votes

Path parameters

idinteger required

Instance ID

Request body

messageIdstring required

Serialized message identifier of the poll message

Example request

{
  "messageId": "true_1234567890@c.us_ABCDEF1234567890_out"
}

Response

Poll votes retrieved successfully

statusstring
instanceIdstring

Example response

{
  "status": "success",
  "instanceId": "12345",
  "data": {
    "messageId": "true_1234567890@c.us_ABCDEF1234567890_out",
    "votes": [
      {
        "voter": "1234567890@c.us",
        "selectedOptions": [
          {
            "name": "Green",
            "localId": 2
          }
        ],
        "interractedAtTs": 1700000000000,
        "parentMessage": {
          "id": {
            "fromMe": true,
            "remote": "1234567890@c.us",
            "id": "ABCDEF1234567890",
            "_serialized": "true_1234567890@c.us_ABCDEF1234567890_out"
          },
          "ack": 3,
          "body": "What's your favorite color?",
          "type": "poll_creation",
          "from": "1234567890@c.us",
          "to": "1234567890@c.us",
          "pollName": "What's your favorite color?",
          "pollOptions": [
            {
              "name": "Red",
              "localId": 0
            },
            {
              "name": "Blue",
              "localId": 1
            },
            {
              "name": "Green",
              "localId": 2
            }
          ]
        }
      }
    ]
  }
}