Sign in

v1

latestOpenAPI 3.1.02026-07-1413113265.9 KB
group

get group info

Get group info

post/instances/{id}/client/action/get-group-info

Path parameters

idinteger required

Instance ID

Request body

chatIdstring required

Example request

{
  "chatId": "<xxxxx>@g.us"
}

Response

status'success' | 'error'

Example response

{
  "data": {
    "chatId": {
      "server": "@g.us",
      "user": "<xxxxxxx>",
      "_serialized": "<xxxxxxx>@g.us"
    },
    "owner": {
      "server": "@c.us",
      "user": "<xxxxxxx>",
      "_serialized": "<xxxxxxx>@c.us"
    },
    "subject": "group name",
    "createdAt": "2023-05-21T16:26:22.000Z",
    "createdAtTimestamp": 1684859182,
    "inviteCode": "abcxyzdefgfh",
    "inviteCodeLink": "https://link.com/abcxyzdefgfh",
    "participants": [
      {
        "id": {
          "server": "@c.us",
          "user": "<xxxxxxx>",
          "_serialized": "<xxxxxxx>@c.us"
        },
        "isAdmin": true,
        "isSuperAdmin": true
      }
    ]
  },
  "links": {
    "self": "https://waapi.app/api/v1/instances/1/client/action/get-group-info"
  },
  "status": "success"
}