метод REST scope: delivery

sale.delivery.request.sendmessage

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

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

Описание

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

Параметры

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

Ответ

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

{
    "error":"DELIVERY_NOT_FOUND",
    "error_description":"Delivery service has not been found"
}
Код Описание Значение
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

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.