Pular para o conteúdo principal
POST
/
group
/
create
curl --request POST \ --url https://api.zappfy.io/group/create \ --header 'Content-Type: application/json' \ --header 'token: <api-key>' \ --data ' { "name": "Meu Novo Grupo", "participants": [ "5521987905995" ] } '
{
  "JID": "jid8@g.us",
  "OwnerJID": "1232@s.whatsapp.net",
  "Name": "Grupo de Suporte",
  "NameSetAt": "2023-11-07T05:31:56Z",
  "NameSetBy": "<string>",
  "Topic": "<string>",
  "IsLocked": true,
  "IsAnnounce": true,
  "AnnounceVersionID": "<string>",
  "IsEphemeral": true,
  "DisappearingTimer": 1,
  "IsIncognito": true,
  "IsParent": true,
  "IsJoinApprovalRequired": true,
  "LinkedParentJID": "<string>",
  "IsDefaultSubGroup": true,
  "GroupCreated": "2023-11-07T05:31:56Z",
  "ParticipantVersionID": "<string>",
  "Participants": [
    "<unknown>"
  ],
  "OwnerCanSendMessage": true,
  "OwnerIsAdmin": true,
  "DefaultSubGroupId": "<string>",
  "invite_link": "<string>",
  "request_participants": "<string>"
}

Autorizações

​
token
string
header
obrigatório

Corpo

application/json
​
name
string
obrigatório

Nome do grupo

Required string length: 1 - 100
Exemplo:

"ZappFy grupo"

​
participants
string[]
obrigatório

Lista de números de telefone dos participantes iniciais

Required array length: 1 - 50 elements

Número de telefone sem formatação

Exemplo:
["5521987905995", "5511912345678"]

Resposta

Grupo criado com sucesso

Representa um grupo/conversa coletiva

​
JID
string<jid>

Identificador único do grupo

Exemplo:

"jid8@g.us"

​
OwnerJID
string<jid>

JID do proprietário do grupo

Exemplo:

"1232@s.whatsapp.net"

​
Name
string

Nome do grupo

Exemplo:

"Grupo de Suporte"

​
NameSetAt
string<date-time>

Data da última alteração do nome

​
NameSetBy
string<jid>

JID do usuário que definiu o nome

​
Topic
string

Descrição do grupo

​
IsLocked
boolean

Indica se apenas administradores podem editar informações do grupo

  • true = apenas admins podem editar
  • false = todos podem editar
Exemplo:

true

​
IsAnnounce
boolean

Indica se apenas administradores podem enviar mensagens

​
AnnounceVersionID
string

Versão da configuração de anúncios

​
IsEphemeral
boolean

Indica se as mensagens são temporárias

​
DisappearingTimer
integer

Tempo em segundos para desaparecimento de mensagens

Intervalo obrigatório: x >= 0
​
IsIncognito
boolean

Indica se o grupo é incognito

​
IsParent
boolean

Indica se é um grupo pai (comunidade)

​
IsJoinApprovalRequired
boolean

Indica se requer aprovação para novos membros

​
LinkedParentJID
string<jid>

JID da comunidade vinculada

​
IsDefaultSubGroup
boolean

Indica se é um subgrupo padrão da comunidade

​
GroupCreated
string<date-time>

Data de criação do grupo

​
ParticipantVersionID
string

Versão da lista de participantes

​
Participants
any[]

Lista de participantes do grupo

​
MemberAddMode
enum<string>

Modo de adição de novos membros

Opções disponíveis:
admin_add,
all_member_add
​
OwnerCanSendMessage
boolean

Verifica se é possível você enviar mensagens

​
OwnerIsAdmin
boolean

Verifica se você adminstrador do grupo

​
DefaultSubGroupId
string

Se o grupo atual for uma comunidade, nesse campo mostrará o ID do subgrupo de avisos

​
invite_link
string

Link de convite para entrar no grupo

​
request_participants
string

Lista de solicitações de entrada, separados por vírgula