Получить метрики сессий imopenlines.v2.Session.Stat.get

Выберите инструмент для разработки с AI-агентом:

используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: imopenlines

Кто может выполнять метод: пользователь с доступом к отчетам открытых линий

Метод imopenlines.v2.Session.Stat.get получает пакетные метрики по сессиям открытых линий.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

sessionId*
integer[]

Массив идентификаторов сессий.

Идентификаторы можно получить методом imopenlines.v2.Session.list.

Максимум: 100 уникальных идентификаторов

Дубликаты в sessionId удаляются.

Если сессия не существует или недоступна пользователю, метод возвращает для нее объект sessionStat с null в полях метрик.

Поле voteHead в sessionStat возвращается как null, если тариф или права пользователя не позволяют видеть оценку руководителя.

Примеры кода

Как использовать примеры в документации

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 '{
    "sessionId": [1024, 1025, 999999]
  }' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imopenlines.v2.Session.Stat.get

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "sessionId": [1024, 1025, 999999],
    "auth": "**put_access_token_here**"
  }' \
  https://**put_your_bitrix24_address**/rest/imopenlines.v2.Session.Stat.get

import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

try {
  const response = await $b24.actions.v2.call.make({
    method: 'imopenlines.v2.Session.Stat.get',
    params: {
      sessionId: [1024, 1025, 999999],
    },
    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 getOpenlinesSessionStat() {
    try {
      const $b24 = await B24Js.initializeB24Frame()
      const response = await $b24.actions.v2.call.make({
        method: 'imopenlines.v2.Session.Stat.get',
        params: {
          sessionId: [1024, 1025, 999999],
        },
        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', getOpenlinesSessionStat)
</script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.call(
        "imopenlines.v2.Session.Stat.get",
        {
            "sessionId": [
                1024,
                1025,
                999999,
            ],
        },
    ).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.message}")

try {
    $response = $b24Service
        ->core
        ->call(
            'imopenlines.v2.Session.Stat.get',
            [
                'sessionId' => [1024, 1025, 999999],
            ]
        );

    print_r($response->getResponseData()->getResult());
} catch (Throwable $e) {
    echo $e->getMessage();
}

BX24.callMethod(
    'imopenlines.v2.Session.Stat.get',
    {
        sessionId: [1024, 1025, 999999],
    },
    function(result)
    {
        if (result.error())
        {
            console.error(result.error());
        }
        else
        {
            console.log(result.data());
        }
    }
);

require_once('crest.php');

$result = CRest::call(
    'imopenlines.v2.Session.Stat.get',
    [
        'sessionId' => [1024, 1025, 999999],
    ]
);

print_r($result);

res, err := client.Core().Call(ctx, "imopenlines.v2.Session.Stat.get", b24.Params{
	"sessionId": []int{1024, 1025, 999999},
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("imopenlines.v2.Session.Stat.get: %w", err)
}

fmt.Println(string(res.Result))

Обработка ответа

HTTP-статус: 200

{
    "result": {
        "sessions": [
            {
                "sessionId": 1024,
                "waitAnswer": 65,
                "waitClose": 1330,
                "messagesCount": 14,
                "messagesOperatorCount": 6,
                "messagesClientCount": 8,
                "transfersCount": 1,
                "kpiFirstAnswer": true,
                "vote": "like",
                "voteHead": 5
            },
            {
                "sessionId": 999999,
                "waitAnswer": null,
                "waitClose": null,
                "messagesCount": null,
                "messagesOperatorCount": null,
                "messagesClientCount": null,
                "transfersCount": null,
                "kpiFirstAnswer": null,
                "vote": null,
                "voteHead": null
            }
        ]
    },
    "time": {
        "start": 1782810000,
        "finish": 1782810000.2,
        "duration": 0.2,
        "processing": 0,
        "date_start": "2026-06-30T10:00:00+03:00",
        "date_finish": "2026-06-30T10:00:00+03:00",
        "operating_reset_at": 1782810600,
        "operating": 0
    }
}

Возвращаемые данные

Название `тип`	Описание
result `object`	Корневой объект ответа
result.sessions `sessionStat[]`	Метрики сессий. Все поля типа `sessionStat` смотрите в разделе Типы данных статистики открытых линий
time `time`	Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
    "error": "BATCH_LIMIT_EXCEEDED",
    "error_description": "sessionId batch must not exceed 100 items"
}

Название `тип`	Описание
error `string`	Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только `error_description`
error_description `string`	Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

Возможные коды ошибок

Статус	Код	Описание	Значение
`400`	`TARIFF_RESTRICTION`	Statistics reports are not available on the current tariff plan	Тариф не позволяет использовать отчеты открытых линий
`400`	`100`	Could not find value for parameter	Не передан обязательный параметр `sessionId`
`400`	`100`	Invalid value {value} to match with parameter {sessionId}. Should be value of type array.	`sessionId` передан не как массив
`400`	`BATCH_LIMIT_EXCEEDED`	sessionId batch must not exceed 100 items	Передано больше 100 уникальных идентификаторов сессий

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит
`401`	`NO_AUTH_FOUND` Wrong authorization data	В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука
`401`	`INVALID_REQUEST` Https required	Методы вызываются только по протоколу HTTPS
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24
`401`	`ACCESS_DENIED` REST is available only on commercial plans	REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом
`404`	`ERROR_METHOD_NOT_FOUND` Method not found!	Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на `provided by the access token`
`401`	`expired_token` The access token provided has expired	Срок действия access-токена истек
`401`	`user_access_error` The user does not have access to the application	Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям
`403`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Была ли статья полезна?

Получить список сессий

Получить список оценок

Получить метрики сессий imopenlines.v2.Session.Stat.get

Параметры методаПараметры метода

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

Возвращаемые данныеВозвращаемые данные

Обработка ошибокОбработка ошибок

Возможные коды ошибокВозможные коды ошибок

Статусы и коды системных ошибокСтатусы и коды системных ошибок

Продолжите изучениеПродолжите изучение