Criar grupo
POST
/rest/group/{{instance_key}}/createCONCEITO
Criar um novo grupo
Request Body
Atributos | Tipo | Descrição |
---|---|---|
group_name | string | Nome do Grupo |
participants | array | Lista de contatos que serão adicionados no grupo ( EX: 551199999999@s.whatsapp.net ) |
Response 200
Atributos | Tipo | Descrição |
---|---|---|
error | boolean | Status do retorno |
message | string | Mensagem do retorno |
id | string | ID do grupo |
subject | string | Nome do grupo |
creation | number | Data e Hora que o grupo foi criado |
owner | string | Contato do criador do grupo |
restrict | boolean | true - Somente Admin podem fazer alterações false - Todos os participantes podem fazer alterações |
announce | boolean | true - Somente Admin podem enviar mensagens false - Todos os participantes podem enviar mensagens |
participants | array | Lista com os participantes que foram adicionados |
id | string | Contato whatsapp |
admin | string | null - Não é administrador superadmin - Contato é um administrador do grupo |
Request
Parâmetros Header
Authorization
string
requerido
Exemplo:
Bearer {{token}}
Parâmetros Bodytext/plain
Exemplo:{
"group_data": {
"group_name": "Nome do Grupo",
"participants": [
"551199999999@s.whatsapp.net"
]
}
}
Request samples
Respostas
create(200)
HTTP Code: 200
Content Type : JSONapplication/json
Esquema de Dados
error
boolean
requerido
message
string
requerido
group
object
requerido
id
string
requerido
subject
string
requerido
creation
integer
requerido
owner
string
requerido
restrict
boolean
requerido
announce
boolean
requerido
participants
array [object {2}]
requerido
Exemplocreate
{
"error": false,
"message": "Group created",
"group": {
"id": "120363041490582303@g.us",
"subject": "Nome do Grupo",
"creation": 1658323320,
"owner": "551188888888@s.whatsapp.net",
"restrict": false,
"announce": false,
"participants": [
{
"id": "551188888888@s.whatsapp.net",
"admin": "superadmin"
},
{
"id": "551199999999@s.whatsapp.net",
"admin": null
}
]
}
}