Skip to main content
GET
cURL

Path Parameters

instance_id
string
required

Id da instância (dashboard › instância › Credenciais).

token
string
required

Token da instância. Trate como senha.

Query Parameters

Response

Metadados do grupo (sem participantes).

id
string
required
Pattern: ^(\d+(-\d+)?-group|\d+(-\d+)?@g\.us)$
name
string
required
participants
object[]
required
participant_count
integer
required
Required range: 0 <= x <= 9007199254740991
announce
boolean
required
locked
boolean
required
join_approval_required
boolean
required
ephemeral_seconds
integer
default:0
required
Required range: 0 <= x <= 9007199254740991
is_community
boolean
default:false
required
suspended
boolean
default:false
required
description
string
owner
string
Minimum string length: 1
Pattern: ^(\d{5,20}|\d+@lid|\d+(-\d+)?-group|\d+@g\.us|\d+@newsletter|\d+@broadcast|status@broadcast)$
created_at
string<date-time>
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
member_add_mode
enum<string>
Available options:
admin_add,
all_member_add
parent_id
string
Pattern: ^(\d+(-\d+)?-group|\d+(-\d+)?@g\.us)$