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>"
    }
  ]
}
'
import requests

url = "https://api.z-api.io/instances/{instanceId}/token/{token}/send-poll"

payload = {
    "phone": "<string>",
    "message": "<string>",
    "poll": [{ "name": "<string>" }]
}
headers = {
    "Client-Token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'Client-Token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({phone: '<string>', message: '<string>', poll: [{name: '<string>'}]})
};

fetch('https://api.z-api.io/instances/{instanceId}/token/{token}/send-poll', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.z-api.io/instances/{instanceId}/token/{token}/send-poll",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'phone' => '<string>',
    'message' => '<string>',
    'poll' => [
        [
                'name' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Client-Token: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.z-api.io/instances/{instanceId}/token/{token}/send-poll"

	payload := strings.NewReader("{\n  \"phone\": \"<string>\",\n  \"message\": \"<string>\",\n  \"poll\": [\n    {\n      \"name\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Client-Token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.z-api.io/instances/{instanceId}/token/{token}/send-poll")
  .header("Client-Token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"phone\": \"<string>\",\n  \"message\": \"<string>\",\n  \"poll\": [\n    {\n      \"name\": \"<string>\"\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.z-api.io/instances/{instanceId}/token/{token}/send-poll")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Client-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"phone\": \"<string>\",\n  \"message\": \"<string>\",\n  \"poll\": [\n    {\n      \"name\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

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.

Exemplo no WhatsApp


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": "120363019502650977-group",
  "message": "Qual a melhor API para WhatsApp?",
  "poll": [
    { "name": "Z-API" },
    { "name": "Outras" }
  ]
}
Escolha única:
{
  "phone": "120363019502650977-group",
  "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