Массово отправляет уведомления пользователям приложения
Метод используется для массовой отправки уведомлений ВСЕМ пользователям приложения, разрешившим получение уведомлений от данного приложения.
Для отправки уведомления пользователь должен дать приложению привилегию notifications (см. users.hasAppPermissionrest). Максимальная длина уведомления - 140 символов. При превышении этого лимита текст уведомления будет усечен. В текст можно подставлять шаблоны с помощью конструкции [% %]. Пример: «Привет, [% user.FirstName %]». На данный момент поддерживаются поля user.FirstName, user.Nick. Ограничение на количество вызовов: не более 1 вызова в день. Пока очередь обрабатывает текущий запрос, любые другие попытки вызывать функцию будут возвращать bulk_id=null.
Функция может быть вызвана только с сервера приложения и работает только по защищенной схеме «Сервер - Сервер».
Имя | Тип | Описание |
---|---|---|
text | string | текст уведомления в формате plaintext; текст может содержать шаблоны для подстановки данных пользователей; обязательный параметр |
uids | string | список идентификаторов пользователей, разделенных запятыми, которым будет отправлено уведомление; максимум 10 пользователей; служит для тестовых отправок; отправка осуществляется только тестировщикам приложения . Если параметр не указан, то отправка производится всем пользователям приложения, разрешившим получение уведомлений |
bulk_id - идентификатор внутренней очереди
to_send - массив uids, которым будет послано сообщение. Имеет смысл при заданном uids, иначе пустой список
not_send - массив uids, которым не сможем послать ввиду ограничений. Имеет смысл при заданном uids, иначе пустой список
Формат ответа для json-выдачи (результат для xml аналогичен):
{ "to_send": [], "no_send": [], "bulk_id": "206" }
Код | Описание |
---|---|
1 | Unknown error: Please resubmit the request. |
2 | Unknown method called. |
3 | Service Unavailable. Please try again later. |
4 | Method is deprecated. |
100 | One of the parameters specified is missing or invalid. |
102 | User authorization failed: the session key or uid is incorrect. |
103 | Application lookup failed: the application id is not correct. |
104 | Incorrect signature. |
105 | Application is not installed for this user. |
200 | Permission 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
{ "to_send": [], "no_send": [], "bulk_id": "206" }
Пример ответа в формате XML
206
Текст нотификации будет «hello, Петя».