WaliChat icon

WaliChat

Interact with WaliChat WhatsApp API

Actions148

Team → Get Team Members

AI-generated

Overview

This node interacts with the WaliChat WhatsApp API to retrieve information about team members. Specifically, the "Get Team Members" operation allows users to fetch a filtered list of users within a team based on various criteria such as user IDs, status, role, device access, and activity timestamps.

Common scenarios where this node is beneficial include:

  • Managing and monitoring team composition by retrieving active or pending users.
  • Filtering users by roles (e.g., Admin, Supervisor, Agent) for targeted operations or reporting.
  • Tracking user activity by filtering based on last online or login times.
  • Integrating with other workflows that require up-to-date team member data from WaliChat.

Practical example:

  • A customer support manager wants to generate a report of all active agents who have logged in within the last week and have access to a specific WhatsApp number. This node can be configured with filters to retrieve exactly that subset of users.

Properties

Name Meaning
Filters Collection of filter options to narrow down the list of team members returned. Contains the following sub-properties:
├─ User IDs Filter users by specific user IDs (multiple values allowed).
├─ Status Filter users by their status. Options: Active, Pending, Suspended.
├─ Role Filter users by their role within the team. Options: Admin, Supervisor, Agent.
├─ Search Search users by name or email using a text string.
├─ Device ID Filter users who have access to a specific WhatsApp number (device). The list of devices is dynamically loaded.
├─ Exclude User IDs Exclude specific user IDs from the results (multiple values allowed).
├─ Last Online Before Filter users who were last seen online before a specified date/time.
├─ Last Online After Filter users who were last seen online after a specified date/time.
├─ Last Login Before Filter users who logged in before a specified date/time.
├─ Last Login After Filter users who logged in after a specified date/time.
├─ Results Page Size Number of results to return per page (pagination size). Default is 20.
└─ Page Number Page number to retrieve, starting from 0 (for pagination). Default is 0.

Output

The output is an array of JSON objects representing the team members matching the specified filters. Each object contains details about a user, such as their ID, status, role, last online time, last login time, and device access information.

If the node supports binary data output (not indicated here), it would typically represent files or media related to the users, but this operation focuses on JSON user data only.

Dependencies

  • Requires an API key credential for authenticating with the WaliChat WhatsApp API.
  • The node depends on the WaliChat API service being accessible and properly configured.
  • The "Device ID" filter option dynamically loads available WhatsApp numbers/devices via a method named getDevices, which requires proper API access.

Troubleshooting

  • Empty results: If no users are returned, verify that the filter criteria are correct and that users matching those filters exist.
  • Invalid date filters: Ensure date/time inputs for "Last Online" and "Last Login" filters are valid ISO date strings.
  • API authentication errors: Confirm that the API key credential is correctly set up and has sufficient permissions.
  • Pagination issues: If expecting more results, check the "Results Page Size" and "Page Number" properties to ensure correct paging.
  • Device filter not working: Make sure the device ID corresponds to an existing WhatsApp number accessible by your account.

Common error messages might include:

  • Authentication failures due to invalid or missing API keys.
  • Validation errors if filter parameters are malformed.
  • Network or API downtime errors.

Resolving these usually involves checking credentials, input formats, and network connectivity.

Links and References

Discussion