Добавить события с app push
Описание
Добавить события с app push.
Дополнительный API-метод для создания событий.
URL-адрес
Метод: POST
https://example.com/api/v1.1/pushes/post_events
Параметры запроса
Параметр | Тип | Пример | Обязательный | Описание |
---|---|---|---|---|
token | string | "abcdefghijklmnqrstuvwxyz" | Да | API токен |
events | int | 1 - доставлен 2 - открыт 3 - доставлен и открыт | Да | События |
launch_id | int | 1 | Да (при передаче uid в специальном формате - необязательно) | Приходит вместе с push сообщением от Altcraft в Data payload. |
provider | string | "android-firebase" | Да (при передаче uid в специальном формате - необязательно) | Провайдер |
subscription_id | string | "subscriptionid" | Да (при передаче uid в специальном формате - необязательно) | Идентификатор подписки |
uid | string | "uid" | Да | Приходит вместе с push сообщением от Altcraft в Data payload. |
предупреждение
Если uid
имеет формат extra (e|<launch_id>|<legacy_uid>|<provider>), то параметры launch_id
, provider
, subscription_id
становятся необязательными, и в запросе необходимо передавать только token
, uid
и events
.
Пример запроса
- JSON
- XML
{
"token": "abcdefghijklmnqrstuvwxyz",
"events": 1,
"launch_id": "launch_id",
"provider": "android-firebase",
"subscription_id": "subscriptionid",
"uid": "uid"
}
<xml>
<token>abcdefghijklmnqrstuvwxyz</token>
<events>1</events>
<launch_id>launch_id</launch_id>
<provider>android-firebase</provider>
<subscription_id>subscriptionid</subscription_id>
<uid>uid</uid>
</xml>
Пример запроса с uid в специальном формате
- JSON
- XML
{
"token": "abcdefghijklmnqrstuvwxyz",
"events": 1,
"uid": "e|2_4S_4HFn8RDhhmA|w4HFn8RPDFUi_2_4S_S_3___6.2NvyN8Hb67wmzJshM_6BuFTt|ios-apns"
}
<xml>
<token>abcdefghijklmnqrstuvwxyz</token>
<events>1</events>
<uid>e|2_4S_4HFn8RDhhmA|w4HFn8RPDFUi_2_4S_S_3___6.2NvyN8Hb67wmzJshM_6BuFTt|ios-apns</uid>
</xml>
Пример ответа
- JSON
- XML
{
"error": 0,
"error_text": "Successful operation"
}
<xml>
<error>0</error>
<error_text>Successful operation</error_text>
</xml>
Возвращаемые параметры
Параметр | Тип | Описание |
---|---|---|
error | int | Код ошибки |
error_text | string | Текст ошибки |