Group

Estrutura de dados do contrato OpenAPI.

Estrutura de dados do contrato OpenAPI.

Campos

CampoTipoPresençaDescrição
JIDstringobrigatório
Namestringobrigatório
Topicstringopcional
OwnerJIDstringopcional
OwnerPNstringopcional
IsLockedbooleanopcional
IsAnnouncebooleanopcional
AddressingModestringopcional
ParticipantCountintegerobrigatório
Participantsarray<object>opcional
Participants[].JIDstringobrigatório
Participants[].PhoneNumberstringopcional
Participants[].LIDstringopcional
Participants[].IsAdminbooleanobrigatório
Participants[].IsSuperAdminbooleanobrigatório
Participants[].DisplayNamestringobrigatório
Participants[].ErrorintegerobrigatórioCódigo por participante; 0 indica ausência de erro registrado.
invite_linkstringobrigatórioVazio se não solicitado ou sem permissão de admin.
PictureIDstringopcional
lastMessageAtintegeropcionalUnix em segundos. Formato: int64
syncedAtintegeropcionalUnix em segundos. Formato: int64
leftbooleanopcional
GroupCreatedstringopcionalRFC 3339. Formato: date-time

Definição OpenAPI

json
{
  "type": "object",
  "properties": {
    "JID": {
      "type": "string"
    },
    "Name": {
      "type": "string"
    },
    "Topic": {
      "type": "string"
    },
    "OwnerJID": {
      "type": "string"
    },
    "OwnerPN": {
      "type": "string"
    },
    "IsLocked": {
      "type": "boolean"
    },
    "IsAnnounce": {
      "type": "boolean"
    },
    "AddressingMode": {
      "type": "string"
    },
    "ParticipantCount": {
      "type": "integer"
    },
    "Participants": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/GroupParticipant"
      }
    },
    "invite_link": {
      "type": "string",
      "description": "Vazio se não solicitado ou sem permissão de admin."
    },
    "PictureID": {
      "type": "string"
    },
    "lastMessageAt": {
      "type": "integer",
      "description": "Unix em segundos.",
      "format": "int64"
    },
    "syncedAt": {
      "type": "integer",
      "description": "Unix em segundos.",
      "format": "int64"
    },
    "left": {
      "type": "boolean"
    },
    "GroupCreated": {
      "type": "string",
      "description": "RFC 3339.",
      "format": "date-time"
    }
  },
  "required": [
    "JID",
    "Name",
    "ParticipantCount",
    "invite_link"
  ]
}