group

get group invite info

Get information about a group invite code

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

Request

  • Base URL: https://waapi.app/api/v1
  • URL: https://waapi.app/api/v1/instances/{id}/client/action/get-invite-info
  • Auth: HTTP bearer

Path parameters

idinteger required

Instance ID

Request body

inviteCodestring required

The group invite code to get information about

Example request

{
  "inviteCode": "abcdefghijk"
}

Response

Request reached the instance. data.status reports whether the action was carried out; on error data carries message and explanation. Payload: Returns information about the group invite.

status'success' | 'error'

Whether the request reached the instance. success here does not mean the action was carried out — that is reported by data.status, which is the authoritative one. A malformed input arrives as status: success with data.status: error.

Example response

{
  "data": {
    "status": "success",
    "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"
}

Changes

No recorded changes to this operation across all 1 revision of this API.