OneBot icon

OneBot

Consume OneBot API

Overview

This node integrates with the OneBot API to perform various operations related to bots, friends, groups, messages, and miscellaneous information. Specifically, for the Group resource and the Get Group Member List operation, it retrieves the list of members belonging to a specified group.

Common scenarios where this node is beneficial include:

  • Managing group memberships by fetching current member lists.
  • Automating group-related workflows such as notifications or audits based on group membership.
  • Integrating group data into other systems or dashboards.

For example, you can use this node to get all members of a chat group in a messaging platform powered by OneBot, then process or analyze that list downstream in your workflow.

Properties

Name Meaning
Group Name or ID Select a group from the dropdown list or specify its ID using an expression. This identifies which group's member list to retrieve.

Output

The output is a JSON array containing the group member list data returned by the OneBot API. Each item in the array represents a member of the specified group, typically including details such as user IDs, nicknames, roles, and other member-specific information as provided by the API.

No binary data output is produced by this operation.

Dependencies

  • Requires connection to the OneBot API via an API key credential configured in n8n.
  • The node uses internal helper functions to make HTTP requests to the OneBot API endpoints.
  • The "Group Name or ID" property loads options dynamically by calling the OneBot API to fetch available groups.

Troubleshooting

  • Empty or missing group member list: Ensure the specified group ID or name is correct and that the bot has permission to access the group's member information.
  • API request failures: Check that the API key credential is valid and has sufficient permissions.
  • Dynamic options not loading: If the group list does not populate, verify network connectivity and API availability.
  • Error messages from API: These may indicate invalid parameters or insufficient permissions; review the error details and adjust inputs accordingly.

Links and References

Discussion