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

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

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

Scope: pull

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

Метод pull.application.push.add отправляет push-уведомление пользователям приложения. Уведомление приходит в мобильное приложение Битрикс24 от имени вашего приложения, поэтому у него должно быть заполнено название.

Push-уведомление не попадает в канал Push&Pull: его доставляет мобильное приложение, и получатель увидит уведомление, только если оно у него установлено. Чтобы обновить интерфейс открытого приложения, используйте pull.application.event.add — этот метод кладет событие в канал, откуда его читает клиент.

Метод работает только в контексте приложения. Запрос выполняется с OAuth-токеном приложения и scope pull, а вебхук такой контекст не создает.

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

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

Название
тип

Описание

USER_ID
integer | string | integer[]

Идентификатор пользователя или массив идентификаторов пользователей, которым отправляется push-уведомление. Передавайте параметр всегда: проверки на стороне REST нет, и без USER_ID метод вернет успешный ответ, но уведомление не уйдет.

Строку метод разбирает как JSON, поэтому "577" и "[1, 2, 3]" тоже принимаются.

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

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

Количество получателей метод не ограничивает и отбрасывает повторяющиеся идентификаторы

TEXT*
string

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

Размер push-уведомления ограничен 4 КБ. Более длинный текст Битрикс24 обрезает.

Метод вернет ошибку, если TEXT не передан, пуст или равен 0

AVATAR
string

Абсолютный URL изображения для push-уведомления.

Изображение загружает мобильное приложение Битрикс24 при получении уведомления. Проверки доступности URL нет: если изображение не загрузится, уведомление придет без него, а метод вернет успешный ответ.

Битрикс24 разбирает значение как URL и пересобирает его заново, поэтому строка, которую не удалось разобрать, до устройства не дойдет

Примеры кода

Как использовать примеры в документации

Пример отправки 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"

// 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: 'pull.application.push.add',
    params: {
      USER_ID: [1, 2, 3],
      TEXT: 'Hello, world!',
      AVATAR: 'https://example.com/images/avatar.png',
    },
    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('Push accepted:', 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 sendApplicationPush() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'pull.application.push.add',
        params: {
          USER_ID: [1, 2, 3],
          TEXT: 'Hello, world!',
          AVATAR: 'https://example.com/images/avatar.png',
        },
        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('Push accepted:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', sendApplicationPush)
</script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.pull.application.push.add(
        [1, 2, 3],
        text="Hello, world!",
        avatar="https://example.com/images/avatar.png",
    ).response
    print(bitrix_response.result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {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

Признак того, что уведомление принято к отправке. Метод возвращает true независимо от того, дошло ли уведомление до устройства.

Другой полезной нагрузки в ответе нет: идентификатор уведомления метод не возвращает, и узнать из ответа статус доставки нельзя

time
time

Информация о времени выполнения запроса. Состав полей — Объект time

Почему уведомление не пришло

Если уведомление не пришло, проверьте условия доставки:

  • в USER_ID остался хотя бы один положительный идентификатор: нули и отрицательные значения метод отбрасывает
  • мобильное приложение Битрикс24 у получателя установлено и в нем выполнен вход
  • у приложения заполнено название для текущего языка, иначе метод вернул бы EMPTY_APP_NAME
  • push-уведомления включены в самом Битрикс24

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

HTTP-статус: 403

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

HTTP-статус: 400

{
    "error": "ACCESS_ERROR",
    "error_description": "You do not have access to send push notifications"
}

Название
тип

Описание

error
string

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

error_description
string

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

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

Статус

Код

Описание

Значение

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 не передан, пуст или равен 0

400

EMPTY_APP_NAME

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

У приложения не заполнено название. Название на языке по умолчанию ошибку не снимает — Битрикс24 проверяет только название для текущего языка

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

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

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

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

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

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

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

Предыдущая
Отправить событие в канал приложения
Следующая
Рекомендации по производительности