Actions116
- 💬 Chats Actions
- 👤 Contacts Actions
- 👥 Groups Actions
- Get Info Admin Only
- Set Messages Admin Only
- Get Messages Admin Only
- Get Invite Code
- Revoke Invite Code
- Get Participants
- Add Participants
- Remove Participants
- Promote To Admin
- 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
- 🖥️ Sessions Actions
- 🆔 Profile Actions
- 🖼️ Screenshot Actions
- 📤 Chatting Actions
- 📢 Channels Actions
- 🟢 Status Actions
- ✅ Presence Actions
- 🏷️ Labels Actions
- 🔍 Observability Actions
- 🔑 Auth Actions
Overview
This node operation archives a chat in a specified session by providing the session name and chat ID. It is useful for managing chat histories by marking chats as archived, which can help in organizing and cleaning up active chat lists. For example, in a customer support system, this operation can be used to archive resolved chat conversations automatically.
Use Case Examples
- Archiving a customer support chat after the issue is resolved to keep the active chat list clean.
- Automatically archiving chats older than a certain date to maintain chat history efficiently.
Properties
| Name | Meaning |
|---|---|
| Session | The name of the session where the chat exists, used to identify the context for the chat to be archived. |
| Chat Id | The unique identifier of the chat to be archived within the specified session. |
| Request Options | Additional options to control the request behavior such as batching, SSL certificate validation, proxy settings, and timeout duration. |
Output
JSON
success- Indicates whether the chat was successfully archived.archivedChatId- The ID of the chat that was archived.session- The session name where the chat was archived.
Dependencies
- Requires an API key credential or authentication token to access the chat service API.
Troubleshooting
- Common issues include invalid session names or chat IDs, resulting in errors indicating the chat could not be found or archived.
- Timeout errors may occur if the server does not respond within the specified timeout period; increasing the timeout or checking network connectivity can help.
- SSL certificate validation errors can be bypassed by enabling the 'Ignore SSL Issues' option, but this should be used with caution due to security risks.
Links
- Chat Archive API Documentation - Official API documentation for archiving chats, detailing required parameters and response structure.