Get Sessions imopenlines.v2.Session.list

Choose a tool for developing with an AI agent:

use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: imopenlines

Who can execute the method: a user with access to Open Channels reports

The method imopenlines.v2.Session.list retrieves Open Channel sessions with filters and pagination.

Method Parameters

Required parameters are marked with *

Name `type`	Description
configId `integer`	Open channel ID. You can obtain the ID using imopenlines.config.list.get
configIdList `integer[]`	List of open channel IDs. You can obtain the IDs using imopenlines.config.list.get. If both `configIdList` and `configId` are passed, `configIdList` is used. Maximum: 1000 items
operatorId `integer`	Operator ID. You can obtain the ID using user.get or user.search
operatorIdList `integer[]`	List of operator IDs. You can obtain the IDs using user.get or user.search. If both `operatorIdList` and `operatorId` are passed, `operatorIdList` is used. Maximum: 1000 items
source `string`	Channel code. You can obtain the code using imconnector.list
sourceList `string[]`	List of channel codes. You can obtain the codes using imconnector.list. If both `sourceList` and `source` are passed, `sourceList` is used. Maximum: 1000 items
status `string`	Session status. Possible values: `new` — session is in the queue or missed `answered` — operator is handling the dialog `closed` — session is closed `spam` — session is marked as spam `paused` — session is paused
closeReason `string`	Close reason. Cannot be passed together with `status`. Possible values: `operator` — session was closed by an operator `auto` — session was closed automatically by timeout `spam` — session was closed as spam `client` — session was closed because of customer inactivity `replyLimit` — session was closed after the channel response window expired
dateCreateFrom `string`	Start of the creation period in ISO 8601 format
dateCreateTo `string`	End of the creation period in ISO 8601 format. Maximum period: 366 days
dateCloseFrom `string`	Start of the close period in ISO 8601 format
dateCloseTo `string`	End of the close period in ISO 8601 format. Maximum period: 366 days
vote `string`	Customer rating. Possible values: `like` — customer left a like `dislike` — customer left a dislike `none` — no rating `any` — any customer rating exists
hasVoteHead `boolean`	Filter by supervisor rating availability. Possible values: `true`, `Y`, `1` — supervisor rating exists `false`, `N`, `0` — supervisor rating does not exist
kpiFirstAnswer `boolean`	Filter by first response KPI performance. Requires a full `dateCreateFrom` and `dateCreateTo` or `dateCloseFrom` and `dateCloseTo` period. Possible values: `true`, `Y`, `1` — first response KPI is met `false`, `N`, `0` — first response KPI is not met
hasCrm `boolean`	Filter by an available CRM link. Possible values: `true`, `Y`, `1` — an available CRM link exists `false`, `N`, `0` — no available CRM link exists
waitAnswerFrom `integer`	Minimum time to first response, seconds
waitAnswerTo `integer`	Maximum time to first response, seconds
waitCloseFrom `integer`	Minimum time to close, seconds
waitCloseTo `integer`	Maximum time to close, seconds
order `string`	Sort field. Possible values: `dateCreate` — session creation date `dateClose` — session close date `waitAnswer` — time to first response `waitClose` — time to close Default: `dateCreate`
orderDirection `string`	Sort direction. Possible values: `asc` — ascending `desc` — descending Default: `desc`
offset `integer`	Pagination offset. Default: `0`
limit `integer`	Page size. Possible values: from `1` to `200`. Default: `50`

Filters are combined with logical AND.

Sorting by dateClose, waitAnswer, and waitClose is applied only when a full creation or close period is specified; otherwise, the method sorts by dateCreate.

The voteHead and commentHead fields in session items are returned as null if the plan or user permissions do not allow viewing supervisor ratings. The hasVoteHead filter applies only to lines where the user has permission to view supervisor ratings.

The crmEntityType and crmEntityId fields in session items are returned as null if the user does not have read permission for the linked CRM object. The hasCrm filter considers only CRM links available to the user.

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{
            "configId": 3,
            "status": "closed",
            "dateCreateFrom": "2026-06-01T00:00:00+02:00",
            "dateCreateTo": "2026-06-30T23:59:59+02:00",
            "limit": 50
          }' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imopenlines.v2.Session.list

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{
            "configId": 3,
            "status": "closed",
            "dateCreateFrom": "2026-06-01T00:00:00+02:00",
            "dateCreateTo": "2026-06-30T23:59:59+02:00",
            "limit": 50,
            "auth": "**put_access_token_here**"
          }' \
          https://**put_your_bitrix24_address**/rest/imopenlines.v2.Session.list

import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        type SessionListResult = {
          sessions: Array<{ id: number, configId: number, status: string }>
          hasNextPage: boolean
        }
        
        try {
          const response = await $b24.actions.v2.call.make<SessionListResult>({
            method: 'imopenlines.v2.Session.list',
            params: {
              configId: 3,
              status: 'closed',
              dateCreateFrom: '2026-06-01T00:00:00+02:00',
              dateCreateTo: '2026-06-30T23:59:59+02:00',
              limit: 50,
            },
            requestId: Text.getUuidRfc4122()
          })
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            console.info(response.getData()!.result.sessions)
          }
        } catch (error) {
          console.error(error)
        }

<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function getOpenlinesSessions() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
              const response = await $b24.actions.v2.call.make({
                method: 'imopenlines.v2.Session.list',
                params: {
                  configId: 3,
                  status: 'closed',
                  dateCreateFrom: '2026-06-01T00:00:00+02:00',
                  dateCreateTo: '2026-06-30T23:59:59+02:00',
                  limit: 50,
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              console.info(response.getData().result.sessions)
            } catch (error) {
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getOpenlinesSessions)
        </script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.call(
                "imopenlines.v2.Session.list",
                {
                    "configId": 3,
                    "status": "closed",
                    "dateCreateFrom": "2026-06-01T00:00:00+02:00",
                    "dateCreateTo": "2026-06-30T23:59:59+02:00",
                    "limit": 50,
                },
            ).response
            print(bitrix_response.result)
        except BitrixAPIError as error:
            print(f"error: {error.error}", f"error_description: {error.error_description}", sep="\n")
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")

try {
            $response = $b24Service
                ->core
                ->call(
                    'imopenlines.v2.Session.list',
                    [
                        'configId' => 3,
                        'status' => 'closed',
                        'dateCreateFrom' => '2026-06-01T00:00:00+02:00',
                        'dateCreateTo' => '2026-06-30T23:59:59+02:00',
                        'limit' => 50,
                    ]
                );
        
            print_r($response->getResponseData()->getResult());
        } catch (Throwable $e) {
            echo $e->getMessage();
        }

BX24.callMethod(
            'imopenlines.v2.Session.list',
            {
                configId: 3,
                status: 'closed',
                dateCreateFrom: '2026-06-01T00:00:00+02:00',
                dateCreateTo: '2026-06-30T23:59:59+02:00',
                limit: 50,
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'imopenlines.v2.Session.list',
            [
                'configId' => 3,
                'status' => 'closed',
                'dateCreateFrom' => '2026-06-01T00:00:00+02:00',
                'dateCreateTo' => '2026-06-30T23:59:59+02:00',
                'limit' => 50,
            ]
        );
        
        print_r($result);

res, err := client.Core().Call(ctx, "imopenlines.v2.Session.list", b24.Params{
        	"configId":        3,
        	"status":          "closed",
        	"dateCreateFrom":  "2026-06-01T00:00:00+02:00",
        	"dateCreateTo":    "2026-06-30T23:59:59+02:00",
        	"limit":           50,
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("imopenlines.v2.Session.list: %w", err)
        }
        
        fmt.Println(string(res.Result))

Response Handling

HTTP Status: 200

{
            "result": {
                "sessions": [
                    {
                        "id": 1024,
                        "configId": 3,
                        "source": "livechat",
                        "operatorId": 42,
                        "userId": 501,
                        "userCode": "site_visitor_88a1",
                        "chatId": 2048,
                        "dateCreate": "2026-06-15T14:30:00+02:00",
                        "dateClose": "2026-06-15T14:52:10+02:00",
                        "dateFirstAnswer": "2026-06-15T14:31:05+02:00",
                        "dateOperatorAnswer": "2026-06-15T14:31:05+02:00",
                        "status": "closed",
                        "closeReason": "operator",
                        "vote": "like",
                        "voteHead": 5,
                        "commentHead": "Good work",
                        "crmEntityType": "deal",
                        "crmEntityId": 771,
                        "queueTransfers": 1,
                        "waitAnswer": 65,
                        "waitClose": 1330,
                        "kpiFirstAnswer": true,
                        "messageCount": 14
                    }
                ],
                "hasNextPage": false
            },
            "time": {
                "start": 1782810000,
                "finish": 1782810000.4,
                "duration": 0.4,
                "processing": 0,
                "date_start": "2026-06-30T10:00:00+02:00",
                "date_finish": "2026-06-30T10:00:00+02:00",
                "operating_reset_at": 1782810600,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	Root response object
result.sessions `session[]`	List of sessions. See all fields of the `session` type in Open Channels Statistics Data Types
result.hasNextPage `boolean`	Indicates whether there is a next page
time `time`	Information about the request execution time

Error Handling

HTTP Status: 400

{
            "error": "PERIOD_TOO_LARGE",
            "error_description": "The requested period exceeds the maximum of 1 year"
        }

Name `type`	Description
error `string`	String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only `error_description` shows the reason
error_description `string`	Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Status	Code	Description	Value
`400`	`TARIFF_RESTRICTION`	Statistics reports are not available on the current tariff plan	The plan does not allow using Open Channels reports
`400`	`INVALID_FILTER`	Invalid filter value	An invalid filter, date, date order, combination of `status` and `closeReason`, list with more than 1000 items, or `kpiFirstAnswer` without a full period was passed
`400`	`PERIOD_TOO_LARGE`	The requested period exceeds the maximum of 1 year	The creation or close period is longer than 366 days
`400`	`OFFSET_TOO_LARGE`	Offset is too large	`offset` is greater than `10000`

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit
`401`	`NO_AUTH_FOUND` Wrong authorization data	The request contains no authorization data: neither an access token nor a webhook code was passed
`401`	`INVALID_REQUEST` Https required	Methods are called over the HTTPS protocol only
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support
`401`	`ACCESS_DENIED` REST is available only on commercial plans	REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	No active webhook with the specified user identifier and secret code was found
`404`	`ERROR_METHOD_NOT_FOUND` Method not found!	No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with `provided by the access token`
`401`	`expired_token` The access token provided has expired	The access token has expired
`401`	`user_access_error` The user does not have access to the application	The application is installed, but the Bitrix24 administrator has granted access to it only to specific users
`403`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Was the article helpful?

Get Operators with Load

Get Session Metrics

Get Sessions imopenlines.v2.Session.list

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning