Working with Messages

&lt;p&gt;&lt;div class=&quot;warning&quot;&gt;&lt;b&gt;Attention!&lt;/b&gt; The &lt;b&gt;restCommand&lt;/b&gt; function is used in all methods. &lt;!-- and is taken from the &lt;a href=&quot;https://bitbucket.org/Bitrix24com/rest-bot-echotest/&quot; target=&quot;_blank&quot;&gt;EchoBot&lt;/a&gt;. --&gt; You can send a REST command with your own function, or use the &lt;a href=&quot;https://training.bitrix24.com/rest_help/js_library/rest/callMethod.php&quot; target=&quot;_blank&quot;&gt;BX24.callMethod&lt;/a&gt; or &lt;a href=&quot;https://github.com/mesilov/bitrix24-php-sdk&quot; target=&quot;_blank&quot;&gt;bitrix24-php-sdk&lt;/a&gt; JavaScript methods. &lt;/div&gt;&lt;/p&gt; &lt;ul class=&quot;menu&quot;&gt; &lt;li&gt;&lt;a href=&quot;#im_message_add&quot;&gt;im.message.add&lt;/a&gt; - send message to chat.&lt;/li&gt; &lt;li&gt;&lt;a href=&quot;#im_message_update&quot;&gt;im.message.update&lt;/a&gt; - update chatbot message.&lt;/li&gt; &lt;li&gt;&lt;a href=&quot;#im_message_delete&quot;&gt;im.message.delete&lt;/a&gt; - delete chatbot message.&lt;/li&gt; &lt;li&gt;&lt;a href=&quot;#im_message_like&quot;&gt;im.message.like&lt;/a&gt; - «Like» a message.&lt;/li&gt; &lt;/ul&gt; &lt;br&gt; &lt;a name=&quot;im.message.add&quot;&gt;&lt;/a&gt; &lt;h3&gt;Send message to chat&lt;/h3&gt; &lt;b&gt;REST method&lt;/b&gt;: &lt;code&gt;im.message.add&lt;/code&gt; &lt;br&gt;&lt;br&gt; &lt;b&gt;Method call&lt;/b&gt;: &lt;pre class=&quot;syntax&quot;&gt; $result = restCommand('im.message.add', Array( 'CHAT_ID' =&amp;gt; 13, // Recipient chat ID, if message is for chat 'USER_ID' =&amp;gt; 2, // Recipient user ID, if message is for private chat 'MESSAGE' =&amp;gt; 'Message text' // Message test 'SYSTEM' =&amp;gt; 'N' // To display message as system message or not, optional field, by default 'N' 'ATTACH' =&amp;gt; '' // Attachment, optional field 'URL_PREVIEW' =&amp;gt; 'Y' // Convert links to rich-links, optional field, by default 'Y' 'KEYBOARD' =&gt; '' // Keyboard, optional field 'MENU' =&gt; '' // Context menu, optional field ), $_REQUEST[&quot;auth&quot;]); &lt;/pre&gt; &lt;b&gt;Return&lt;/b&gt;: &lt;code&gt;MESSAGE_ID&lt;/code&gt; ID or an error.&lt;br&gt;&lt;br&gt; &lt;b&gt;Related Links&lt;/b&gt;:&lt;br&gt;&lt;br&gt; &lt;a href=&quot;/support/training/course/index.php?COURSE_ID=115&LESSON_ID=9767&quot;&gt;Using Keyboards&lt;/a&gt;&lt;br&gt; &lt;a href=&quot;/support/training/course/index.php?COURSE_ID=115&CHAPTER_ID=09759&quot;&gt;Attachments&lt;/a&gt;&lt;br&gt; &lt;a href=&quot;/support/training/course/index.php?COURSE_ID=115&LESSON_ID=9757&quot;&gt;Formatting&lt;/a&gt;&lt;br&gt; &lt;br&gt;&lt;br&gt; &lt;b&gt;Possible errors&lt;/b&gt;:&lt;br&gt;&lt;br&gt; &lt;table cellspacing=&quot;0&quot; cellpadding=&quot;0&quot;&gt; &lt;tbody&gt; &lt;tr bgcolor=&quot;white&quot;&gt; &lt;td bgcolor=&quot;#8c8c8c&quot;&gt; &lt;table cellspacing=&quot;1&quot; cellpadding=&quot;5&quot;&gt; &lt;tbody&gt; &lt;tr bgcolor=&quot;silver&quot;&gt; &lt;td&gt;&lt;b&gt;Error code&lt;/b&gt;&lt;/td&gt;&lt;td&gt;&lt;b&gt;Error description&lt;/b&gt;&lt;/td&gt; &lt;/tr&gt; &lt;tr bgcolor=&quot;white&quot;&gt; &lt;td valign=&quot;top&quot;&gt;&lt;b&gt;USER_ID_EMPTY&lt;/b&gt;&lt;/td&gt; &lt;td&gt;Chat ID not specified, if message is sent in person-to-person chat.&lt;/td&gt; &lt;/tr&gt; &lt;tr bgcolor=&quot;white&quot;&gt; &lt;td&gt;&lt;b&gt;CHAT_ID_EMPTY&lt;/b&gt;&lt;/td&gt; &lt;td&gt;Chat ID not specified if message is sent to chat.&lt;/td&gt; &lt;/tr&gt; &lt;tr bgcolor=&quot;white&quot;&gt; &lt;td&gt;&lt;b&gt;ACCESS_ERROR&lt;/b&gt;&lt;/td&gt; &lt;td&gt;Insufficient rights to send message.&lt;/td&gt; &lt;/tr&gt; &lt;tr bgcolor=&quot;white&quot;&gt; &lt;td&gt;&lt;b&gt;MESSAGE_EMPTY&lt;/b&gt;&lt;/td&gt; &lt;td&gt;No message text.&lt;/td&gt; &lt;/tr&gt; &lt;tr bgcolor=&quot;white&quot;&gt; &lt;td&gt;&lt;b&gt;ATTACH_ERROR&lt;/b&gt;&lt;/td&gt; &lt;td&gt;Complete sent attachment object was not validated.&lt;/td&gt; &lt;/tr&gt; &lt;tr bgcolor=&quot;white&quot;&gt; &lt;td&gt;&lt;b&gt;ATTACH_OVERSIZE&lt;/b&gt;&lt;/td&gt; &lt;td&gt;Maximum permissible attachment size was exceeded (30 Kb).&lt;/td&gt; &lt;/tr&gt; &lt;tr bgcolor=&quot;white&quot;&gt; &lt;td&gt;&lt;b&gt;KEYBOARD_ERROR&lt;/b&gt;&lt;/td&gt; &lt;td&gt;Complete sent keyboard object was not validated.&lt;/td&gt; &lt;/tr&gt; &lt;tr bgcolor=&quot;white&quot;&gt; &lt;td&gt;&lt;b&gt;KEYBOARD_OVERSIZE&lt;/b&gt;&lt;/td&gt; &lt;td&gt;Maximum permissible keyboard size was exceeded (30 Kb).&lt;/td&gt; &lt;/tr&gt; &lt;tr bgcolor=&quot;white&quot;&gt; &lt;td&gt;&lt;b&gt;MENU_ERROR&lt;/b&gt;&lt;/td&gt; &lt;td&gt; Complete attachment object was not validated.&lt;/td&gt; &lt;/tr&gt; &lt;tr bgcolor=&quot;white&quot;&gt; &lt;td&gt;&lt;b&gt;MENU_OVERSIZE&lt;/b&gt;&lt;/td&gt; &lt;td&gt;Maximum permissible menu size was exceeded (30 Kb).&lt;/td&gt; &lt;/tr&gt; &lt;tr bgcolor=&quot;white&quot;&gt; &lt;td&gt;&lt;b&gt;PARAMS_ERROR&lt;/b&gt;&lt;/td&gt; &lt;td&gt;Something went wrong.&lt;/td&gt; &lt;/tr&gt; &lt;/tbody&gt; &lt;/table&gt; &lt;/td&gt;&lt;/tr&gt; &lt;/tbody&gt; &lt;/table&gt; &lt;br&gt;&lt;br&gt; &lt;a name=&quot;im.message.update&quot;&gt;&lt;/a&gt; &lt;h3&gt;Update chatbot message&lt;/h3&gt; &lt;b&gt;REST method&lt;/b&gt;: &lt;code&gt;im.message.update&lt;/code&gt; &lt;br&gt;&lt;br&gt; &lt;b&gt;Method call&lt;/b&gt;: &lt;pre class=&quot;syntax&quot;&gt; $result = restCommand('im.message.update', Array( 'MESSAGE_ID' =&amp;gt; 1, // Message ID 'MESSAGE' =&amp;gt; 'answer text' // Message test, optional field, if empty value is specified - message will be deleted 'ATTACH' =&amp;gt; '' // Attachment, optional field 'URL_PREVIEW' =&amp;gt; 'Y' // Convert links to rich-links, optional field 'KEYBOARD' =&gt; '' // Keyboard, optional field 'MENU' =&gt; '' // Context menu, optional field ), $_REQUEST[&quot;auth&quot;]); &lt;/pre&gt; &lt;b&gt;Return&lt;/b&gt;: &lt;code&gt;true&lt;/code&gt; or an error.&lt;br&gt;&lt;br&gt; &lt;b&gt;Related Links&lt;/b&gt;:&lt;br&gt;&lt;br&gt; &lt;a href=&quot;/support/training/course/index.php?COURSE_ID=115&LESSON_ID=9767&quot;&gt;Using Keyboards&lt;/a&gt;&lt;br&gt; &lt;a href=&quot;/support/training/course/index.php?COURSE_ID=115&CHAPTER_ID=09759&quot;&gt;Attachments&lt;/a&gt;&lt;br&gt; &lt;a href=&quot;/support/training/course/index.php?COURSE_ID=115&LESSON_ID=9757&quot;&gt;Formatting&lt;/a&gt;&lt;br&gt; &lt;br&gt;&lt;br&gt; &lt;b&gt;Possible errors&lt;/b&gt;:&lt;br&gt;&lt;br&gt; &lt;table cellspacing=&quot;0&quot; cellpadding=&quot;0&quot;&gt; &lt;tbody&gt; &lt;tr bgcolor=&quot;white&quot;&gt; &lt;td bgcolor=&quot;#8c8c8c&quot;&gt; &lt;table cellspacing=&quot;1&quot; cellpadding=&quot;5&quot;&gt; &lt;tbody&gt; &lt;tr bgcolor=&quot;silver&quot;&gt; &lt;td&gt;&lt;b&gt;Error code&lt;/b&gt;&lt;/td&gt;&lt;td&gt;&lt;b&gt;Error description&lt;/b&gt;&lt;/td&gt; &lt;/tr&gt; &lt;tr bgcolor=&quot;white&quot;&gt; &lt;td valign=&quot;top&quot;&gt;&lt;b&gt;MESSAGE_ID_ERROR&lt;/b&gt;&lt;/td&gt; &lt;td&gt;No message ID.&lt;/td&gt; &lt;/tr&gt; &lt;tr bgcolor=&quot;white&quot;&gt; &lt;td&gt;&lt;b&gt;CANT_EDIT_MESSAGE&lt;/b&gt;&lt;/td&gt; &lt;td&gt;You do not have access to this message or time to modify it has expired (3 days passed since message posting).&lt;/td&gt; &lt;/tr&gt; &lt;tr bgcolor=&quot;white&quot;&gt; &lt;td&gt;&lt;b&gt;ATTACH_ERROR&lt;/b&gt;&lt;/td&gt; &lt;td&gt;Complete sent attachment object not validated.&lt;/td&gt; &lt;/tr&gt; &lt;tr bgcolor=&quot;white&quot;&gt; &lt;td&gt;&lt;b&gt;ATTACH_OVERSIZE&lt;/b&gt;&lt;/td&gt; &lt;td&gt;Maximum permissible attachment size was exceeded (30 Kb).&lt;/td&gt; &lt;/tr&gt; &lt;tr bgcolor=&quot;white&quot;&gt; &lt;td&gt;&lt;b&gt;KEYBOARD_ERROR&lt;/b&gt;&lt;/td&gt; &lt;td&gt;Complete sent keyboard object not validated.&lt;/td&gt; &lt;/tr&gt; &lt;tr bgcolor=&quot;white&quot;&gt; &lt;td&gt;&lt;b&gt;KEYBOARD_OVERSIZE&lt;/b&gt;&lt;/td&gt; &lt;td&gt;Maximum permissible keyboard size was exceeded (30 Kb).&lt;/td&gt; &lt;/tr&gt; &lt;tr bgcolor=&quot;white&quot;&gt; &lt;td&gt;&lt;b&gt;MENU_ERROR&lt;/b&gt;&lt;/td&gt; &lt;td&gt;Complete sent menu object not validated.&lt;/td&gt; &lt;/tr&gt; &lt;tr bgcolor=&quot;white&quot;&gt; &lt;td&gt;&lt;b&gt;MENU_OVERSIZE&lt;/b&gt;&lt;/td&gt; &lt;td&gt; Maximum permissible menu size was exceeded (30 Kb).&lt;/td&gt; &lt;/tr&gt; &lt;/tbody&gt; &lt;/table&gt; &lt;/td&gt;&lt;/tr&gt; &lt;/tbody&gt; &lt;/table&gt; &lt;br&gt;&lt;br&gt; &lt;a name=&quot;im_message_delete&quot;&gt;&lt;/a&gt; &lt;h3&gt;Delete chatbot message&lt;/h3&gt; &lt;b&gt;REST method&lt;/b&gt;: &lt;code&gt;im.message.delete&lt;/code&gt; &lt;br&gt;&lt;br&gt; &lt;b&gt;Method call&lt;/b&gt;: &lt;pre class=&quot;syntax&quot;&gt; $result = restCommand('im.message.delete', Array( 'MESSAGE_ID' =&amp;gt; 1, // Message ID ), $_REQUEST[&quot;auth&quot;]); &lt;/pre&gt; &lt;b&gt;Return&lt;/b&gt;: &lt;code&gt;true&lt;/code&gt; or an error.&lt;br&gt;&lt;br&gt; &lt;b&gt;Possible errors&lt;/b&gt;:&lt;br&gt;&lt;br&gt; &lt;table cellspacing=&quot;0&quot; cellpadding=&quot;0&quot;&gt; &lt;tbody&gt; &lt;tr bgcolor=&quot;white&quot;&gt; &lt;td bgcolor=&quot;#8c8c8c&quot;&gt; &lt;table cellspacing=&quot;1&quot; cellpadding=&quot;5&quot;&gt; &lt;tbody&gt; &lt;tr bgcolor=&quot;silver&quot;&gt; &lt;td&gt;&lt;b&gt;Error code&lt;/b&gt;&lt;/td&gt;&lt;td&gt;&lt;b&gt;Error description&lt;/b&gt;&lt;/td&gt; &lt;/tr&gt; &lt;tr bgcolor=&quot;white&quot;&gt; &lt;td valign=&quot;top&quot;&gt;&lt;b&gt;MESSAGE_ID_ERROR&lt;/b&gt;&lt;/td&gt; &lt;td&gt;No message ID.&lt;/td&gt; &lt;/tr&gt; &lt;tr bgcolor=&quot;white&quot;&gt; &lt;td&gt;&lt;b&gt;CANT_EDIT_MESSAGE&lt;/b&gt;&lt;/td&gt; &lt;td&gt;You don't have access to this message or time to modify it has expired (3 days passed since message posting).&lt;/td&gt; &lt;/tr&gt; &lt;/tbody&gt; &lt;/table&gt; &lt;/td&gt;&lt;/tr&gt; &lt;/tbody&gt; &lt;/table&gt; &lt;br&gt;&lt;br&gt; &lt;a name=&quot;im_message_like&quot;&gt;&lt;/a&gt; &lt;h3&gt;Message “Like”&lt;/h3&gt; &lt;b&gt;REST method&lt;/b&gt;: &lt;code&gt;im.message.like&lt;/code&gt; &lt;br&gt;&lt;br&gt; &lt;b&gt;Method call&lt;/b&gt;: &lt;pre class=&quot;syntax&quot;&gt; $result = restCommand('im.message.like', Array( 'MESSAGE_ID' =&amp;gt; 1, // Message ID (any message, sent in private or group chats that have chatbot) 'ACTION' =&amp;gt; 'auto' // Action, connected with method: plus - select «Like»; minus – remove «Like»; auto – automatic calculation, whether specified or not. If 'Like' is not specified, auto mode operation ), $_REQUEST[&quot;auth&quot;]); &lt;/pre&gt; &lt;b&gt;Return&lt;/b&gt;: &lt;code&gt;true&lt;/code&gt; or an error.&lt;br&gt;&lt;br&gt; &lt;b&gt;Possible errors&lt;/b&gt;:&lt;br&gt;&lt;br&gt; &lt;table cellspacing=&quot;0&quot; cellpadding=&quot;0&quot;&gt; &lt;tbody&gt; &lt;tr bgcolor=&quot;white&quot;&gt; &lt;td bgcolor=&quot;#8c8c8c&quot;&gt; &lt;table cellspacing=&quot;1&quot; cellpadding=&quot;5&quot;&gt; &lt;tbody&gt; &lt;tr bgcolor=&quot;silver&quot;&gt; &lt;td&gt;&lt;b&gt;Error code&lt;/b&gt;&lt;/td&gt;&lt;td&gt;&lt;b&gt;Error description&lt;/b&gt;&lt;/td&gt; &lt;/tr&gt; &lt;tr bgcolor=&quot;white&quot;&gt; &lt;td valign=&quot;top&quot;&gt;&lt;b&gt;MESSAGE_ID_ERROR&lt;/b&gt;&lt;/td&gt; &lt;td&gt;No message ID.&lt;/td&gt; &lt;/tr&gt; &lt;tr bgcolor=&quot;white&quot;&gt; &lt;td&gt;&lt;b&gt;WITHOUT_CHANGES&lt;/b&gt;&lt;/td&gt; &lt;td&gt; «Like» status.&lt;/td&gt; &lt;/tr&gt; &lt;/tbody&gt; &lt;/table&gt; &lt;/td&gt;&lt;/tr&gt; &lt;/tbody&gt; &lt;/table&gt; &lt;br&gt;&lt;br&gt;

Bitrix24 Bot Platform

Send message to chat

Update chatbot message

Delete chatbot message

Message “Like”