Отправить push-уведомление на мобильное устройство приложения pull.application.push.add
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
pullКто может выполнять метод: администратор
Метод pull.application.push.add отправляет push-уведомление на мобильное устройство в рамках приложения.
Метод работает только в контексте приложения.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
Идентификатор пользователя или массив идентификаторов пользователей, которым отправляется push-уведомление.
|
|
|
TEXT* |
Текст push-уведомления |
|
AVATAR |
URL изображения для push-уведомления |
Примеры кода
Как использовать примеры в документации
Пример отправки push-уведомления пользователям приложения, где:
USER_ID— идентификатор пользователя или массив идентификаторов пользователейTEXT— текст push-уведомленияAVATAR— URL изображения для push-уведомления
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"USER_ID": [1, 2, 3],
"TEXT": "Hello, world!",
"AVATAR": "https://example.com/images/avatar.png",
"auth": "**put_access_token_here**"
}' \
"https://**put.your-domain-here**/rest/pull.application.push.add.json"
try
{
const response = await $b24.callMethod(
'pull.application.push.add',
{
USER_ID: [1, 2, 3],
TEXT: 'Hello, world!',
AVATAR: 'https://example.com/images/avatar.png'
}
);
const result = response.getData().result;
console.info(result);
}
catch (error)
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'pull.application.push.add',
[
'USER_ID' => [1, 2, 3],
'TEXT' => 'Hello, world!',
'AVATAR' => 'https://example.com/images/avatar.png',
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error sending push notification: ' . $e->getMessage();
}
BX24.callMethod(
'pull.application.push.add',
{
USER_ID: [1, 2, 3],
TEXT: 'Hello, world!',
AVATAR: 'https://example.com/images/avatar.png'
},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.info(result.data());
}
}
);
$result = CRest::call(
'pull.application.push.add',
[
'USER_ID' => [1, 2, 3],
'TEXT' => 'Hello, world!',
'AVATAR' => 'https://example.com/images/avatar.png',
]
);
echo '<pre>';
print_r($result);
echo '</pre>';
Обработка ответа
HTTP-статус: 200
{
"result": true,
"time": {
"start": 1743495945,
"finish": 1743495945.285066,
"duration": 0.2850658893585205,
"processing": 0.008597135543823242,
"date_start": "2025-04-01T11:52:25+03:00",
"date_finish": "2025-04-01T11:52:25+03:00",
"operating_reset_at": 1743496545,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Признак успешного выполнения метода |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 403
{
"error": "WRONG_AUTH_TYPE",
"error_description": "Send push notifications available only for application authorization."
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
|
Send push notifications available only for application authorization. |
Вызов метода не из контекста авторизации приложения |
|
|
|
You do not have access to send push notifications |
Пользователь без прав администратора пытается отправить push-уведомление |
|
|
|
Text can't be empty |
Не передан |
|
|
|
For send push-notification application name can't be empty |
У приложения не заполнено название |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |