Pular para o conteúdo principal
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
create-group
Criando grupos
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/create-group \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "autoInvite": true,
  "groupName": "<string>",
  "phones": [
    {}
  ]
}
'
{
  "phone": "<string>",
  "phonesNotAdded": [
    {}
  ],
  "invitationLink": "<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

Este método é responsável por criar um grupo com seus respectivos participantes.
Não é possível adicionar imagem durante a criação, mas você pode adicioná-la depois utilizando o método de atualizar imagem do grupo.
Você não deve passar o número conectado na lista de participantes. É necessário pelo menos um contato para criar o grupo, assim como no WhatsApp Web.
Ao criar um novo grupo, é necessário utilizar exclusivamente números de telefone. A identificação @lid não é compatível com a criação de grupos — caso seja enviada, o grupo será criado normalmente, porém o participante com @lid não será incluído e seu identificador será retornado no campo phonesNotAdded.

​
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
Define se será enviado um convite privado para os participantes que não puderem ser adicionados diretamente
​
groupName
string
obrigatório
Nome do grupo
​
phones
array
obrigatório
Lista de números de telefone dos participantes

​
Request Body

{
  "autoInvite": true,
  "groupName": "Grupo Z-API",
  "phones": ["5544999999999", "5544888888888"]
}

​
Response

​
200

​
phone
string
ID/Phone do grupo criado
​
phonesNotAdded
array
Lista de identificadores que não foram adicionados ao grupo. Um participante pode aparecer aqui por dois motivos:
  • Uso de @lid: identificadores no formato @lid não são suportados na criação de grupos. O grupo será criado normalmente, mas o participante com @lid ficará de fora e seu identificador será listado aqui.
  • Falta de permissão (autoInvite): quando um número não pode ser adicionado diretamente ao grupo e autoInvite está habilitado, um convite privado é enviado a ele. Enquanto o convite não é aceito, o número é retornado neste campo.
​
invitationLink
string
Link de convite do grupo
{
  "phone": "120363019502650977-group",
  "phonesNotAdded": [
    "2111897971174599@lid",
    "5544777777777"
  ],
  "invitationLink": "https://chat.whatsapp.com/GONwbGGDkLe8BifUWwLgct"
}

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