im.chat.user.add

&lt;table width=&quot;100%&quot; cellpadding=&quot;5&quot;&gt; &lt;tbody&gt; &lt;tr&gt; &lt;td&gt;&lt;h3&gt;Invites participants&lt;/h3&gt;&lt;/td&gt; &lt;td style=&quot;padding-top: 30px;&quot; align=&quot;right&quot; width=&quot;20%&quot;&gt;[dw]&lt;b&gt;Revision&lt;/b&gt;[/dw][di]Get current information about current API revision (platform version) – &lt;a href=&quot;/support/training/course/index.php?COURSE_ID=115&LESSON_ID=11547&quot; target=&quot;_blank&quot;&gt;im.revision.get&lt;/a&gt;[/di]: 18 &lt;/td&gt; &lt;/tr&gt; &lt;/tbody&gt; &lt;/table&gt; &lt;p&gt;&lt;div class=&quot;warning&quot;&gt;&lt;b&gt;Attention&lt;/b&gt;: &lt;b&gt;restCommand&lt;/b&gt; function is used here for illustration purposes only. It is taken from the &lt;a href=&quot;https://github.com/bitrix24com/bots/&quot; target=&quot;_blank&quot;&gt;EchoBot&lt;/a&gt; example. 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/bx24.callbind.php &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; methods. &lt;/div&gt;&lt;/p&gt; &lt;h3 class=&quot;tab-title&quot;&gt;Parameters&lt;/h3&gt; &lt;table cellspacing=&quot;0&quot; cellpadding=&quot;0&quot; width=&quot;100%&quot;&gt; &lt;tbody&gt; &lt;tr bgcolor=&quot;white&quot; width=&quot;100%&quot;&gt; &lt;td bgcolor=&quot;#8c8c8c&quot;&gt; &lt;table cellspacing=&quot;1&quot; cellpadding=&quot;6&quot; &gt; &lt;tbody&gt; &lt;tr bgcolor=&quot;silver&quot;&gt; &lt;td width=&quot;15%&quot;&gt;&lt;b&gt;Parameter&lt;/b&gt;&lt;/td&gt; &lt;td width=&quot;25%&quot;&gt;&lt;b&gt;Example&lt;/b&gt;&lt;/td&gt; &lt;td width=&quot;5%&quot;&gt;&lt;b&gt;Required&lt;/b&gt;&lt;/td&gt; &lt;td width=&quot;55%&quot;&gt;&lt;b&gt;Description&lt;/b&gt;&lt;/td&gt; &lt;td width=&quot;5%&quot;&gt;&lt;b&gt;Revision&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;CHAT_ID&lt;/b&gt;&lt;/td&gt; &lt;td&gt;13&lt;/td&gt; &lt;td&gt;&lt;b&gt;Yes&lt;/b&gt;&lt;/td&gt; &lt;td&gt;Chat ID&lt;/td&gt; &lt;td&gt;18&lt;/td&gt; &lt;/tr&gt; &lt;tr bgcolor=&quot;#F2F2F2&quot;&gt; &lt;td&gt;&lt;b&gt;USERS&lt;/b&gt;&lt;/td&gt; &lt;td&gt;Array(3,4)&lt;/td&gt; &lt;td&gt;&lt;b&gt;Yes&lt;/b&gt;&lt;/td&gt; &lt;td&gt;New user IDs&lt;/td&gt; &lt;td&gt;18&lt;/td&gt; &lt;/tr&gt; &lt;tr bgcolor=&quot;white&quot;&gt; &lt;td valign=&quot;top&quot;&gt;&lt;b&gt;HIDE_HISTORY&lt;/b&gt;&lt;/td&gt; &lt;td&gt;N&lt;/td&gt; &lt;td&gt;&lt;b&gt;No&lt;/b&gt;&lt;/td&gt; &lt;td&gt;Shows chat history for the user added using this method. Boolean Y/N - &quot;N&quot; by default. New user won't see the chat history, if passed as &quot;Y&quot;.&lt;/td&gt; &lt;td&gt;18&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;h3 class=&quot;tab-title&quot;&gt;Called method and response&lt;/h3&gt; &lt;h4&gt;PHP&lt;/h4&gt; &lt;pre class=&quot;syntax&quot;&gt; $result = restCommand('im.chat.user.add', Array( 'CHAT_ID' =&amp;gt; 13, 'USERS' =&amp;gt; Array(3,4) 'HIDE_HISTORY' =&amp;gt; N, ), $_REQUEST[&quot;auth&quot;]); &lt;/pre&gt; &lt;h3&gt;Response example&lt;/h3&gt; &lt;pre class=&quot;syntax&quot;&gt; { &quot;result&quot;: true } &lt;/pre&gt; &lt;br&gt; &lt;h3 class=&quot;tab-title&quot;&gt;Example of response on error&lt;/h3&gt; &lt;pre class=&quot;syntax&quot;&gt; { &quot;error&quot;: &quot;CHAT_ID_EMPTY&quot;, &quot;error_description&quot;: &quot;Chat ID not passed&quot; } &lt;/pre&gt; &lt;p&gt;&lt;b&gt;Key description&lt;/b&gt;:&lt;/p&gt; &lt;ul&gt; &lt;li&gt;&lt;code&gt;error&lt;/code&gt; – error code&lt;/li&gt; &lt;li&gt;&lt;code&gt;error_description&lt;/code&gt; – error brief code&lt;/li&gt; &lt;/ul&gt; &lt;h3&gt;Possible error codes&lt;/h3&gt; &lt;table cellspacing=&quot;0&quot; cellpadding=&quot;0&quot; width=&quot;100%&quot;&gt; &lt;tbody&gt; &lt;tr bgcolor=&quot;white&quot; width=&quot;100%&quot;&gt; &lt;td bgcolor=&quot;#8c8c8c&quot;&gt; &lt;table cellspacing=&quot;1&quot; cellpadding=&quot;6&quot; &gt; &lt;tbody&gt; &lt;tr bgcolor=&quot;silver&quot;&gt; &lt;td width=&quot;15%&quot;&gt;&lt;b&gt;Code&lt;/b&gt;&lt;/td&gt; &lt;td&gt;&lt;b&gt;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;CHAT_ID_EMPTY&lt;/b&gt;&lt;/td&gt; &lt;td&gt;Chat ID not passed&lt;/td&gt; &lt;/tr&gt; &lt;tr bgcolor=&quot;#F2F2F2&quot;&gt; &lt;td valign=&quot;top&quot;&gt;&lt;b&gt;WRONG_REQUEST&lt;/b&gt;&lt;/td&gt; &lt;td&gt;You don't have sufficient access permissions for adding participants to chat or participant already included into chat&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;

Bitrix24 Bot Platform

Invites participants

Parameters

Called method and response

PHP

Response example

Example of response on error

Possible error codes