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 allows users to pin a specific message in a chat session for a defined duration. It is useful in scenarios where important messages need to be highlighted or kept accessible in chat conversations, such as pinning announcements, reminders, or key information in team chats or customer support interactions.
Use Case Examples
- Pinning a message in a team chat to highlight a meeting agenda for 24 hours.
- Pinning a customer support message to keep critical information visible for 7 days.
Properties
| Name | Meaning |
|---|---|
| Session | The name of the chat session where the message will be pinned. |
| Chat Id | The unique identifier of the chat where the message is located. |
| Message Id | The unique identifier of the message to be pinned. |
| Duration | The length of time in seconds that the message will remain pinned. Common values include 86400 (24 hours), 604800 (7 days), and 2592000 (30 days). |
| Request Options | Additional settings for the request such as batching, SSL certificate handling, proxy configuration, and timeout settings. |
Output
JSON
success- Indicates whether the pin message operation was successful.pinnedMessageId- The ID of the message that was pinned.chatId- The ID of the chat where the message was pinned.duration- The duration in seconds for which the message is pinned.
Dependencies
- Requires an active session with the chat service, typically authenticated via an API key or token.
Troubleshooting
- Ensure the session name is correct and active; invalid sessions will cause failures.
- Verify that the chat ID and message ID exist and are accessible in the session.
- Check network connectivity and proxy settings if requests time out or fail.
- If SSL errors occur, consider enabling the option to ignore SSL issues, but be aware of security risks.