im.chat.get

&lt;table width=&quot;100%&quot; cellpadding=&quot;5&quot;&gt; &lt;tbody&gt; &lt;tr&gt; &lt;td&gt;&lt;h3&gt;Gets chat ID&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&gt;&lt;b&gt;ENTITY_TYPE&lt;/b&gt;&lt;/td&gt; &lt;td&gt;CRM - for CRM, &lt;br&gt;[dw]LINES[/dw][di]From agent/operator[/di] or [dw]LIVECHAT[/dw][di]From user[/di] - for open lines&lt;/td&gt; &lt;td&gt;&lt;b&gt;Yes&lt;/b&gt;&lt;/td&gt; &lt;td&gt;Entity ID. Can be used for chat search or defining context in event handlers &lt;a href=&quot;/support/training/course/?COURSE_ID=115&LESSON_ID=9801#onimbotmessageadd&quot; target=&quot;_blank&quot;&gt;ONIMBOTMESSAGEADD&lt;/a&gt;, &lt;a href=&quot;/support/training/course/?COURSE_ID=115&LESSON_ID=9801#onimbotmessageudate&quot; target=&quot;_blank&quot;&gt;ONIMBOTMESSAGEUPDATE&lt;/a&gt;, &lt;a href=&quot;/support/training/course/?COURSE_ID=115&LESSON_ID=9801#onimbotmessagedelete&quot; target=&quot;_blank&quot;&gt;ONIMBOTMESSAGEDELETE&lt;/a&gt;&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;ENTITY_ID&lt;/b&gt;&lt;/td&gt; &lt;td&gt;LEAD|13 - for CRM, &lt;br&gt; facebook|2|1647215182041969|862 - for [dw]open lines[/dw][di]ENTITY_ID matches with USER_CODE from session.[/di]&lt;/td&gt; &lt;td&gt;&lt;b&gt;Yes&lt;/b&gt;&lt;/td&gt; &lt;td&gt;Entity numerical ID. Can be used for chat search or defining context in event handlers &lt;a href=&quot;/support/training/course/?COURSE_ID=115&LESSON_ID=9801#onimbotmessageadd&quot; target=&quot;_blank&quot;&gt;ONIMBOTMESSAGEADD&lt;/a&gt;, &lt;a href=&quot;/support/training/course/?COURSE_ID=115&LESSON_ID=9801#onimbotmessageudate&quot; target=&quot;_blank&quot;&gt;ONIMBOTMESSAGEUPDATE&lt;/a&gt;, &lt;a href=&quot;/support/training/course/?COURSE_ID=115&LESSON_ID=9801#onimbotmessagedelete&quot; target=&quot;_blank&quot;&gt;ONIMBOTMESSAGEDELETE&lt;/a&gt;&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;br&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.get', Array( 'ENTITY_TYPE' =&amp;gt; 'CRM', 'ENTITY_ID' =&amp;gt; 'LEAD|13', ), $_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;: 10 } &lt;/pre&gt; &lt;b&gt;Result&lt;/b&gt;: returns &lt;code&gt;CHAT_ID&lt;/code&gt; or &lt;code&gt;null&lt;/code&gt;. &lt;br&gt; &lt;br&gt;

Bitrix24 Bot Platform

Gets chat ID

Parameters

Called method and response

PHP

Response example