Recurring campaigns

すべて取得する

GET https://pushye.com/api/recurring-campaigns/
curl --request GET \
--url 'https://pushye.com/api/recurring-campaigns/' \
--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, "name": "API Sample", "title": "Sample message", "description": "This is coming from the API.", "url": "https://example.com", "image_url": null, "settings": { "ttl": 2419200, "urgency": "normal", "is_silent": 0, "is_auto_hide": 0, "button_title_1": "", "button_url_1": "", "button_title_2": "", "button_url_2": "", "frequency": "daily, "time": 10:25, }, "segment": "all", "is_enabled": true, "total_sent_push_notifications": 0, "total_displayed_push_notifications": 0, "total_clicked_push_notifications": 0, "total_closed_push_notifications": 0, "last_sent_datetime": null, "last_datetime": null, "datetime": "2025-02-05 15:45:27" } ], "meta": { "page": 1, "results_per_page": 25, "total": 1, "total_pages": 1 }, "links": { "first": "https://pushye.com/api/recurring-campaigns?&page=1", "last": "https://pushye.com/api/recurring-campaigns?&page=1", "next": null, "prev": null, "self": "https://pushye.com/api/recurring-campaigns?&page=1" } }

1つ取得する

GET https://pushye.com/api/recurring-campaigns/{recurring_campaign_id}
curl --request GET \
--url 'https://pushye.com/api/recurring-campaigns/{recurring_campaign_id}' \
--header 'Authorization: Bearer {api_key}' \
{ "data": { "id": 1, "user_id": 1, "website_id": 1, "name": "API Sample", "title": "Sample message", "description": "This is coming from the API.", "url": "https://example.com", "image_url": null, "settings": { "ttl": 2419200, "urgency": "normal", "is_silent": 0, "is_auto_hide": 0, "button_title_1": "", "button_url_1": "", "button_title_2": "", "button_url_2": "", "frequency": "daily, "time": 10:25, }, "segment": "all", "is_enabled": true, "total_sent_push_notifications": 0, "total_displayed_push_notifications": 0, "total_clicked_push_notifications": 0, "total_closed_push_notifications": 0, "last_sent_datetime": null, "last_datetime": null, "datetime": "2025-02-05 15:45:27" } }

作成する

POST https://pushye.com/api/recurring-campaigns
パラメータ 詳細 説明
website_id 必須 整数 -
name 必須 文字列 -
title 必須 文字列 -
description 必須 文字列 -
url オプション 文字列 -
image オプション ファイル -
button_title_1 オプション 文字列 -
button_url_1 オプション 文字列 -
button_title_2 オプション 文字列 -
button_url_2 オプション 文字列 -
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 オプション 文字列 -
frequency オプション 文字列 許可された値: daily , weekly , monthly
week_days オプション 文字列 許可された値: 1 , 2 , 3 , 4 , 5 , 6 , 7 利用可能な時期: frequency = weekly
month_days オプション 文字列 許可された値: 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , 10 , 11 , 12 , 13 , 14 , 15 , 16 , 17 , 18 , 19 , 20 , 21 , 22 , 23 , 24 , 25 , 26 , 27 , 28 , 29 , 30 , 31 利用可能な時期: frequency = monthly
time オプション 文字列 HH:II
is_enabled オプション ブール値 -
curl --request POST \
--url 'https://pushye.com/api/recurring-campaigns' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example name' \
--form 'website_id=1' \
--form 'title=Example title' \
--form 'description=Example description' \
--form 'segment=all' \
--form 'frequency=daily' \
--form 'time=12:15' \
{ "data": { "id": 1 } }

更新

POST https://pushye.com/api/recurring-campaigns/{recurring_campaign_id}
パラメータ 詳細 説明
website_id オプション 整数 -
name オプション 文字列 -
title オプション 文字列 -
description オプション 文字列 -
url オプション 文字列 -
image オプション ファイル -
button_title_1 オプション 文字列 -
button_url_1 オプション 文字列 -
button_title_2 オプション 文字列 -
button_url_2 オプション 文字列 -
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 オプション 文字列 -
frequency オプション 文字列 許可された値: daily , weekly , monthly
week_days オプション 文字列 許可された値: 1 , 2 , 3 , 4 , 5 , 6 , 7 利用可能な時期: frequency = weekly
month_days オプション 文字列 許可された値: 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , 10 , 11 , 12 , 13 , 14 , 15 , 16 , 17 , 18 , 19 , 20 , 21 , 22 , 23 , 24 , 25 , 26 , 27 , 28 , 29 , 30 , 31 利用可能な時期: frequency = monthly
time オプション 文字列 HH:II
is_enabled オプション ブール値 -
curl --request POST \
--url 'https://pushye.com/api/recurring-campaigns/{recurring_campaign_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example name' \
--form 'website_id=1' \
--form 'title=Example title' \
--form 'description=Example description' \
--form 'segment=all' \
{ "data": { "id": 1 } }

削除

DELETE https://pushye.com/api/recurring-campaigns/{recurring_campaign_id}
curl --request DELETE \
--url 'https://pushye.com/api/recurring-campaigns/{recurring_campaign_id}' \
--header 'Authorization: Bearer {api_key}' \