Добавить обработчик службы доставки sale.delivery.handler.add

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

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

Scope: delivery

Кто может выполнять метод: администратор CRM

Метод sale.delivery.handler.add добавляет обработчик службы доставки.

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

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

Название
тип

Описание

NAME*
string

Название обработчика службы доставки

CODE*
string

Символьный код обработчика службы доставки

SORT
integer

Сортировка

DESCRIPTION
integer

Описание обработчика службы доставки

SETTINGS*
object

Объект, содержащий информацию о настройках обработчика службы доставки (подробное описание приведено ниже)

PROFILES*
object[]

Массив, содержащий список объектов профилей доставки (подробное описание приведено ниже).

Подразумевается, что у обработчика службы доставки должен быть как минимум 1 профиль

Параметр SETTINGS

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

Название
тип

Описание

CALCULATE_URL*
string

URL для расчета стоимости доставки.

На данный URL приходят данные о посылке (что доставить, куда и как), стоимость доставки которой нужно рассчитать в ответе.

Формат запроса и ответа детально описан в документации по веб-хуку Расчет стоимости доставки

CREATE_DELIVERY_REQUEST_URL
string

URL для создания заказа на доставку.

На данный URL приходят данные о посылке (что доставить, куда и как), заказ на которую нужно оформить в службе доставки.

Формат запроса и ответа детально описан в документации по веб-хуку Создание заказа на доставку

CANCEL_DELIVERY_REQUEST_URL
string

URL для отмены заказа на доставку

На данный URL приходят данные о посылке (что доставить, куда и как), заказ на которую нужно отменить в службе доставки.

Формат запроса и ответа детально описан в документации по веб-хуку Отмена заказа на доставку

HAS_CALLBACK_TRACKING_SUPPORT
string

Индикатор того, будет ли служба доставки присылать оповещения о статусе заказа на доставку (см. метод sale.delivery.request.sendmessage).

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

Возможные значения:

  • Y — есть поддержка
  • N — нет поддержки

CONFIG
object[]

Массив объектов с доступными настройками для службы доставки, создаваемой с использованием данного обработчика (подробное описание приведено ниже)

Параметр CONFIG

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

Название
тип

Описание

TYPE*
string

Тип поля настройки
Возможные значения:

  • STRING — строка
  • Y/N — чекбокс (да / нет)
  • NUMBER — число
  • ENUM — список
  • DATE — дата
  • LOCATION — местоположение

CODE*
string

Символьный код настройки

NAME*
string

Название настройки

OPTIONS
object

Список опций для выбора. Объект в формате ключ=значение. Где ключ — код опции, а значение — опция.

Пример:

{
   "Option1Code": "Option1Value",
   "Option2Code": "Option2Value",
   "Option3Code": "Option3Value"
}

Параметр актуален только для настройки типа ENUM

Параметр PROFILES

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

Название
тип

Описание

NAME*
string

Название профиля обработчика службы доставки

CODE*
string

Символьный код профиля обработчика службы доставки

DESCRIPTION
string

Описание профиля обработчика службы доставки

Примеры кода

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"CODE":"uber","NAME":"Uber","DESCRIPTION":"Uber Description","SORT":250,"SETTINGS":{"CALCULATE_URL":"http://gateway.bx/calculate.php","CREATE_DELIVERY_REQUEST_URL":"http://gateway.bx/create_delivery_request.php","CANCEL_DELIVERY_REQUEST_URL":"http://gateway.bx/cancel_delivery_request.php","HAS_CALLBACK_TRACKING_SUPPORT":"Y","CONFIG":[{"TYPE":"STRING","CODE":"SETTING_1","NAME":"String Example"},{"TYPE":"Y/N","CODE":"SETTING_2","NAME":"Checkbox Example"},{"TYPE":"NUMBER","CODE":"SETTING_3","NAME":"Number Example"},{"TYPE":"ENUM","CODE":"SETTING_4","NAME":"Enum Example","OPTIONS":{"Option1Code":"Option1Value","Option2Code":"Option2Value","Option3Code":"Option3Value","Option4Code":"Option4Value","Option5Code":"Option5Value"}},{"TYPE":"DATE","CODE":"SETTING_5","NAME":"Date Example"},{"TYPE":"LOCATION","CODE":"SETTING_6","NAME":"Location Example"}]},"PROFILES":[{"NAME":"Taxi","CODE":"TAXI","DESCRIPTION":"Taxi Delivery"},{"NAME":"Cargo","CODE":"CARGO","DESCRIPTION":"Cargo Delivery"}]}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.delivery.handler.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"CODE":"uber","NAME":"Uber","DESCRIPTION":"Uber Description","SORT":250,"SETTINGS":{"CALCULATE_URL":"http://gateway.bx/calculate.php","CREATE_DELIVERY_REQUEST_URL":"http://gateway.bx/create_delivery_request.php","CANCEL_DELIVERY_REQUEST_URL":"http://gateway.bx/cancel_delivery_request.php","HAS_CALLBACK_TRACKING_SUPPORT":"Y","CONFIG":[{"TYPE":"STRING","CODE":"SETTING_1","NAME":"String Example"},{"TYPE":"Y/N","CODE":"SETTING_2","NAME":"Checkbox Example"},{"TYPE":"NUMBER","CODE":"SETTING_3","NAME":"Number Example"},{"TYPE":"ENUM","CODE":"SETTING_4","NAME":"Enum Example","OPTIONS":{"Option1Code":"Option1Value","Option2Code":"Option2Value","Option3Code":"Option3Value","Option4Code":"Option4Value","Option5Code":"Option5Value"}},{"TYPE":"DATE","CODE":"SETTING_5","NAME":"Date Example"},{"TYPE":"LOCATION","CODE":"SETTING_6","NAME":"Location Example"}]},"PROFILES":[{"NAME":"Taxi","CODE":"TAXI","DESCRIPTION":"Taxi Delivery"},{"NAME":"Cargo","CODE":"CARGO","DESCRIPTION":"Cargo Delivery"}],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.delivery.handler.add
// 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 } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

try {
  const response = await $b24.actions.v2.call.make<number>({
    method: 'sale.delivery.handler.add',
    params: {
      CODE: 'uber',
      NAME: 'Uber',
      DESCRIPTION: 'Uber Description',
      SORT: 250,
      SETTINGS: {
        CALCULATE_URL: 'http://gateway.bx/calculate.php',
        CREATE_DELIVERY_REQUEST_URL: 'http://gateway.bx/create_delivery_request.php',
        CANCEL_DELIVERY_REQUEST_URL: 'http://gateway.bx/cancel_delivery_request.php',
        HAS_CALLBACK_TRACKING_SUPPORT: 'Y',
        CONFIG: [
          { TYPE: 'STRING', CODE: 'SETTING_1', NAME: 'String Example' },
          { TYPE: 'Y/N', CODE: 'SETTING_2', NAME: 'Checkbox Example' },
          { TYPE: 'NUMBER', CODE: 'SETTING_3', NAME: 'Number Example' },
          {
            TYPE: 'ENUM',
            CODE: 'SETTING_4',
            NAME: 'Enum Example',
            OPTIONS: {
              Option1Code: 'Option1Value',
              Option2Code: 'Option2Value',
              Option3Code: 'Option3Value',
              Option4Code: 'Option4Value',
              Option5Code: 'Option5Value',
            },
          },
          { TYPE: 'DATE', CODE: 'SETTING_5', NAME: 'Date Example' },
          { TYPE: 'LOCATION', CODE: 'SETTING_6', NAME: 'Location Example' },
        ],
      },
      PROFILES: [
        { NAME: 'Taxi', CODE: 'TAXI', DESCRIPTION: 'Taxi Delivery' },
        { NAME: 'Cargo', CODE: 'CARGO', DESCRIPTION: 'Cargo Delivery' },
      ],
    },
    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('Added delivery handler, ID:', result)
  }
} 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 addDeliveryHandler() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'sale.delivery.handler.add',
        params: {
          CODE: 'uber',
          NAME: 'Uber',
          DESCRIPTION: 'Uber Description',
          SORT: 250,
          SETTINGS: {
            CALCULATE_URL: 'http://gateway.bx/calculate.php',
            CREATE_DELIVERY_REQUEST_URL: 'http://gateway.bx/create_delivery_request.php',
            CANCEL_DELIVERY_REQUEST_URL: 'http://gateway.bx/cancel_delivery_request.php',
            HAS_CALLBACK_TRACKING_SUPPORT: 'Y',
            CONFIG: [
              { TYPE: 'STRING', CODE: 'SETTING_1', NAME: 'String Example' },
              { TYPE: 'Y/N', CODE: 'SETTING_2', NAME: 'Checkbox Example' },
              { TYPE: 'NUMBER', CODE: 'SETTING_3', NAME: 'Number Example' },
              {
                TYPE: 'ENUM',
                CODE: 'SETTING_4',
                NAME: 'Enum Example',
                OPTIONS: {
                  Option1Code: 'Option1Value',
                  Option2Code: 'Option2Value',
                  Option3Code: 'Option3Value',
                  Option4Code: 'Option4Value',
                  Option5Code: 'Option5Value',
                },
              },
              { TYPE: 'DATE', CODE: 'SETTING_5', NAME: 'Date Example' },
              { TYPE: 'LOCATION', CODE: 'SETTING_6', NAME: 'Location Example' },
            ],
          },
          PROFILES: [
            { NAME: 'Taxi', CODE: 'TAXI', DESCRIPTION: 'Taxi Delivery' },
            { NAME: 'Cargo', CODE: 'CARGO', DESCRIPTION: 'Cargo Delivery' },
          ],
        },
        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('Added delivery handler, ID:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

settings = {
    "CALCULATE_URL": "http://gateway.bx/calculate.php",
    "CREATE_DELIVERY_REQUEST_URL": "http://gateway.bx/create_delivery_request.php",
    "CANCEL_DELIVERY_REQUEST_URL": "http://gateway.bx/cancel_delivery_request.php",
    "HAS_CALLBACK_TRACKING_SUPPORT": "Y",
    "CONFIG": [
        {
            "TYPE": "STRING",
            "CODE": "SETTING_1",
            "NAME": "String Example",
        },
        {
            "TYPE": "Y/N",
            "CODE": "SETTING_2",
            "NAME": "Checkbox Example",
        },
        {
            "TYPE": "NUMBER",
            "CODE": "SETTING_3",
            "NAME": "Number Example",
        },
        {
            "TYPE": "ENUM",
            "CODE": "SETTING_4",
            "NAME": "Enum Example",
            "OPTIONS": {
                "Option1Code": "Option1Value",
                "Option2Code": "Option2Value",
                "Option3Code": "Option3Value",
                "Option4Code": "Option4Value",
                "Option5Code": "Option5Value",
            },
        },
        {
            "TYPE": "DATE",
            "CODE": "SETTING_5",
            "NAME": "Date Example",
        },
        {
            "TYPE": "LOCATION",
            "CODE": "SETTING_6",
            "NAME": "Location Example",
        },
    ],
}

profiles = [
    {
        "NAME": "Taxi",
        "CODE": "TAXI",
        "DESCRIPTION": "Taxi Delivery",
    },
    {
        "NAME": "Cargo",
        "CODE": "CARGO",
        "DESCRIPTION": "Cargo Delivery",
    },
]

try:
    bitrix_response = client.sale.delivery.handler.add(
        code='uber',
        name='Uber',
        settings=settings,
        profiles=profiles,
        sort=250,
        description='Uber Description',
    ).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(
            'sale.delivery.handler.add',
            [
                'CODE'        => "uber",
                'NAME'        => "Uber",
                'DESCRIPTION' => "Uber Description",
                'SORT'        => 250,
                'SETTINGS'    => [
                    'CALCULATE_URL'                => "http://gateway.bx/calculate.php",
                    'CREATE_DELIVERY_REQUEST_URL'  => "http://gateway.bx/create_delivery_request.php",
                    'CANCEL_DELIVERY_REQUEST_URL'  => "http://gateway.bx/cancel_delivery_request.php",
                    'HAS_CALLBACK_TRACKING_SUPPORT' => "Y",
                    'CONFIG'                       => [
                        [
                            'TYPE' => "STRING",
                            'CODE' => "SETTING_1",
                            'NAME' => "String Example",
                        ],
                        [
                            'TYPE' => "Y/N",
                            'CODE' => "SETTING_2",
                            'NAME' => "Checkbox Example",
                        ],
                        [
                            'TYPE' => "NUMBER",
                            'CODE' => "SETTING_3",
                            'NAME' => "Number Example",
                        ],
                        [
                            'TYPE'    => "ENUM",
                            'CODE'    => "SETTING_4",
                            'NAME'    => "Enum Example",
                            'OPTIONS' => [
                                "Option1Code" => "Option1Value",
                                "Option2Code" => "Option2Value",
                                "Option3Code" => "Option3Value",
                                "Option4Code" => "Option4Value",
                                "Option5Code" => "Option5Value",
                            ],
                        ],
                        [
                            'TYPE' => "DATE",
                            'CODE' => "SETTING_5",
                            'NAME' => "Date Example",
                        ],
                        [
                            'TYPE' => "LOCATION",
                            'CODE' => "SETTING_6",
                            'NAME' => "Location Example",
                        ],
                    ],
                ],
                'PROFILES'    => [
                    [
                        'NAME'        => "Taxi",
                        'CODE'        => "TAXI",
                        'DESCRIPTION' => "Taxi Delivery",
                    ],
                    [
                        'NAME'        => "Cargo",
                        'CODE'        => "CARGO",
                        'DESCRIPTION' => "Cargo Delivery",
                    ],
                ],
            ]
        );

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

    echo 'Success: ' . print_r($result, true);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error adding delivery handler: ' . $e->getMessage();
}
BX24.callMethod(
    'sale.delivery.handler.add', {
        CODE: "uber",
        NAME: "Uber",
        DESCRIPTION: "Uber Description",
        SORT: 250,
        SETTINGS: {
            CALCULATE_URL: "http://gateway.bx/calculate.php",
            CREATE_DELIVERY_REQUEST_URL: "http://gateway.bx/create_delivery_request.php",
            CANCEL_DELIVERY_REQUEST_URL: "http://gateway.bx/cancel_delivery_request.php",
            HAS_CALLBACK_TRACKING_SUPPORT: "Y",
            CONFIG: [{
                    TYPE: "STRING",
                    CODE: "SETTING_1",
                    NAME: "String Example",
                },
                {
                    TYPE: "Y/N",
                    CODE: "SETTING_2",
                    NAME: "Checkbox Example",
                },
                {
                    TYPE: "NUMBER",
                    CODE: "SETTING_3",
                    NAME: "Number Example",
                },
                {
                    TYPE: "ENUM",
                    CODE: "SETTING_4",
                    NAME: "Enum Example",
                    OPTIONS: {
                        "Option1Code": "Option1Value",
                        "Option2Code": "Option2Value",
                        "Option3Code": "Option3Value",
                        "Option4Code": "Option4Value",
                        "Option5Code": "Option5Value",
                    },
                },
                {
                    TYPE: "DATE",
                    CODE: "SETTING_5",
                    NAME: "Date Example",
                },
                {
                    TYPE: "LOCATION",
                    CODE: "SETTING_6",
                    NAME: "Location Example",
                },
            ],
        },
        PROFILES: [{
                NAME: "Taxi",
                CODE: "TAXI",
                DESCRIPTION: "Taxi Delivery",
            },
            {
                NAME: "Cargo",
                CODE: "CARGO",
                DESCRIPTION: "Cargo Delivery",
            },
        ],
    },
    function(result) {
        if (result.error()) {
            console.error(result.error());
        } else {
            console.info(result.data());
        }
    }
);
require_once('crest.php');

$result = CRest::call(
    'sale.delivery.handler.add',
    [
        'CODE' => "uber",
        'NAME' => "Uber",
        'DESCRIPTION' => "Uber Description",
        'SORT' => 250,
        'SETTINGS' => [
            'CALCULATE_URL' => "http://gateway.bx/calculate.php",
            'CREATE_DELIVERY_REQUEST_URL' => "http://gateway.bx/create_delivery_request.php",
            'CANCEL_DELIVERY_REQUEST_URL' => "http://gateway.bx/cancel_delivery_request.php",
            'HAS_CALLBACK_TRACKING_SUPPORT' => "Y",
            'CONFIG' => [
                ['TYPE' => "STRING", 'CODE' => "SETTING_1", 'NAME' => "String Example"],
                ['TYPE' => "Y/N", 'CODE' => "SETTING_2", 'NAME' => "Checkbox Example"],
                ['TYPE' => "NUMBER", 'CODE' => "SETTING_3", 'NAME' => "Number Example"],
                [
                    'TYPE' => "ENUM",
                    'CODE' => "SETTING_4",
                    'NAME' => "Enum Example",
                    'OPTIONS' => [
                        "Option1Code" => "Option1Value",
                        "Option2Code" => "Option2Value",
                        "Option3Code" => "Option3Value",
                        "Option4Code" => "Option4Value",
                        "Option5Code" => "Option5Value",
                    ],
                ],
                ['TYPE' => "DATE", 'CODE' => "SETTING_5", 'NAME' => "Date Example"],
                ['TYPE' => "LOCATION", 'CODE' => "SETTING_6", 'NAME' => "Location Example"],
            ],
        ],
        'PROFILES' => [
            ['NAME' => "Taxi", 'CODE' => "TAXI", 'DESCRIPTION' => "Taxi Delivery"],
            ['NAME' => "Cargo", 'CODE' => "CARGO", 'DESCRIPTION' => "Cargo Delivery"],
        ],
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sale.delivery.handler.add", b24.Params{
	"CODE":        "uber",
	"NAME":        "Uber",
	"DESCRIPTION": "Uber Description",
	"SORT":        250,
	"SETTINGS": b24.Params{
		"CALCULATE_URL":                 "http://gateway.bx/calculate.php",
		"CREATE_DELIVERY_REQUEST_URL":   "http://gateway.bx/create_delivery_request.php",
		"CANCEL_DELIVERY_REQUEST_URL":   "http://gateway.bx/cancel_delivery_request.php",
		"HAS_CALLBACK_TRACKING_SUPPORT": "Y",
		"CONFIG": []b24.Params{
			{
				"TYPE": "STRING",
				"CODE": "SETTING_1",
				"NAME": "String Example",
			},
			{
				"TYPE": "Y/N",
				"CODE": "SETTING_2",
				"NAME": "Checkbox Example",
			},
			{
				"TYPE": "NUMBER",
				"CODE": "SETTING_3",
				"NAME": "Number Example",
			},
			{
				"TYPE": "ENUM",
				"CODE": "SETTING_4",
				"NAME": "Enum Example",
				"OPTIONS": b24.Params{
					"Option1Code": "Option1Value",
					"Option2Code": "Option2Value",
					"Option3Code": "Option3Value",
					"Option4Code": "Option4Value",
					"Option5Code": "Option5Value",
				},
			},
			{
				"TYPE": "DATE",
				"CODE": "SETTING_5",
				"NAME": "Date Example",
			},
			{
				"TYPE": "LOCATION",
				"CODE": "SETTING_6",
				"NAME": "Location Example",
			},
		},
	},
	"PROFILES": []b24.Params{
		{
			"NAME":        "Taxi",
			"CODE":        "TAXI",
			"DESCRIPTION": "Taxi Delivery",
		},
		{
			"NAME":        "Cargo",
			"CODE":        "CARGO",
			"DESCRIPTION": "Cargo Delivery",
		},
	},
})
if err != nil {
	return fmt.Errorf("sale.delivery.handler.add: %w", err)
}

var newID b24.ID
if err := json.Unmarshal(res.Result, &newID); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("идентификатор:", newID)

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

HTTP-статус: 200

{
   "result":14,
   "time":{
      "start":1713872092.378366,
      "finish":1713872092.691408,
      "duration":0.31304192543029785,
      "processing":0.015096187591552734,
      "date_start":"2024-04-23T14:34:52+03:00",
      "date_finish":"2024-04-23T14:34:52+03:00"
   }
}

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

Название
тип

Описание

result
sale_delivery_handler.ID

Идентификатор обработчика службы доставки

time
time

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

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

HTTP-статус: 400, 403

{
   "error":"ERROR_CHECK_FAILURE",
   "error_description":"Parameter CODE is not defined"
}

Название
тип

Описание

error
string

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

error_description
string

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

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

Код

Описание

Статус

ERROR_CHECK_FAILURE

Ошибка валидации входящих параметров (детали в описании ошибки)

400

ERROR_HANDLER_ADD

Ошибка при попытке добавления обработчика службы доставки

400

ERROR_HANDLER_ALREADY_EXIST

Обработчик службы доставки с указанным кодом CODE уже существует

400

ACCESS_DENIED

Недостаточно прав для добавления обработчика службы доставки

403

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

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

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

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