活动

检索所有

GET https://pusher.ospyo.com/api/campaigns/
curl --request GET \
--url 'https://pusher.ospyo.com/api/campaigns/' \
--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, "name": "API Sample", "title": "Sample message", "description": "This is coming from the API.", "url": "https://example.com", "image_url": null, "segment": "all", "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": "" }, "subscribers_ids": [ 1,2,3,4,5 ], "sent_subscribers_ids": [], "total_sent_push_notifications": 0, "total_push_notifications": 1, "total_displayed_push_notifications": 0, "total_clicked_push_notifications": 0, "total_closed_push_notifications": 0, "status": "draft", "scheduled_datetime": "2024-08-09 00:16:22", "last_sent_datetime": null, "last_datetime": null, "datetime": "2025-11-07 11:01:19" } ], "meta": { "page": 1, "results_per_page": 25, "total": 1, "total_pages": 1 }, "links": { "first": "https://pusher.ospyo.com/api/campaigns?&page=1", "last": "https://pusher.ospyo.com/api/campaigns?&page=1", "next": null, "prev": null, "self": "https://pusher.ospyo.com/api/campaigns?&page=1" } }

检索一个

GET https://pusher.ospyo.com/api/campaigns/{campaign_id}
curl --request GET \
--url 'https://pusher.ospyo.com/api/campaigns/{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, "segment": "all", "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": "" }, "subscribers_ids": [ 1,2,3,4,5 ], "sent_subscribers_ids": [], "total_sent_push_notifications": 0, "total_push_notifications": 1, "total_displayed_push_notifications": 0, "total_clicked_push_notifications": 0, "total_closed_push_notifications": 0, "status": "draft", "scheduled_datetime": "2024-08-09 00:16:22", "last_sent_datetime": null, "last_datetime": null, "datetime": "2025-11-07 11:01:19" } }

创建

POST https://pusher.ospyo.com/api/campaigns
参数 详情 描述
website_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
segment 可选 字符串 允许的值：all , custom , filter , INT segment_id
subscribers_ids 可选 字符串 可用时：segment = custom
filters_custom_parameter_key[index] 可选 字符串 可用时：segment = filter
filters_custom_parameter_value[index] 可选 字符串 可用时：segment = filter
filters_custom_parameter_value[index] 可选 字符串 可用时：segment = filter
filters_subscribed_on_url 可选 字符串 可用时：segment = filter
filters_cities 可选 字符串 可用时：segment = filter
filters_countries[] 可选 字符串 可用时：segment = filter
filters_continents[] 可选 字符串 可用时：segment = filter
filters_device_type[] 可选 字符串 可用时：segment = filter
filters_languages[] 可选 字符串 可用时：segment = filter
filters_operating_systems[] 可选 字符串 可用时：segment = filter
filters_browsers[] 可选 字符串 可用时：segment = filter
utm_source 可选 字符串 -
utm_medium 可选 字符串 -
utm_campaign 可选 字符串 -
save 可选 布尔值 保存草稿
send 可选 布尔值 发送活动
curl --request POST \
--url 'https://pusher.ospyo.com/api/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' \
{ "data": { "id": 1 } }

更新

POST https://pusher.ospyo.com/api/campaigns/{campaign_id}
参数 详情 描述
website_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
segment 可选 字符串 允许的值：all , custom , filter , INT segment_id
subscribers_ids 可选 字符串 可用时：segment = custom
filters_custom_parameter_key[index] 可选 字符串 可用时：segment = filter
filters_custom_parameter_value[index] 可选 字符串 可用时：segment = filter
filters_custom_parameter_value[index] 可选 字符串 可用时：segment = filter
filters_subscribed_on_url 可选 字符串 可用时：segment = filter
filters_cities 可选 字符串 可用时：segment = filter
filters_countries[] 可选 字符串 可用时：segment = filter
filters_continents[] 可选 字符串 可用时：segment = filter
filters_device_type[] 可选 字符串 可用时：segment = filter
filters_languages[] 可选 字符串 可用时：segment = filter
filters_operating_systems[] 可选 字符串 可用时：segment = filter
filters_browsers[] 可选 字符串 可用时：segment = filter
utm_source 可选 字符串 -
utm_medium 可选 字符串 -
utm_campaign 可选 字符串 -
save 可选 布尔值 保存草稿
send 可选 布尔值 发送活动
curl --request POST \
--url 'https://pusher.ospyo.com/api/campaigns/{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' \
{ "data": { "id": 1 } }

删除

DELETE https://pusher.ospyo.com/api/campaigns/{campaign_id}
curl --request DELETE \
--url 'https://pusher.ospyo.com/api/campaigns/{campaign_id}' \
--header 'Authorization: Bearer {api_key}' \