imopenlines.bot.session.finish

&lt;table width=&quot;100%&quot; cellpadding=&quot;5&quot;&gt; &lt;tbody&gt; &lt;tr&gt; &lt;td&gt;&lt;h3&gt;Finish current session&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]You can get information about the current API version (platform version) as follows: &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]: 1 &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; To use the IMOPENLINES REST methods you need to have access permissions for &lt;a href=&quot;/support/training/course/index.php?COURSE_ID=115&CHAPTER_ID=09773&quot; target=&quot;_blank&quot;&gt;imbot&lt;/a&gt; (Creating and managing chat bots) as well as access to the &lt;b&gt;imopenlines&lt;/b&gt; (Open channels) scope.&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;CHAT_ID&lt;/b&gt;&lt;/td&gt; &lt;td&gt;112&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;1&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;h3&gt;Method call and response&lt;/h3&gt; &lt;h4&gt;PHP&lt;/h4&gt; &lt;pre class=&quot;syntax&quot;&gt; $result = restCommand('imopenlines.bot.session.finish', Array( 'CHAT_ID' =&amp;gt; 112 ), $_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;b&gt;Result&lt;/b&gt;: &lt;code&gt;true&lt;/code&gt; or error.&lt;br&gt;&lt;br&gt; &lt;h3&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;No chat ID&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 description&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;No chat ID.&lt;/td&gt; &lt;/tr&gt; &lt;tr bgcolor=&quot;white&quot;&gt; &lt;td valign=&quot;top&quot;&gt;&lt;b&gt;BOT_ID_ERROR&lt;/b&gt;&lt;/td&gt; &lt;td&gt;Incorrect chat bot ID.&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

Finish current session

Parameters

Method call and response

PHP

Response example

Example of response on error

Possible error codes