Unipile icon

Unipile

Interact with Unipile API

Overview

This node interacts with the Unipile API to list attendees of a specific chat within the Messaging resource. It is useful for scenarios where you need to retrieve and process the participants of a chat conversation, such as monitoring chat activity, managing user engagement, or integrating chat attendee data into workflows.

For example, you might use this node to:

  • Fetch all users currently involved in a customer support chat.
  • Analyze chat participation for team collaboration tools.
  • Automate notifications or follow-ups based on chat attendees.

Properties

Name Meaning
Chat ID The unique identifier of the chat whose attendees you want to list.
Additional Fields Optional parameters to refine the request:
- Cursor A pagination cursor to continue listing attendees from a specific point.
- Limit Maximum number of attendees to return (minimum 1, default 50).

Output

The node outputs JSON data containing the list of chat attendees retrieved from the Unipile API. Each item in the output corresponds to an attendee's details as provided by the API response. The structure typically includes user identifiers and related metadata about each attendee.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the Unipile API.
  • The base URL for API requests is configured via credentials.
  • Proper network access to the Unipile API endpoint is necessary.

Troubleshooting

  • Missing or invalid Chat ID: Ensure the Chat ID property is correctly set and corresponds to an existing chat.
  • API authentication errors: Verify that the API key credential is valid and has appropriate permissions.
  • Pagination issues: If using the cursor field, ensure it is correctly obtained from previous responses to avoid empty results.
  • Limit parameter errors: The limit must be at least 1; setting it below this may cause errors.

Links and References

Discussion