Pular para o conteúdo principal
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
add-participant
Adicionar participantes
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/add-participant \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "autoInvite": true,
  "communityId": "<string>",
  "phones": [
    {}
  ]
}
'
import requests

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

payload = {
    "autoInvite": True,
    "communityId": "<string>",
    "phones": [{}]
}
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({autoInvite: true, communityId: '<string>', phones: [{}]})
};

fetch('https://api.z-api.io/instances/{instanceId}/token/{token}/add-participant', 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}/add-participant",
  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([
    'autoInvite' => true,
    'communityId' => '<string>',
    'phones' => [
        [
                
        ]
    ]
  ]),
  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}/add-participant"

	payload := strings.NewReader("{\n  \"autoInvite\": true,\n  \"communityId\": \"<string>\",\n  \"phones\": [\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}/add-participant")
  .header("Client-Token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"autoInvite\": true,\n  \"communityId\": \"<string>\",\n  \"phones\": [\n    {}\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

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

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  \"autoInvite\": true,\n  \"communityId\": \"<string>\",\n  \"phones\": [\n    {}\n  ]\n}"

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

Conceituação

Este método é responsável por adicionar novos participantes à comunidade.
Caso não consiga adicionar diretamente, ao ativar o autoInvite a API envia convites privados com o link da comunidade para os participantes que não foram adicionados.

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

autoInvite
boolean
obrigatório
Envia link de convite da comunidade no privado
communityId
string
obrigatório
ID da comunidade
phones
array
obrigatório
Array com os números dos participantes a serem adicionados

Request Body

{
  "autoInvite": true,
  "communityId": "120363019502650977",
  "phones": ["5544999999999", "5544888888888"]
}

Response

200

{
  "value": true
}

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”.