Actions116
- š¬ Chats Actions
- š¤ Contacts Actions
- š„ļø Sessions Actions
- š Profile Actions
- š¼ļø Screenshot Actions
- š¤ Chatting Actions
- š¢ Channels Actions
- š¢ Status Actions
- š„ Groups Actions
- Add Participants
- Demote To Admin
- Create Group
- Get Groups
- Join Info Group
- Join Group
- Refresh Groups
- Get Group
- Delete Group
- Leave Group
- Get Chat Picture
- Set Picture
- Delete Picture
- Set Description
- Set Subject
- Set Info Admin Only
- Get Info Admin Only
- Set Messages Admin Only
- Get Messages Admin Only
- Get Invite Code
- Revoke Invite Code
- Get Participants
- Remove Participants
- Promote To Admin
- ā Presence Actions
- š·ļø Labels Actions
- š Observability Actions
- š Auth Actions
Overview
This node operation retrieves an overview of chat sessions from a specified session name. It is useful for scenarios where users need to fetch a list or summary of chat conversations, such as monitoring chat activity, analyzing chat data, or integrating chat information into workflows. For example, a customer support system could use this to get recent chat sessions for review or reporting.
Use Case Examples
- Fetch the first 20 chat sessions from a given session to display recent conversations.
- Retrieve chat sessions with pagination by setting limit and offset to process large chat histories in batches.
Properties
| Name | Meaning |
|---|---|
| Session | The name of the chat session to retrieve the overview for. |
| Limit | The maximum number of chat sessions to return in the overview. |
| Offset | The number of chat sessions to skip before starting to collect the overview results. |
| Request Options | Additional request settings such as batching, SSL certificate validation, proxy configuration, and request timeout. |
Output
JSON
chats- Array of chat session overview objects returned from the specified session.totalCount- Total number of chat sessions available for the given session.
Dependencies
- Requires an API key credential or authentication token to access the chat service API.
Troubleshooting
- Common issues include invalid session names resulting in no data returned or errors.
- Timeout errors may occur if the server is slow or unresponsive; increasing the timeout setting can help.
- SSL certificate validation errors can be bypassed by enabling the 'Ignore SSL Issues' option, but this reduces security.
- Proxy misconfiguration can cause request failures; ensure proxy settings are correct.