Pular para o conteúdo principal
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
send-poll
Enviar enquete
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/send-poll \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "<string>",
  "message": "<string>",
  "poll": [
    {
      "name": "<string>"
    }
  ]
}
'

Documentation Index

Fetch the complete documentation index at: https://developer.z-api.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Conceituação

Neste método você poderá enviar mensagens do tipo enquete.
O envio de enquetes está disponível apenas para grupos, seguindo o comportamento do WhatsApp Web.

​
Atributos

​
instanceId
string
obrigatório
ID da sua instância. Disponível no painel Z-API em Instâncias.
​
token
string
obrigatório
Token da sua instância Z-API.

​
Obrigatórios

​
phone
string
obrigatório
ID do grupo destinatário. Esse ID pode ser obtido através do método get/chats
​
message
string
obrigatório
Texto a ser enviado na enquete
​
poll
array
obrigatório
Lista de opções da enquete

​
Opcionais

​
delayMessage
number
Delay adicionado na mensagem. Você pode decidir entre um range de 1 a 15 sec, significa quantos segundos ele vai esperar para enviar a próxima mensagem. (Ex.: “delayMessage”: 5). O delay default caso não seja informado é de 1 a 3 sec
​
pollMaxOptions
number
Número máximo de votos por pessoa na enquete

​
Request Body

Múltiplas escolhas: 
{
  "phone": "5511999999999-1234567890@g.us",
  "message": "Qual a melhor API para WhatsApp?",
  "poll": [
    { "name": "Z-API" },
    { "name": "Outras" }
  ]
}
Escolha única: 
{
  "phone": "5511999999999-1234567890@g.us",
  "message": "Qual a melhor API para WhatsApp?",
  "pollMaxOptions": 1,
  "poll": [
    { "name": "Z-API" },
    { "name": "Outras" }
  ]
}

​
Response

​
200

{
  "zaapId": "3999984263738042930CD6ECDE9VDWSA",
  "messageId": "D241XXXX732339502B68",
  "id": "D241XXXX732339502B68"
}

​
405

Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no início deste tópico.

​
415

Caso você receba um erro 415, certifique de adicionar na headers da requisição o “Content-Type” do objeto que você está enviando, em sua grande maioria “application/json”.

​
Webhook Response

Link para a response do webhook (ao receber) Webhook