Create Notifications for Delivery Request sale.delivery.request.sendmessage

Scope: sale, delivery

Who can execute the method: administrator

This method creates notifications for a delivery request.

Method Parameters

Required parameters are marked with *

Name `type`	Description
DELIVERY_ID* `sale_delivery_service.ID`	Identifier of the delivery service related to the delivery request. You can obtain the identifiers of `sale_delivery_service.ID` for delivery services using the sale.delivery.getlist method.
REQUEST_ID* `string`	Identifier of the delivery request. The identifier is assigned by the external system in response to the webhook for creating a delivery order (more details in the webhook description Creating a Delivery Order).
ADDRESSEE* `string`	Recipient of the message. Possible values: `MANAGER` — manager `RECIPIENT` — recipient of the cargo
MESSAGE* `object`	Message (detailed description provided below)

MESSAGE Parameter

Required parameters are marked with *

Name `type`	Description
SUBJECT* `string`	Subject of the message. At least one of the following fields must be filled: `SUBJECT`, `BODY`
BODY* `string`	Body of the message. The body of the message may use macros to replace time and monetary values. At least one of the following fields must be filled: `SUBJECT`, `BODY`
STATUS `object`	Status of the message (detailed description provided below)
MONEY_VALUES `object`	Object in the format `key => value`. Used to replace monetary values in the body of the message (see example below)

STATUS Parameter

Required parameters are marked with *

Name
type

Description

MESSAGE*
string

Text name of the message status

SEMANTIC*
string

Value of the status semantics.

Possible values:

success — success
process — in process
error — error

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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>';

Response Handling

HTTP status: 200

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

Returned Data

Name `type`	Description
result `boolean`	Result of sending the message for the delivery request
time `time`	Information about the execution time of the request

Error Handling

HTTP status: 400, 403

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

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code	Description	Status
`DELIVERY_ID_NOT_SPECIFIED`	Delivery service identifier not specified	`400`
`DELIVERY_NOT_FOUND`	Delivery service not found	`400`
`REQUEST_ID_NOT_SPECIFIED`	Delivery request identifier not specified	`400`
`REQUEST_NOT_FOUND`	Delivery request not found	`400`
`ADDRESSEE_IS_NOT_SPECIFIED`	Message recipient not specified	`400`
`ADDRESSEE_UNEXPECTED_VALUE`	Unknown message recipient. Allowed values: `MANAGER` — manager `RECIPIENT` — recipient of the cargo	`400`
`MESSAGE_NOT_SPECIFIED`	Message not specified. Either the subject or the body of the message must be specified	`400`
`MESSAGE_STATUS_NOT_SPECIFIED`	Message status not specified	`400`
`MESSAGE_STATUS_SEMANTIC_NOT_SPECIFIED`	Message status semantics not specified	`400`
`UNEXPECTED_MESSAGE_STATUS_SEMANTIC`	Unknown message status semantics	`400`
`REQUEST_SHIPMENT_NOT_FOUND`	Shipments linked to the specified delivery request not found	`400`
`ACCESS_DENIED`	Insufficient rights to add the delivery service	`403`

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Update Transportation Request

Delete Transportation Request

Create Notifications for Delivery Request sale.delivery.request.sendmessage

Method ParametersMethod Parameters

MESSAGE ParameterMESSAGE Parameter

STATUS ParameterSTATUS Parameter

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning

Method Parameters

MESSAGE Parameter

STATUS Parameter

Code Examples

Response Handling

Returned Data

Error Handling

Possible Error Codes

Statuses and System Error Codes

Continue Learning