notify.bulk rest api

Массово отправляет уведомления пользователям приложения

Метод используется для массовой отправки уведомлений ВСЕМ пользователям приложения, разрешившим получение уведомлений от данного приложения.

Для отправки уведомления пользователь должен дать приложению привилегию notifications (см. users.hasAppPermissionrest). Максимальная длина уведомления - 140 символов. При превышении этого лимита текст уведомления будет усечен. В текст можно подставлять шаблоны с помощью конструкции [% %]. Пример: «Привет, [% user.FirstName %]». На данный момент поддерживаются поля user.FirstName, user.Nick. Ограничение на количество вызовов: не более 1 вызова в день. Пока очередь обрабатывает текущий запрос, любые другие попытки вызывать функцию будут возвращать bulk_id=null.

Функция может быть вызвана только с сервера приложения и работает только по защищенной схеме «Сервер - Сервер».

Параметры

Имя Тип Описание
textstringтекст уведомления в формате plaintext; текст может содержать шаблоны для подстановки данных пользователей; обязательный параметр
uidsstringсписок идентификаторов пользователей, разделенных запятыми, которым будет отправлено уведомление; максимум 10 пользователей; служит для тестовых отправок; отправка осуществляется только тестировщикам приложения . Если параметр не указан, то отправка производится всем пользователям приложения, разрешившим получение уведомлений

Результат

bulk_id - идентификатор внутренней очереди
to_send - массив uids, которым будет послано сообщение. Имеет смысл при заданном uids, иначе пустой список
not_send - массив uids, которым не сможем послать ввиду ограничений. Имеет смысл при заданном uids, иначе пустой список

Формат ответа для json-выдачи (результат для xml аналогичен):

  1. { "to_send": [], "no_send": [], "bulk_id": "206" }

Коды ошибок

КодОписание
1Unknown error: Please resubmit the request.
2Unknown method called.
3Service Unavailable. Please try again later.
4Method is deprecated.
100One of the parameters specified is missing or invalid.
102User authorization failed: the session key or uid is incorrect.
103Application lookup failed: the application id is not correct.
104Incorrect signature.
105Application is not installed for this user.
200Permission error: the application does not have permission to perform this action.

Пример вызова

http://www.appsmail.ru/platform/api?method=notify.bulk&app_id=723582&
text=hello,[% user.FirstName %]&secure=1&
sig=7bb81c44f5954b899038c663b8bf926e

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

  1. { "to_send": [], "no_send": [], "bulk_id": "206" }

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

  1. <response_notify_bulk>
  2. <bulk_id>206</bulk_id>
  3. </response_notify_bulk>

Текст нотификации будет «hello, Петя».

См. также

Использование REST API

Функции REST API