Трансляция пуш-сообщений

Попробуйте в Swagger

Трансляция пуш-сообщений (broadcast)

Массовая отправка пуш-сообщений.

Формат запроса

POST https://pub.multipushed.ru/v2/broadcast-publish

Тело запроса

{
  "ttl": <time_to_live>,
  "groupId": <group_id>,
  "payload": "My push",
  "geoLocationInfo": {
    "region": "Moscow"
  },
  "cascadeToSms": true,
  "sms": {
    "body": null
  },
  "apns": {
    "alert": {
      "title": null,
      "subtitle": null,
      "body": null,
      "launch-image": null,
      "title-loc-key": null,
      "title-loc-args": null,
      "subtitle-loc-key": null,
      "subtitle-loc-args": null,
      "loc-key": null,
      "loc-args": null
    },
    "badge": null,
    "sound": {
      "critical": null,
      "name": null,
      "volume": null
    },
    "thread-id": null,
    "category": null,
    "content-available": 1,
    "mutable-available": null,
    "target-content-id": null,
    "interruption-level": null,
    "relevance-score": null,
    "filter-criteria": null,
    "stale-date": null,
    "timestamp": null,
    "event": null,
    "dismissal-date": null,
    "attributes-type": null
  }
}

Параметры тела запроса

ttl	Время жизни сообщения в секундах (По умолчанию 24 часа)	Необязательное поле
payload	Тело сообщения (До клиента будет доставлено в том виде, в котором передано)	Обязательное поле
cascadeToSms	Включение каскада на СМС, по умолчанию true	Необязательное поле
sms.body	Настройка тела сообщения, используемого при отправке SMS, если не задано, будет использован Payload пуша	Необязательное поле
groupId	Идентификатор группы (Если поле не задано, то отправка будет производиться по всем устройствам приложения)	Необязательное поле
geoLocationInfo	Регион, для которого будет совершена отправка. Должен соответствовать ISO 3166 или ISO 3166 для российских регионов. (для отправки необходимо использовать Subdivision name (en))	Необязательное поле
apns	Настройки для отправки через APNs	Необязательное поле

Пример запроса

curl -v -X POST https://pub.multipushed.ru/v2/broadcast-publish
-H 'Content-Type: application/json' 
-H 'Authorization: Bearer <accessToken>' 
-d '{"payload": "My payload", "cascadeToSms": true, "sms": {"body": "Sms payload"}}'

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

{
    "success": true/false,
    "errCode": int/null,
    "message": string/null,
    "model": string/null
}

success	результат выполнения запроса
errCode	код ошибки, будет заполнено в случае ошибки
message	текстовое описание ошибки, будет заполнено в случае ошибки
model	ID рассылки (BroadcastTaskId)

Статус массовой отправки пуш-сообщений

Показывает какое количество пуш-сообщений из массовой отправки было доставлено\не доставлено

Формат запроса

POST https://api.pushed.ru/v2/info/broadcast-task

Тело запроса

{
  "broadcastTaskId": null
}'

Параметры тела запроса

broadcastTaskId

ID отправки, полученный в ответ на отправку через broadcast

Обязательное поле

Пример запроса

curl -v -X POST https://api.pushed.ru/v2/info/broadcast-task \
-H 'Content-Type: application/json' 
-H 'Authorization: Bearer <accessToken>' 
-d '{"broadcastTaskId": <Ваш ID>}'

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

{
    "model": "6810c0813a1eecf20db08cae",
    "success": true,
    "message": null,
    "errCode": null
}