notifications.send rest api

Отправляет уведомления пользователям.Отправляет уведомления пользователям.

picture-for-api

Для отправки уведомления пользователь должен дать приложению привилегию notifications (см. users.hasAppPermissionrest). Пользователь не может получать более одного уведомления от приложения за 3 дня, если это не автор приложения или тестер, которому выдано соответствующее разрешение. Максимальная длина уведомления - 140 символов. При превышении этого лимита текст уведомления будет усечен.

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

Параметры

Имя Тип Описание
uidsstringсписок идентификаторов пользователей, разделенных запятыми, которым будет отправлено уведомление; максимум 200 пользователей; обязательный параметр
textstringтекст уведомления в формате plaintext; обязательный параметр

Результат

Возвращаемым значением является список идентификаторов пользователей, которым уведомление было отправлено успешно. Если пользователь не дал привилегию, либо для него превышен лимит отправки уведомлений, его идентификатора в возвращаемом списке не будет. Важно! После того, как пользователю было отправлено уведомление, и до момента пока пользователь не посетит приложение (неважно через notification или другой источник), он не сможет получать новые уведомления (т.е. в этом случае его идентификатора в возвращаемом списке также не будет).

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

  1. [ "15410773191172635989", ... ]

Коды ошибок

КодОписание
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=notifications.send&
app_id=422248&sig=f0def7f721a3c45f70617b78d8d9fba0&text=hello&
uids=11798822023276760714,14233118119668501085&secure=1

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

  1. ["15410773191172635989", "13933776335523073697"]

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

  1. <response_notifications_send>
  2.     <users>15410773191172635989</users>
  3.     <users>13933776335523073697</users>
  4. </response_notifications_send>

См. также

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

Функции REST API