Skip to main content
POST
/
api
/
sendPoll
Enviar uma enquete com opções
curl --request POST \
  --url https://{host}/api/sendPoll \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "chatId": "[email protected]",
  "poll": {
    "name": "Qual o melhor horário para a reunião?",
    "options": [
      "Manhã (9h)",
      "Tarde (14h)",
      "Noite (19h)"
    ],
    "multipleAnswers": false
  },
  "session": "my-session",
  "reply_to": null
}
'
{
  "success": true,
  "messageId": "3EB0XXXXXX"
}

​
Descrição

Este endpoint permite enviar uma enquete (poll) para contatos individuais ou grupos no WhatsApp. Você pode criar enquetes com múltiplas opções e configurar se permite respostas múltiplas ou apenas uma resposta.

​
Body

{
  "sessionId": "my-session",
  "jid": "[email protected]",
  "poll": {
    "name": "Meu Grupo",
    "options": [
      "Opção 1",
      "Opção 2"
    ],
    "multipleAnswers": true
  }
}

​
Parâmetros do Body

PropriedadeTipoObrigatórioDescrição
sessionIdstring✅ SimID da sessão autenticada que enviará a enquete
jidstring✅ SimIdentificador do destinatário (JID do WhatsApp). Formato: [email protected] para contatos ou [email protected] para grupos
pollobject✅ SimObjeto contendo as informações da enquete
poll.namestring✅ SimPergunta ou título da enquete
poll.optionsarray✅ SimArray de strings com as opções de resposta (mínimo 2 opções)
poll.multipleAnswersboolean❌ NãoDefine se permite múltiplas respostas (padrão: false)
{
  "success": true,
  "messageId": "3EB0XXXXXX"
}

​
Códigos de Status

  • 200 - Enquete enviada com sucesso
  • 400 - Parâmetros inválidos
  • 401 - Sessão não autorizada
  • 404 - Sessão não encontrada

​
Exemplo de Uso

curl -X POST https://api.wappfy.com.br/api/sendPoll \
  -H "Content-Type: application/json" \
  -d '{
    "sessionId": "my-session",
    "jid": "[email protected]",
    "poll": {
      "name": "Qual o melhor horário para a reunião?",
      "options": ["Manhã (9h)", "Tarde (14h)", "Noite (19h)"],
      "multipleAnswers": false
    }
  }'

Authorizations

​
apikey
string
header
required

Sua chave de API do Wappfy (obtenha em dash.wappfy.com.br)

Body

application/json
​
chatId
string
required

Identificador do chat (JID do WhatsApp)

Example:

"[email protected]"

​
poll
object
required

Objeto contendo as informações da enquete

​
session
string
required

Nome da sessão (instanceName)

Example:

"my-session"

​
reply_to
string

ID da mensagem à qual você deseja responder

Example:

null

Response

201 - undefined