Group Controller

Fetch Group Invite Code

Changed on

Fetch group invite code

get/group/inviteCode/{instance}

Request

  • Base URL
    https://evolution-example
  • URL
    https://evolution-example/group/inviteCode/{instance}
  • Auth
    API key in header apikey

Path parameters

instancestring required

Name of the instance

Query parameters

groupJidstring required

Group remote JID

Response

Ok

inviteUrlstring

The URL for the WhatsApp group invite.

inviteCodestring

The code for the WhatsApp group invite.

Example response

{
  "inviteUrl": "https://chat.whatsapp.com/DgQvyfXzY01B6rGrpZpYze",
  "inviteCode": "DgQvyfXzY01B6rGrpZpYze"
}

Changes

    • breaking

      the query request parameter groupJid became required

    • info

      api operation id fetchInviteCode was added

    • info

      the endpoint scheme security ApiKeyAuth was added to the API

    • info

      api tag Group Controller added

    • info

      api tag Group removed

    • info

      api operation id fetchInviteCode removed and replaced with

    • info

      the endpoint scheme security ApiKeyAuth was removed from the API

    • info

      api tag Group added

    • info

      api tag Group Controller removed

    • info

      the query request parameter groupJid became optional