Отправить push-уведомление на мобильное устройство приложения pull.application.push.add

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: pull

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

Метод pull.application.push.add отправляет push-уведомление на мобильное устройство в рамках приложения.

Метод работает только в контексте приложения.

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

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

Название
тип

Описание

USER_ID*
integer | integer[]

Идентификатор пользователя или массив идентификаторов пользователей, которым отправляется push-уведомление.

USER_ID можно получить:

  • методом user.get
  • методом user.current для текущего пользователя

TEXT*
string

Текст push-уведомления

AVATAR
string

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
boolean

Признак успешного выполнения метода

time
time

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

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

HTTP-статус: 403

{
    "error": "WRONG_AUTH_TYPE",
    "error_description": "Send push notifications available only for application authorization."
}

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Статус

Код

Описание

Значение

403

WRONG_AUTH_TYPE

Send push notifications available only for application authorization.

Вызов метода не из контекста авторизации приложения

400

ACCESS_ERROR

You do not have access to send push notifications

Пользователь без прав администратора пытается отправить push-уведомление

400

TEXT_ERROR

Text can't be empty

Не передан TEXT или передано пустое значение

400

EMPTY_APP_NAME

For send push-notification application name can't be empty

У приложения не заполнено название

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

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

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

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут

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

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

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