Warning: Undefined property: stdClass::$auto_currency_detection in /home/pushhub/public_html/app/core/App.php on line 117 Персональные уведомления  – документация по API - PushHub

Персональные уведомления

Извлечь все

GET https://pushhub.ru/api/personal-notifications/
curl --request GET \
--url 'https://pushhub.ru/api/personal-notifications/' \
--header 'Authorization: Bearer {api_key}' \
Параметры Подробности Описание
page Необязательный Целое число Номер страницы, с которой вы хотите получить результаты. По умолчанию используется значение <код>1.
results_per_page Необязательный Целое число Сколько результатов вы хотите получить на странице. Допустимые значения: 10 , 25 , 50 , 100 , 250 , 500 , 1000. По умолчанию используется значение 25. 
{
    "data": [
        {
            "id": 1,
            "user_id": 1,
            "website_id": 1,
            "subscriber_id": 1,
            "name": "Example",
            "title": "Sample message",
            "description": "This is coming from the API.",
            "url": "https://example.com",
            "image_url": null,
            "settings": {
                "is_scheduled": 0,
                "ttl": 2419200,
                "urgency": "normal",
                "is_silent": 0,
                "is_auto_hide": 0,
                "button_title_1": "",
                "button_url_1": "",
                "button_title_2": "",
                "button_url_2": ""
            },
            "is_sent": 1,
            "is_displayed": 1,
            "is_clicked": 0,
            "is_closed": 0,
            "status": "sent",
            "scheduled_datetime": "2024-08-02 17:00:43",
            "sent_datetime": "2024-08-02 17:00:43",
            "last_datetime": null,
            "datetime": "2026-03-04 23:30:30",
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://pushhub.ru/api/personal-notifications?page=1",
        "last": "https://pushhub.ru/api/personal-notifications?page=1",
        "next": null,
        "prev": null,
        "self": "https://pushhub.ru/api/personal-notifications?page=1"
    }
}

Извлечь один

GET https://pushhub.ru/api/personal-notifications/{personal_notification_id}
curl --request GET \
--url 'https://pushhub.ru/api/personal-notifications/{personal_notification_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "id": 1,
        "user_id": 1,
        "website_id": 1,
        "subscriber_id": 1,
        "name": "Example",
        "title": "Sample message",
        "description": "This is coming from the API.",
        "url": "https://example.com",
        "image_url": null,
        "settings": {
            "is_scheduled": 0,
            "ttl": 2419200,
            "urgency": "normal",
            "is_silent": 0,
            "is_auto_hide": 0,
            "button_title_1": "",
            "button_url_1": "",
            "button_title_2": "",
            "button_url_2": ""
        },
        "is_sent": 1,
        "is_displayed": 1,
        "is_clicked": 0,
        "is_closed": 0,
        "status": "sent",
        "scheduled_datetime": "2024-08-02 17:00:43",
        "sent_datetime": "2024-08-02 17:00:43",
        "last_datetime": null,
        "datetime": "2026-03-04 23:30:30",
    }
}

Создать

POST https://pushhub.ru/api/personal-notifications
Параметры Подробности Описание
website_id Требуемый Целое число -
subscriber_id Требуемый Целое число -
name Требуемый Строка -
title Требуемый Строка -
description Требуемый Строка -
url Необязательный Строка -
image Необязательный Файл -
button_title_1 Необязательный Строка -
button_url_1 Необязательный Строка -
button_title_2 Необязательный Строка -
button_url_2 Необязательный Строка -
is_scheduled Необязательный Логический -
scheduled_datetime Необязательный Строка -
is_silent Необязательный Логический -
is_auto_hide Необязательный Логический -
ttl Необязательный Строка Допустимые значения: 0 , 900 , 1800 , 3600 , 10800 , 21600 , 43200 , 86400 , 259200 , 432000 , 604800 , 1209600 , 2419200
utm_source Необязательный Строка -
utm_medium Необязательный Строка -
utm_campaign Необязательный Строка -
save Необязательный Логический Сохранить черновик
send Необязательный Логический Отправить персональное уведомление
curl --request POST \
--url 'https://pushhub.ru/api/personal-notifications' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example name' \
--form 'website_id=1' \
--form 'subscriber_id=1' \
--form 'title=Example title' \
--form 'description=Example description' \
{
    "data": {
        "id": 1
    }
}

Обновить

POST https://pushhub.ru/api/personal-notifications/{personal_notification_id}
Параметры Подробности Описание
website_id Необязательный Целое число -
subscriber_id Необязательный Целое число -
name Необязательный Строка -
title Необязательный Строка -
description Необязательный Строка -
url Необязательный Строка -
image Необязательный Файл -
button_title_1 Необязательный Строка -
button_url_1 Необязательный Строка -
button_title_2 Необязательный Строка -
button_url_2 Необязательный Строка -
is_scheduled Необязательный Логический -
scheduled_datetime Необязательный Строка -
is_silent Необязательный Логический -
is_auto_hide Необязательный Логический -
ttl Необязательный Строка Допустимые значения: 0 , 900 , 1800 , 3600 , 10800 , 21600 , 43200 , 86400 , 259200 , 432000 , 604800 , 1209600 , 2419200
utm_source Необязательный Строка -
utm_medium Необязательный Строка -
utm_campaign Необязательный Строка -
save Необязательный Логический Сохранить черновик
send Необязательный Логический Отправить персональное уведомление
curl --request POST \
--url 'https://pushhub.ru/api/personal-notifications/{personal_notification_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example name' \
--form 'website_id=1' \
--form 'subscriber_id=1' \
--form 'title=Example title' \
--form 'description=Example description' \
{
    "data": {
        "id": 1
    }
}

Удалить

DELETE https://pushhub.ru/api/personal-notifications/{personal_notification_id}
curl --request DELETE \
--url 'https://pushhub.ru/api/personal-notifications/{personal_notification_id}' \
--header 'Authorization: Bearer {api_key}' \