OneBot icon

OneBot

Consume OneBot API

Actions13

Overview

This node integrates with the OneBot API to manage and interact with group chats on a messaging platform. Specifically, for the "获取群成员列表" (Get Group Member List) operation under the "群组" (Group) resource, it retrieves the list of members in a specified group. This is useful for scenarios where you need to analyze group membership, automate group management tasks, or synchronize group member data with other systems.

Practical examples include:

  • Fetching all members of a group to send targeted notifications.
  • Auditing group membership for compliance or moderation purposes.
  • Integrating group member data into CRM or analytics platforms.

Properties

Name Meaning
Group Name or ID Select the target group by its name or ID. You can search by group name or group number.

Output

The output is a JSON array representing the list of group members retrieved from the OneBot API. Each item in the array corresponds to a group member's information, typically including identifiers and roles within the group.

If the node supports binary data output (not indicated explicitly here), it would represent any associated media or files related to the group members, but this operation primarily returns JSON data about members.

Dependencies

  • Requires an API key credential for authenticating with the OneBot API.
  • The node depends on the OneBot API being accessible and the bot having appropriate permissions to query group member information.
  • No additional environment variables are explicitly required beyond the API authentication setup.

Troubleshooting

  • Common Issues:

    • Missing or invalid group ID: The operation requires a valid group identifier; ensure the group exists and the ID is correct.
    • Insufficient permissions: The bot must have permission to access group member information; otherwise, the request will fail.
    • Network or API errors: Connectivity issues or API downtime can cause failures.

  • Error Messages:

    • "获取群成员列表需要有有效的群ID，但未提供" ("Getting group member list requires a valid group ID, but none was provided"): Ensure the group ID property is set.
    • Permission-related errors indicating the bot is not an admin or owner of the group: Verify the bot's role and permissions in the group.
    • General API request failures: Check network connectivity and API status.

Resolving these usually involves verifying input parameters, ensuring the bot has the necessary group permissions, and confirming API availability.

Links and References

Discussion