Sign in

v1

latestOpenAPI 3.1.02026-07-1413113265.9 KB
group

get group invite info

Get information about a group invite code

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

Path parameters

idinteger required

Instance ID

Request body

inviteCodestring required

The group invite code to get information about

Example request

{
  "inviteCode": "abcdefghijk"
}

Response

Returns information about the group invite

status'success' | 'error'

Example response

{
  "data": {
    "inviteInfo": {
      "groupId": "123456789@g.us",
      "inviteCode": "abcdefghijk",
      "inviteCodeExpiration": 1234567890
    }
  },
  "links": {
    "self": "https://waapi.app/api/v1/instances/1/client/action/get-invite-info"
  },
  "status": "success"
}