Groups

Cria um grupo

POSThttp://localhost:8084/instance/{instance}/group

Autenticação

InstanceBearerobrigatório

JWT HS256 da própria instância.

Header: Authorization
Exemplo: Bearer <INSTANCE_TOKEN>

Parâmetros

instancepathobrigatório

string

Nome público da instância

minLength 1

Request body

obrigatório

bodyobject

subjectstringobrigatóriominLength: 1

descriptionstring

participantsarrayobrigatório

items[]stringminLength: 1

Exemplo JSONgerado do schema

{
  "subject": "string",
  "description": "string",
  "participants": [
    "string"
  ]
}

Respostas

application/json

201

Grupo criado

response 201object

idstringobrigatório

subjectstringobrigatório

subjectOwnerstring

subjectTimeinteger

sizeintegerobrigatório

creationinteger

ownerstring

descstring

descIdstring

restrictbooleanobrigatório

announcebooleanobrigatório

isCommunitybooleanobrigatório

isCommunityAnnouncebooleanobrigatório

joinApprovalModebooleanobrigatório

memberAddModebooleanobrigatório

participantsarrayobrigatório

items[]object

idstringobrigatório

phoneNumberstring

lidstring

isAdminbooleanobrigatório

isSuperAdminbooleanobrigatório

displayNamestring

errorinteger

Exemplo 201gerado do schema

{
  "id": "string",
  "subject": "string",
  "subjectOwner": "string",
  "subjectTime": 1,
  "size": 1,
  "creation": 1,
  "owner": "string",
  "desc": "string",
  "descId": "string",
  "restrict": true,
  "announce": true,
  "isCommunity": true,
  "isCommunityAnnounce": true,
  "joinApprovalMode": true,
  "memberAddMode": true,
  "participants": [
    {
      "id": "string",
      "phoneNumber": "5511999999999",
      "lid": "string",
      "isAdmin": true,
      "isSuperAdmin": true,
      "displayName": "CodeChat",
      "error": 1
    }
  ]
}

curl --request POST \

--url 'http://localhost:8084/instance/minha-instancia/group' \

--header 'Authorization: Bearer <INSTANCE_TOKEN>' \

--header 'Content-Type: application/json' \

--data '{"subject":"string","description":"string","participants":["string"]}'

{

"id": "string",

"subject": "string",

"subjectOwner": "string",

"subjectTime": 1,

"size": 1,

"creation": 1,

"owner": "string",

"desc": "string",

"descId": "string",

"restrict": true,

"announce": true,

"isCommunity": true,

"isCommunityAnnounce": true,

"joinApprovalMode": true,

"memberAddMode": true,

"participants": [

{

"id": "string",

"phoneNumber": "5511999999999",

"lid": "string",

"isAdmin": true,

"isSuperAdmin": true,

"displayName": "CodeChat",

"error": 1

}

]

}