Show more

Use to navigate results, ENTER to select one, ESC to close

Type in any word to easily find the endpoint, property or group of operations you are looking for.

API changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
go-whatsapp-web-multidevice

Topics

  • Introduction
  • Authentication

Endpoints

  • app
    • Login to whatsapp server GET
    • Login with pairing code GET
    • Remove database and logout GET
    • Reconnecting to whatsapp server GET
    • Get list connected devices GET
  • user
    • User Info GET
    • User Avatar GET
    • User Change Avatar POST
    • User Change Push Name POST
    • User My Privacy Setting GET
    • User My List Groups GET
    • User My List Groups GET
    • Get list of user contacts GET
    • Check if user is on WhatsApp GET
    • Get Business Profile Information GET
  • send
    • Send Message POST
    • Send Image POST
    • Send Audio POST
    • Send File POST
    • Send Video POST
    • Send Contact POST
    • Send Link POST
    • Send Location POST
    • Send Poll / Vote POST
    • Send presence status POST
    • Send chat presence (typing indicator) POST
  • message
    • Revoke Message POST
    • Delete Message POST
    • Send reaction to message POST
    • Edit message by message ID before 15 minutes POST
    • Mark as read message POST
    • Star message POST
    • Unstar message POST
  • chat
    • Get list of chats GET
    • Get messages from a specific chat GET
    • Label or unlabel a chat POST
    • Pin or unpin a chat POST
  • group
    • Group Info GET
    • Create group and add participant POST
    • Adding more participants to group POST
    • Remove participants from group POST
    • Promote participants to admin POST
    • Demote participants to member POST
    • Join group with link POST
    • Get group information from invitation link GET
    • Get list of participant requests to join group GET
    • Approve participant request to join group POST
    • Reject participant request to join group POST
    • Leave group POST
    • Set group photo POST
    • Set group name POST
    • Set group locked status POST
    • Set group announce mode POST
    • Set group topic POST
  • newsletter
    • Unfollow newsletter POST
Powered by Bump.sh
API changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
go-whatsapp-web-multidevice

Get group information from invitation link

View as markdown
GET /group/info-from-link
Basic auth

Retrieve group information without joining the group using its invitation link

Query parameters

  • link string Required

    WhatsApp group invitation link

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • code string
    • message string
    • results object
      Hide results attributes Show results attributes object
      • group_id string

        The group ID

      • name string

        The group name

      • topic string

        The group topic/description

      • created_at string(date-time)

        When the group was created

      • participant_count integer

        Number of participants in the group

      • is_locked boolean

        Whether the group is locked (only admins can modify group info)

      • is_announce boolean

        Whether the group is in announce mode (only admins can send messages)

      • is_ephemeral boolean

        Whether the group has disappearing messages enabled

      • description string

        Additional description of the group

  • 400 application/json

    Bad Request

    Hide response attributes Show response attributes object
    • code string

      HTTP Status Code

    • message string

      Detail error message

    • results object

      additional data

  • 500 application/json

    Internal Server Error

    Hide response attributes Show response attributes object
    • code string

      SYSTEM_CODE_ERROR

    • message string

      Detail error message

    • results object

      additional data

GET /group/info-from-link
curl \
 --request GET 'http://localhost:3000/group/info-from-link?link=https%3A%2F%2Fchat.whatsapp.com%2FwhatsappKeyJoinGroup' \
 --user "username:password"
Response examples (200)
{
  "code": "SUCCESS",
  "message": "Success get group info from link",
  "results": {
    "group_id": "120363024512399999@g.us",
    "name": "Example Group Name",
    "topic": "Welcome to our group! Please follow the rules.",
    "created_at": "2024-01-15T10:30:00Z",
    "participant_count": 25,
    "is_locked": false,
    "is_announce": false,
    "is_ephemeral": false,
    "description": "This group is for discussing project updates"
  }
}
Response examples (400)
{
  "code": 400,
  "message": "field cannot be blank",
  "results": {}
}
Response examples (500)
{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "you are not loggin",
  "results": {}
}