Получить список провайдеров компании sign.b2e.company.provider.list

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

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

Scope: sign.b2e, crm

Кто может выполнять метод: пользователь с правом создавать документы КЭДО

Метод sign.b2e.company.provider.list возвращает список провайдеров подписи для выбранной компании.

Метод работает только в контексте авторизации приложения.

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

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

Название
тип

Описание

companyUuid*
string

UUID компании в HCM Link.

Обязателен, если не передан параметр companyCrmId.

Требует дополнительный scope humanresources.hcmlink

companyCrmId*
integer

Идентификатор компании в CRM, подключенный в интеграции как «моя компания».

Обязателен, если не передан параметр companyUuid

language
string

Язык локализации названий провайдеров.

По умолчанию en

limit
integer

Количество записей на странице.

Параметр принимает значение от 1 до 1000.

По умолчанию 100

offset
integer

Параметр для управления постраничной навигацией.

По умолчанию 0

Передайте один из параметров companyUuid или companyCrmId.

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"companyCrmId":12,"limit":2,"offset":0,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sign.b2e.company.provider.list
        
// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of each provider item returned in result[]
        type ProviderItem = {
          code: string
          uid: string
          name: string
          date: ISODate | null
          expires: ISODate | null
        }
        
        try {
          // sign.b2e.company.provider.list returns a single page (max 50 records). For the whole result set
          // use a list helper: $b24.actions.v2.callList.make() returns every record as one
          // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
          // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
          // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
          const response = await $b24.actions.v2.call.make<ProviderItem[]>({
            method: 'sign.b2e.company.provider.list',
            params: {
              // UUID of the company in HCM Link or its CRM company ID
              companyCrmId: 12,
              // Language for provider name localization
              language: 'en',
              // Pagination parameters
              limit: 2,
              offset: 0,
            },
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info(result.length, result[0]?.name, result[0]?.uid)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function fetchCompanyProviders() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              // sign.b2e.company.provider.list returns a single page (max 50 records). For the whole result set
              // use a list helper: $b24.actions.v2.callList.make() returns every record as one
              // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
              // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
              // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
              const response = await $b24.actions.v2.call.make({
                method: 'sign.b2e.company.provider.list',
                params: {
                  // UUID of the company in HCM Link or its CRM company ID
                  companyCrmId: 12,
                  // Language for provider name localization
                  language: 'en',
                  // Pagination parameters
                  limit: 2,
                  offset: 0,
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info(result.length, result[0]?.name, result[0]?.uid)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', fetchCompanyProviders)
        </script>
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'sign.b2e.company.provider.list',
                    [
                        'companyCrmId' => 12,
                        'language' => 'ru',
                        'limit' => 2,
                        'offset' => 0
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'sign.b2e.company.provider.list',
            {
                companyCrmId: 12,
                language: 'ru',
                limit: 2,
                offset: 0
            },
            result => {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.dir(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'sign.b2e.company.provider.list',
            [
                'companyCrmId' => 12,
                'language' => 'ru',
                'limit' => 2,
                'offset' => 0
            ]
        );
        
        if (isset($result['error'])) {
            echo 'Ошибка: ' . $result['error_description'];
        } else {
            echo '<PRE>';
            print_r($result['result']);
            echo '</PRE>';
        }
        

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

HTTP-статус: 200

{
            "result": [
                {
                    "code": "ses-ru",
                    "uid": "d4f6b8a1-4c6d-4d8c-9c7c-2d1b1f6d0f2b",
                    "name": "Битрикс24 КЭДО",
                    "date": "2025-02-18T10:15:30+03:00",
                    "expires": "2026-02-18T10:15:30+03:00"
                }
            ],
            "time": {
                "start": 1739860000.123,
                "finish": 1739860000.456,
                "duration": 0.333,
                "processing": 0.111,
                "date_start": "2025-02-18T09:19:34+03:00",
                "date_finish": "2025-02-18T09:19:34+03:00",
                "operating_reset_at": 1739860600,
                "operating": 0
            }
        }
        

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

Название
тип

Описание

result
array

Список провайдеров подписи компании

time
time

Информация о времени выполнения запроса

Элемент массива result

Название
тип

Описание

code
string

Код провайдера

uid
string

Уникальный идентификатор провайдера

name
string

Название провайдера с учетом языка

date
string

Дата регистрации провайдера в формате ISO 8601

expires
string

Дата окончания действия провайдера в формате ISO 8601

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

HTTP-статус: 200

{
            "error": "ACCESS_DENIED",
            "error_description": "Access denied!"
        }
        

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

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

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

Код

Описание

Когда возникает

ACCESS_DENIED

Access denied!

Недостаточно прав

WRONG_AUTH_TYPE

Current authorization type is denied for this method

Вызов не из контекста приложения

510

Company was not found.

Компания не найдена по companyUuid или companyCrmId

510

My company ... not found

Компания CRM не найдена

-

Parameter 'companyUuid' or 'companyCrmId' is required

Не переданы идентификаторы компании

-

humanresources module is not installed

Модуль humanresources не установлен при использовании companyUuid

-

Error while autoregistering providers

Ошибка автрегистрации виртуальных провайдеров. Проверьте данные моей компании в CRM

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

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

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

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