Read a WhatsApp group
get_groupRead one of the user's WhatsApp groups as it is now: its name, whether everyone or only admins may send messages, the role of the user's number (member, admin or owner), every participant with their phone and role, and the invite link when the user's number is an admin and this connection may act for the user. Call it before changing a group, to know who is in it and whether the number may change it.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "get_group"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| phone | No | The connected number, from list_connected_numbers. Omit it when the user has a single connected number. | |
| chat_id | No | The group, by the chat_id list_capturable_chats returns. Name the group by its chat_id from list_capturable_chats, or by its name as chat_name; pass one of them. | |
| chat_name | No | The group, by its name exactly as list_capturable_chats returns it. Name the group by its chat_id from list_capturable_chats, or by its name as chat_name; pass one of them. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | ||
| chat_id | No | The group's chat_id. | |
| invite_link | No | The group's invite link, present when the user's number is an admin and this connection may act for the user. | |
| number_role | No | The user's number in the group: "member", "admin" or "owner". Only an admin or the owner can change the group. | |
| participants | No | Everyone in the group. | |
| who_can_send | No | "everyone", or "admins" when only admins may send messages. | |
| conversation_id | No | The captured conversation of this group, when it is captured. | |
| conversation_url | No | Where a person opens that conversation. |