Создать оповещения по транспортной заявке sale.delivery.request.sendmessage

Scope: sale, delivery

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

Метод создает оповещения по транспортной заявке.

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

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

Название
тип

Описание

DELIVERY_ID*
sale_delivery_service.ID

Идентификатор службы доставки, к которой относится транспортная заявка.

Получить идентификаторы sale_delivery_service.ID служб доставки можно с помощью метода sale.delivery.getlist

REQUEST_ID*
string

Идентификатор транспортной заявки.

Идентификатор назначается внешней системой в ответе вебхука на создание заказа на доставку (подробнее в описании вебхука Создание заказа на доставку)

ADDRESSEE*
string

Адресат сообщения.

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

  • MANAGER — менеджер
  • RECIPIENT — получатель груза

MESSAGE*
object

Сообщение (подробное описание приведено ниже)

Параметр MESSAGE

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

Название
тип

Описание

SUBJECT*
string

Заголовок сообщения.

Обязательно нужно заполнить хотя бы одно из следующих полей: SUBJECT, BODY

BODY*
string

Тело сообщения.

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

Обязательно нужно заполнить хотя бы одно из следующих полей: SUBJECT, BODY

STATUS
object

Статус сообщения (подробное описание приведено ниже)

MONEY_VALUES
object

Объект в формате ключ => значение.

Используется для замены денежных значений в теле сообщения (смотрите пример ниже)

Параметр STATUS

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

Название
тип

Описание

MESSAGE*
string

Текстовое название статуса сообщения

SEMANTIC*
string

Значение семантики статуса.

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

  • success — успех
  • process — в процессе
  • error — ошибка

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"DELIVERY_ID":225,"REQUEST_ID":"4757aca4931a4f029f49c0db4374d13d","ADDRESSEE":"MANAGER","MESSAGE":{"SUBJECT":"Your order is on its way","BODY":"Estimated delivery price: #MONEY#","MONEY_VALUES":{"#MONEY#":351.2},"STATUS":{"MESSAGE":"Success","SEMANTIC":"success"}}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.delivery.request.sendmessage
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"DELIVERY_ID":225,"REQUEST_ID":"4757aca4931a4f029f49c0db4374d13d","ADDRESSEE":"MANAGER","MESSAGE":{"SUBJECT":"Your order is on its way","BODY":"Estimated delivery price: #MONEY#","MONEY_VALUES":{"#MONEY#":351.2},"STATUS":{"MESSAGE":"Success","SEMANTIC":"success"}},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sale.delivery.request.sendmessage
        
try
        {
        	const response = await $b24.callMethod(
        		'sale.delivery.request.sendmessage', {
        			DELIVERY_ID: 225,
        			REQUEST_ID: "4757aca4931a4f029f49c0db4374d13d",
        			ADDRESSEE: "MANAGER",
        			MESSAGE: {
        				SUBJECT: "Your order is on its way",
        				BODY: "Estimated delivery price: #MONEY#",
        				MONEY_VALUES: {
        					"#MONEY#": 351.2,
        				},
        				STATUS: {
        					MESSAGE: "Success",
        					SEMANTIC: "success",
        				},
        			},
        		}
        	);
        	
        	const result = response.getData().result;
        	if (result.error()) {
        		console.error(result.error());
        	} else {
        		console.info(result);
        	}
        }
        catch( error )
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'sale.delivery.request.sendmessage',
                    [
                        'DELIVERY_ID' => 225,
                        'REQUEST_ID' => "4757aca4931a4f029f49c0db4374d13d",
                        'ADDRESSEE' => "MANAGER",
                        'MESSAGE' => [
                            'SUBJECT' => "Your order is on its way",
                            'BODY' => "Estimated delivery price: #MONEY#",
                            'MONEY_VALUES' => [
                                "#MONEY#" => 351.2,
                            ],
                            'STATUS' => [
                                'MESSAGE' => "Success",
                                'SEMANTIC' => "success",
                            ],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error sending delivery message: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'sale.delivery.request.sendmessage', {
                DELIVERY_ID: 225,
                REQUEST_ID: "4757aca4931a4f029f49c0db4374d13d",
                ADDRESSEE: "MANAGER",
                MESSAGE: {
                    SUBJECT: "Your order is on its way",
                    BODY: "Estimated delivery price: #MONEY#",
                    MONEY_VALUES: {
                        "#MONEY#": 351.2,
                    },
                    STATUS: {
                        MESSAGE: "Success",
                        SEMANTIC: "success",
                    },
                },
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'sale.delivery.request.sendmessage',
            [
                'DELIVERY_ID' => 225,
                'REQUEST_ID' => "4757aca4931a4f029f49c0db4374d13d",
                'ADDRESSEE' => "MANAGER",
                'MESSAGE' => [
                    'SUBJECT' => "Your order is on its way",
                    'BODY' => "Estimated delivery price: #MONEY#",
                    'MONEY_VALUES' => [
                        "#MONEY#" => 351.2,
                    ],
                    'STATUS' => [
                        'MESSAGE' => "Success",
                        'SEMANTIC' => "success",
                    ],
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result":true,
            "time":{
                "start":1714561617.200821,
                "finish":1714561617.526123,
                "duration":0.3253021240234375,
                "processing":0.1471860408782959,
                "date_start":"2024-05-01T14:06:57+03:00",
                "date_finish":"2024-05-01T14:06:57+03:00"
            }
        }

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

Название
тип

Описание

result
boolean

Результат отправки сообщения по транспортной заявке

time
time

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

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

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

{
            "error":"DELIVERY_NOT_FOUND",
            "error_description":"Delivery service has not been found"
        }

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

Статус

DELIVERY_ID_NOT_SPECIFIED

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

400

DELIVERY_NOT_FOUND

Служба доставки не найдена

400

REQUEST_ID_NOT_SPECIFIED

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

400

REQUEST_NOT_FOUND

Транспортная заявка не найдена

400

ADDRESSEE_IS_NOT_SPECIFIED

Не указан получатель сообщения

400

ADDRESSEE_UNEXPECTED_VALUE

Неизвестный получатель сообщения.

Допустимые значения:

  • MANAGER — менеджер
  • RECIPIENT — получатель груза

400

MESSAGE_NOT_SPECIFIED

Не указано сообщение.

Либо заголовок, либо тело сообщения должны быть указаны обязательно

400

MESSAGE_STATUS_NOT_SPECIFIED

Не указан статус сообщения

400

MESSAGE_STATUS_SEMANTIC_NOT_SPECIFIED

Не указана семантика статуса сообщения

400

UNEXPECTED_MESSAGE_STATUS_SEMANTIC

Неизвестная семантика статуса сообщения

400

REQUEST_SHIPMENT_NOT_FOUND

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

400

ACCESS_DENIED

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

403

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

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

Превышен лимит на интенсивность запросов

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

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

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

Предыдущая
Обновить транспортную заявку
Следующая
Удалить транспортную заявку