Получить список подписанных документов в сейфе компании sign.b2e.mysafe.tail

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

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

Scope: sign.b2e

Кто может выполнять метод: пользователь с доступом к разделу «Сейф компании». Доступные документы зависят от уровня права «Доступ к документам сейфа»

Метод sign.b2e.mysafe.tail возвращает список подписанных документов в сейфе компании.

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

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

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

Название
тип

Описание

limit
integer

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

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

По умолчанию выводится 20 записей на странице

offset
integer

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

Размер страницы результатов зависит от параметра limit

Примеры кода

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"limit":2,"offset":0,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sign.b2e.mysafe.tail
// 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 SafeDocument returned in result[]
type SafeDocument = {
  id: number
  title: string
  create_date: ISODate | null
  signed_date: ISODate | null
  creator_id: number
  member_id: number
  role: string
  file_url: string
}

try {
  // sign.b2e.mysafe.tail returns a single page (max 1000 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<SafeDocument[]>({
    method: 'sign.b2e.mysafe.tail',
    params: {
      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('Fetched documents:', result.length, result.map(d => `[${d.id}] ${d.title}`))
  }
} 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 fetchSafeDocuments() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      // sign.b2e.mysafe.tail returns a single page (max 1000 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.mysafe.tail',
        params: {
          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('Fetched documents:', result.length, result.map(d => `[${d.id}] ${d.title}`))
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', fetchSafeDocuments)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.sign.b2e.mysafe.tail(
        limit=2,
        offset=0,
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")
try {
    $response = $b24Service
        ->core
        ->call(
            'sign.b2e.mysafe.tail',
            [
                'limit'  => 2,
                'offset' => 0
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);
    // Нужная вам логика обработки данных
    processData($result);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error: ' . $e->getMessage();
}
BX24.callMethod(
    'sign.b2e.mysafe.tail',
    {
        // Количество записей на странице. Значение от 1 до 1000. По умолчанию 20.
        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.mysafe.tail',
    [
        'limit' => 2, // Количество записей на странице
        'offset' => 0 // Смещение от начала списка
    ]
);

if (isset($result['error'])) {
    echo 'Ошибка: ' . $result['error_description'];
} else {
    echo '<PRE>';
    print_r($result['result']);
    echo '</PRE>';
}
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sign.b2e.mysafe.tail", b24.Params{
	"limit":  2,
	"offset": 0,
})
if err != nil {
	return fmt.Errorf("sign.b2e.mysafe.tail: %w", err)
}

var items []struct {
	ID         b24.ID `json:"id"`
	Title      string `json:"title"`
	CreateDate string `json:"create_date"`
	SignedDate string `json:"signed_date"`
	CreatorID  int    `json:"creator_id"`
	MemberID   int    `json:"member_id"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
	fmt.Println(it.ID, it.Title)
}

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

HTTP-статус: 200

{
    "result": [
        {
            "id": 59,
            "title": "test-pdf е",
            "create_date": "2024-06-28T19:07:03+03:00",
            "signed_date": "2024-06-28T19:34:58+03:00",
            "creator_id": 1,
            "member_id": 1,
            "role": "signer",
            "file_url": "https://your-domain.bitrix24.ru/rest/download.json?auth=7e34b467...&token=sign.b2e..."
        },
        {
            "id": 55,
            "title": "test-pdf 778484",
            "create_date": "2024-06-28T18:37:37+03:00",
            "signed_date": "2024-06-28T18:39:47+03:00",
            "creator_id": 19,
            "member_id": 1,
            "role": "signer",
            "file_url": "https://your-domain.bitrix24.ru/rest/download.json?auth=7e34b467...&token=sign.b2e..."
        }
    ],
    "time": {
        "start": 1739859574.5550749,
        "finish": 1739859574.595099,
        "duration": 0.0400240421295166,
        "processing": 0.0148630142211914,
        "date_start": "2025-02-18T09:19:34+03:00",
        "date_finish": "2025-02-18T09:19:34+03:00",
        "operating_reset_at": 1739860174,
        "operating": 0
    }
}

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

Название
тип

Описание

result
array

Корневой элемент ответа. Содержит информацию о подписанных документах в сейфе компании

time
time

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

Элемент ответа result

Название
тип

Описание

id
integer

Идентификатор подписанного документа

title
string

Название документа

create_date
string

Дата создания документа

signed_date
string

Дата подписания документа

creator_id
integer

Идентификатор пользователя, создавшего документ

member_id
integer

Идентификатор пользователя, с которым подписан документ

role
string

Роль сотрудника в документе:

  • editor — заполняющий
  • reviewer — согласующий
  • assignee — представитель компании
  • signer — сотрудник

folderName
string

Название папки документа.

Возвращается, если включена группировка документов сейфа по папкам

file_url
string

Ссылка для скачивания подписанного документа

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

HTTP-статус: 401

{
    "error": "WRONG_AUTH_TYPE",
    "error_description": "Current authorization type is denied for this method Application context required"
}

Название
тип

Описание

error
string

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

error_description
string

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

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

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

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

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

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