個人通知

すべて取得する

GET https://pushye.com/api/personal-notifications/
curl --request GET \
--url 'https://pushye.com/api/personal-notifications/' \
--header 'Authorization: Bearer {api_key}' \
パラメータ 詳細 説明
page オプション 整数 結果を取得したいページ番号。デフォルトは1です。
results_per_page オプション 整数 1ページあたりの結果数はどのくらいにしますか。許可されている値は：10 , 25 , 50 , 100 , 250 , 500 , 1000。デフォルトは25です。
{ "data": [ { "id": 1, "user_id": 1, "website_id": 1, "subscriber_id": 1, "name": "API Sample", "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": "2025-02-05 15:50:40" } ], "meta": { "page": 1, "results_per_page": 25, "total": 1, "total_pages": 1 }, "links": { "first": "https://pushye.com/api/personal-notifications?&page=1", "last": "https://pushye.com/api/personal-notifications?&page=1", "next": null, "prev": null, "self": "https://pushye.com/api/personal-notifications?&page=1" } }

1つ取得する

GET https://pushye.com/api/personal-notifications/{personal_notification_id}
curl --request GET \
--url 'https://pushye.com/api/personal-notifications/{personal_notification_id}' \
--header 'Authorization: Bearer {api_key}' \
{ "data": { "id": 1, "user_id": 1, "website_id": 1, "subscriber_id": 1, "name": "API Sample", "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": "2025-02-05 15:50:40" } }

作成する

POST https://pushye.com/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://pushye.com/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://pushye.com/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://pushye.com/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://pushye.com/api/personal-notifications/{personal_notification_id}
curl --request DELETE \
--url 'https://pushye.com/api/personal-notifications/{personal_notification_id}' \
--header 'Authorization: Bearer {api_key}' \