Skip to main content
GET
/
instances
/
{instanceId}
/
token
/
{instanceToken}
/
group-invitation-metadata
Metadados por link de convite
curl --request GET \
  --url https://api.ezapi.com.br/instances/{instanceId}/token/{instanceToken}/group-invitation-metadata \
  --header 'Client-Token: <api-key>'
{
  "phone": "120363123456789-group",
  "owner": "5511999999999",
  "subject": "Time EZ API",
  "description": "Grupo operacional",
  "creation": 1736200000,
  "invitationLink": "https://chat.whatsapp.com/D4HNtyc4TyDIXA7Y12T5JA",
  "contactsCount": 3,
  "participantsCount": 3,
  "participants": [
    {
      "phone": "5511999999999",
      "isAdmin": true,
      "isSuperAdmin": true
    }
  ],
  "adminOnlyMessage": false,
  "adminOnlySettings": false,
  "requireAdminApproval": false,
  "isGroupAnnouncement": false,
  "subjectTime": 1736200000,
  "subjectOwner": "5511999999999",
  "communityId": null
}
Consulta os metadados do grupo a partir de um link de convite.
Aliases consolidados da collection: Metadata do grupo por convite.

Authorizations

​
Client-Token
string
header
required

Path Parameters

​
instanceId
string
required

Identificador único da instância.

Example:

"abc1234567890"

​
instanceToken
string
required

Token privado da instância retornado na criação.

Example:

"tok_a1b2c3d4e5f6"

Query Parameters

​
url
string
required

URL do convite do grupo.

Example:

"https://chat.whatsapp.com/D4HNtyc4TyDIXA7Y12T5JA"

Response

Resposta de sucesso.

​
phone
string
required
Example:

"120363123456789-group"

​
owner
string
required
Example:

"5511999999999"

​
subject
string
required
Example:

"Time EZ API"

​
description
string
required
Example:

"Grupo operacional"

​
creation
integer
required
Example:

1736200000

​
invitationLink
string
required
Example:

"https://chat.whatsapp.com/D4HNtyc4TyDIXA7Y12T5JA"

​
contactsCount
integer
required
Example:

3

​
participantsCount
integer
required
Example:

3

​
participants
object[]
required
Example:
[
  {
    "phone": "5511999999999",
    "isAdmin": true,
    "isSuperAdmin": true
  }
]
​
adminOnlyMessage
boolean
required
Example:

false

​
adminOnlySettings
boolean
required
Example:

false

​
requireAdminApproval
boolean
required
Example:

false

​
isGroupAnnouncement
boolean
required
Example:

false

​
subjectTime
integer
required
Example:

1736200000

​
subjectOwner
string
required
Example:

"5511999999999"

​
communityId
unknown
required