pull.application.push.add

Scope: pull Права на выполнение: администратор

Описание

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

Параметры

Параметр	Пример	Обязательный	Описание
USER_ID	1 или [1,2,3]	Да	Идентификаторы пользователей получателей push-уведомлений.
TEXT	'Hello, world!'	Нет	Произвольный текст.
AVATAR	'https://files.shelenkov.com/images/avatar-ivanov.jpg'	Нет	Ссылка на изображение.

Примеры

JavaScript

BX24.callMethod('pull.application.push.add', {
	'USER_ID': [1,2,3],
	'TEXT': 'Hello, world!',
	'AVATAR': 'https://files.shelenkov.com/images/avatar-ivanov.jpg',
}, function(result){
	if(result.error())
	{
		console.error(result.error().ex);
	}
	else
	{
		console.log(result.data());
	}
});

PHP

$result = restCommand('pull.application.push.add', [
	'USER_ID': [1,2,3],
	'TEXT': 'Hello, world!',
	'AVATAR': 'https://files.shelenkov.com/images/avatar-ivanov.jpg',
], $_REQUEST["auth"]);

Пример ответа

{
	"result": true
}

Пример ответа при возникновения ошибки

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

Ключи:

error - код возникшей ошибки
error_description - краткое описание возникшей ошибки

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

Код	Описание
TEXT_ERROR	Не передан текст сообщения.
EMPTY_APP_NAME	Ошибка возникает если у вашего приложения не задано название.
ACCESS_ERROR	Метод может использовать только пользователь с правами администратора.
WRONG_AUTH_TYPE	Метод можно использовать только в рамках OAuth 2.0.

Смотрите также

Интерактивность в приложениях