FAfazer-ai
Connections

GET /connections/{phoneNumber}/group-metadata

Changed on

Request

  • Base URL
    http://localhost:3025
  • Auth
    API key in header x-api-key

Path parameters

phoneNumberstring required
Example:+551234567890

Phone number for connection. Must have + prefix.

Query parameters

jidstring required
Example:123456789012345678@g.us

Group JID

Response

Group metadata retrieved successfully

idstring

Group JID

addressingModestring

Addressing mode of the group

subjectstring

Group name/subject

subjectOwnerstring

JID of the user who set the subject

subjectOwnerPnstring

Phone number JID of the subject owner

subjectTimenumber

Timestamp when subject was set

sizenumber

Number of participants in the group

creationnumber

Timestamp when the group was created

ownerstring

JID of the group owner

ownerPnstring

Phone number JID of the group owner

owner_country_codestring

Country code of the group owner

descstring nullable

Group description

descIdstring nullable

Description ID

descOwnerstring nullable

JID of the user who set the description

descTimenumber nullable

Timestamp when description was set

restrictboolean

Whether only admins can change group settings

announceboolean

Whether only admins can send messages

isCommunityboolean

Whether the group is a community

isCommunityAnnounceboolean

Whether the group is a community announcement group

joinApprovalModeboolean

Whether join requests require admin approval

memberAddModeboolean

Whether members can add other members

ephemeralDurationnumber nullable

Duration in seconds for disappearing messages

Example response

{
  "id": "120363425378794738@g.us",
  "addressingMode": "lid",
  "subject": "My Group",
  "subjectOwner": "12345678901234@lid",
  "subjectOwnerPn": "551234567890@s.whatsapp.net",
  "owner": "12345678901234@lid",
  "ownerPn": "551234567890@s.whatsapp.net",
  "owner_country_code": "BR",
  "memberAddMode": true,
  "participants": [
    {
      "id": "12345678901234@lid",
      "phoneNumber": "551234567890@s.whatsapp.net",
      "admin": "superadmin"
    }
  ],
  "ephemeralDuration": 604800
}

Changes

  • 533b3360e2e4Revision changes
    • breaking

      removed the required property from the response with the status

    • breaking

      removed the success response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

  • 80b5396ef493Revision changes
    • info

      added the non-success response with the status

    • info

      added the success response with the status