Create Notifications for Delivery Request sale.delivery.request.sendmessage
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
deliveryWho can execute the method: administrator
The method sale.delivery.request.sendmessage creates notifications for a delivery request.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
DELIVERY_ID* |
Identifier of the delivery service related to the delivery request. You can obtain the identifiers of |
|
REQUEST_ID* |
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* |
Recipient of the message. Possible values:
|
|
MESSAGE* |
Message (detailed description provided below) |
MESSAGE Parameter
Required parameters are marked with *
|
Name |
Description |
|
SUBJECT* |
Subject of the message. At least one of the following fields must be filled: |
|
BODY* |
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: |
|
STATUS |
Status of the message (detailed description provided below) |
|
MONEY_VALUES |
Object in the format Used to replace monetary values in the body of the message (see example below) |
STATUS Parameter
Required parameters are marked with *
|
Name |
Description |
|
MESSAGE* |
Text name of the message status |
|
SEMANTIC* |
Value of the status semantics. Possible values:
|
Code Examples
How to Use Examples in Documentation
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
// 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<boolean>({
method: 'sale.delivery.request.sendmessage',
params: {
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',
},
},
},
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('Message sent successfully:', 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 sendDeliveryRequestMessage() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'sale.delivery.request.sendmessage',
params: {
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',
},
},
},
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('Message sent successfully:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', sendDeliveryRequestMessage)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
message = {
"SUBJECT": "Your order is on its way",
"BODY": "Estimated delivery price: #MONEY#",
"MONEY_VALUES": {
"#MONEY#": 351.2,
},
"STATUS": {
"MESSAGE": "Success",
"SEMANTIC": "success",
},
}
try:
bitrix_response = client.sale.delivery.request.sendmessage(
delivery_id=225,
request_id='4757aca4931a4f029f49c0db4374d13d',
addressee='MANAGER',
message=message,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Bitrix API error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected 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>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "sale.delivery.request.sendmessage", b24.Params{
"DELIVERY_ID": 225,
"REQUEST_ID": "4757aca4931a4f029f49c0db4374d13d",
"ADDRESSEE": "MANAGER",
"MESSAGE": b24.Params{
"SUBJECT": "Your order is on its way",
"BODY": "Estimated delivery price: #MONEY#",
"MONEY_VALUES": b24.Params{
"#MONEY#": 351.2,
},
"STATUS": b24.Params{
"MESSAGE": "Success",
"SEMANTIC": "success",
},
},
})
if err != nil {
return fmt.Errorf("sale.delivery.request.sendmessage: %w", err)
}
var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println("done:", ok)
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 |
Description |
|
result |
Result of sending the message for the delivery request |
|
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 |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
Status |
|
|
Delivery service identifier not specified |
|
|
|
Delivery service not found |
|
|
|
Delivery request identifier not specified |
|
|
|
Delivery request not found |
|
|
|
Message recipient not specified |
|
|
|
Unknown message recipient. Allowed values:
|
|
|
|
Message not specified. Either the subject or the body of the message must be specified |
|
|
|
Message status not specified |
|
|
|
Message status semantics not specified |
|
|
|
Unknown message status semantics |
|
|
|
Shipments linked to the specified delivery request not found |
|
|
|
Insufficient permissions to create a notification |
|
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |