bx24_im
Manage Bitrix24 messenger: send messages and notifications, search chats and users, and view counters and recent dialogs.
Instructions
Bitrix24 messenger: messages, notifications, user info, search, counters, recent. Methods im.message., im.notify., im.user., im.search., im.counters., im.recent. (REST 1.0 + 3.0). RU/EN: сообщение, написать, уведомление, поиск сообщений, счётчики, недавние / message, notify, search messages, counters, recent.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ID | No | Entity ID (notify/message/department) | |
| TO | No | Recipient user ID (notify) | |
| IDS | No | Array of IDs | |
| file | No | File to upload: NAME, CONTENT base64, CHAT_ID/DIALOG_ID | |
| LIMIT | No | Page size | |
| order | No | Order object (e.g. { 'ID': 'DESC' }) | |
| start | No | Pagination offset (number of records to skip) | |
| SEARCH | No | Search string | |
| STATUS | No | User status (online/away/dnd) | |
| SYSTEM | No | Send as system message | |
| action | Yes | Operation to perform: - "message_add": Send a message (DIALOG_ID, MESSAGE) - "message_update": Update a message (MESSAGE_ID, MESSAGE) - "message_delete": Delete a message (destructive) - "message_get": Get a message by ID - "message_like": Toggle 'Like' on a message - "message_share": Create a chat/task/post from a message - "message_command": Execute a chat-bot command on a message - "dialog_get": Get dialog info - "dialog_messages_list": List dialog message history - "dialog_messages_search": Search messages in a dialog - "dialog_read": Mark dialog read - "dialog_unread": Mark dialog unread - "dialog_read_all": Mark all user dialogs read - "dialog_typing": Send typing status - "dialog_mark": Mark a message for attention - "dialog_users": List dialog users - "notify_personal_add": Send a personal notification (TO, MESSAGE) - "notify_system_add": Send a system notification - "notify_delete": Delete a notification (destructive) - "notify_get": Get user notifications - "notify_read": Mark a notification read/unread - "notify_read_list": Mark notifications read by IDs - "notify_read_all": Mark all notifications read - "notify_answer": Reply to a notification with a quick answer - "notify_confirm": Interact with notification buttons - "notify_history_search": Search notification history - "user_get": Get IM user info - "user_list": List IM users by IDs - "user_status_set": Set user status (online/away/dnd) - "user_status_get": Get user status - "search_message": Search messages - "search_user": Search users in IM - "search_chat_list": Search chats by name - "search_department_list": Search departments - "search_last_add": Add a search history entry - "search_last_get": Get search history - "search_last_delete": Delete a search history entry (destructive) - "counters_get": Get chat/message counters - "recent_list": List recent dialogs - "recent_pinned": Pin a recent dialog - "recent_unpin": Unpin a recent dialog - "recent_hide": Hide a recent dialog - "department_get": Get department info (IM) - "department_managers_get": Get department managers - "department_employees_get": Get department employees - "department_colleagues_list": List user colleagues - "v2_file_upload": Upload a file to a chat (v2 API) - "v2_file_download": Get a file download URL (v2 API) - "v2_event_subscribe": Subscribe user to messenger events (v2 API) - "v2_event_get": Get accumulated messenger events (v2 API) - "v2_event_unsubscribe": Stop recording messenger events (v2 API) - "bot_list": List available bots | |
| filter | No | Filter object (e.g. { '>OPPORTUNITY': 10000, 'STAGE_ID': 'WON' }) | |
| select | No | Array of field names to return (projection) | |
| LAST_ID | No | Last message ID for pagination | |
| MESSAGE | No | Message text | |
| USER_ID | No | User ID | |
| confirm | No | Set to true to confirm destructive actions when BX24_CONFIRM_DESTRUCTIVE is enabled. | |
| DIALOG_ID | No | Dialog ID: chatNNN or numeric user ID | |
| MESSAGE_ID | No | Message ID |