Получить метрики сессий 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 -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

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Статус

Код

Описание

Значение

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-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

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

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Предыдущая
Получить список сессий
Следующая
Получить список оценок