Ir al contenido

Encuestas ​

Enviar una encuesta ​

Con el mismo endpoint que el texto, POST /api/v1/messages, en JSON. Necesitas el scope messages:send y una instancia conectada. Cuenta como un mensaje y acepta reply_to e Idempotency-Key.

bash
curl -X POST "https://zappio.cloud/api/v1/messages" \
  -H "Authorization: Bearer $ZAPPIO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "instance": "ins_...",
    "to": "5215500000000",
    "type": "poll",
    "poll": { "question": "¿Qué día te entregamos?", "options": ["Lunes", "Martes", "Miércoles"] }
  }'
CampoQué es
poll.questionLa pregunta, hasta 255 caracteres.
poll.optionsDe 2 a 12 opciones distintas, hasta 100 caracteres cada una.
poll.multipleOpcional. true deja elegir más de una opción. Por defecto, una sola respuesta.

Resultados ​

Un mensaje de encuesta (enviado o recibido) trae poll con los resultados al momento:

json
{
  "type": "poll",
  "poll": {
    "question": "¿Qué día te entregamos?",
    "multiple": false,
    "options": [
      { "name": "Lunes", "votes": 0 },
      { "name": "Martes", "votes": 1 },
      { "name": "Miércoles", "votes": 0 }
    ],
    "voters": 1,
    "votes_available": true,
    "votes": [
      { "from": "5255000000002", "from_me": false, "options": ["Martes"], "voted_at": "2026-01-01T12:05:30+00:00" }
    ]
  }
}

Cada persona tiene un voto actual: si cambia de opinión, su voto se reemplaza; si lo quita, desaparece. from es null cuando votó tu número desde su teléfono (from_me: true).

Cada voto, por webhook ​

Suscríbete a message.poll_vote: llega cada vez que alguien vota, cambia su voto o lo quita, con la encuesta actualizada y el voto (vote.options vacío = lo quitó). Las encuestas que crean tus contactos llegan como cualquier mensaje (message.received) y sus votos también se avisan.

Los votos llegan cifrados desde WhatsApp; ZAPPIO los abre con la clave de cada encuesta, que guarda cifrada. Por eso solo se cuentan los votos de encuestas que ZAPPIO tiene: las enviadas o recibidas desde que conectaste el número. Un votante que WhatsApp todavía no identifica (privacidad) no se cuenta.

Encuestas creadas en el teléfono de tu número: WhatsApp no le da su clave a ZAPPIO, así que sus votos no se pueden contar. Llegan con votes_available: false (y 0 votos en cada opción). Para medir respuestas, envía la encuesta por la API.