Web推送通知API

获取发送的网络推送活动列表

要获取已发送的web推送活动列表,请发送get请求到:

https://api.半岛客户端下载官网m.ekobsc.com/push/tasks

请求参数:

参数 类型 描述
限制 int 记录数 可选
抵消 int 偏移量(要显示的第一条记录) 可选
从* 字符串 开始日期 可选
* 字符串 结束日期 可选
website_id id 网站ID设置为一个活动 可选

*你必须使用这样的日期格式:YYYY-MM-DD HH: MM: SS

一次回复的最大条目数为100。

使用抵消参数来指示起始条目。

当使用其他参数时,以以下格式填写URL(示例显示如何从第二个条目开始检索10个条目):

https://api.半岛客户端下载官网m.ekobsc.com/push/tasks/?limit=10&offset=2

如果请求成功,您将收到一个响应:

[{" id ": 121,“标题”:“推”、“身体”:“文本”,“website_id”:53岁,“从”:“2015-11-17 14:44:47”、“到”:“2015-12-23 19:42:27”,“状态”:13}]

获得网站总数

要获取网站总数,发送get请求到:

https://api.半岛客户端下载官网m.ekobsc.com/push/websites/total

如果请求成功,您将收到一个响应:

{"total": 2}

获取网站列表

要获取网站列表,发送get请求到:

https://api.半岛客户端下载官网m.ekobsc.com/push/websites/

请求参数:

参数 类型 描述
限制 int 记录数 可选
抵消 int 偏移量(要显示的第一条记录) 可选

当使用其他参数时,按以下格式填写URL:

https://api.半岛客户端下载官网m.ekobsc.com/push/websites/?limit=10&offset=2

如果请求成功,您将收到一个响应:

[{" id ": 53岁“url”:“www.test-site.com”,“add_date”:“2015-11-23 14:42:37”,“状态”:1}]

获取一个网站的变量列表

要获取某个网站的变量列表,发送get请求到:

https://api.半岛客户端下载官网m.ekobsc.com/push/websites/ {id} /变量

请求参数:

参数 类型 描述
id int 网站ID 要求

如果请求成功,您将收到一个响应:

[{" id ": 97,“名字”:“uname”,“类型”:“字符串”}]

获取网站订阅者名单

要获取网站订阅者列表,发送get请求到:

https://api.半岛客户端下载官网m.ekobsc.com/push/websites/ {id} /订阅

请求参数:

参数 类型 描述
id int 网站ID 要求
限制 int 记录数 可选
抵消 int 偏移量(要显示的第一条记录) 可选
subscription_date_from 字符串 按添加订阅者的日期进行筛选(指定日期和时间,以及时间的持续时间),以格式设置YYYY-MM-DD 可选
subscription_date_to 字符串 按添加订阅者的日期进行筛选(指定日期和时间,以及时间的持续时间),以格式设置YYYY-MM-DD 可选

当使用其他参数时,按以下格式填写URL:

https://api.半岛客户端下载官网m.ekobsc.com/push/websites/ {id} /订阅/ ?限制= 10抵消= 2

如果请求成功,您将收到一个响应:

[{" id ": 311003743,“浏览器”:“火狐”、“朗”:“en”,“操作系统”:“Linux”,“country_code”:“UA”、“城市”:“Dnipro”、“变量”:[],“subscription_date”:“2018-08-13 14:27:11”,“状态”:1},{" id ": 311008277,“浏览器”:“歌剧”,“朗”:“en”,“操作系统”:“Linux”,“country_code”:“UA”、“城市”:“Dnipro”、“变量”:[],“subscription_date”:“2018-08-13 14:33:51”,“状态”:1}]

可能的推送用户状态:

状态码 地位的名字
0 停用
1 活跃的
6 没订阅

获得一些网站订阅者

要获得网站订阅者的总数,发送一个get请求到:

https://api.半岛客户端下载官网m.ekobsc.com/push/websites/ {id} /订阅/总

请求参数:

参数 类型 描述
id int 网站ID 要求

如果请求成功,您将收到一个响应:

{"total": 2}

获取有关网站的信息

要获取一个网站的信息,发送一个get请求到:

https://api.半岛客户端下载官网m.ekobsc.com/push/websites/info/ {id}

请求参数:

参数 类型 描述
id int 网站ID 要求

如果请求成功,您将收到一个响应:

{"id": 111111, "url": "yoursite.com", "status": "active", "icon": "https://login.s半岛客户端下载官网endpulse.com/img/my/push/push-default-icons/icon.png", "add_date": "2017-11-09 13:08:37", "total_subscribers": 1081, "unsubscribed": 30, "subscribers_today": 10, "active_subscribers": 1051}

为网站编写JS代码

要获取一个网站的JS代码,发送一个get请求到:

https://api.半岛客户端下载官网m.ekobsc.com/push/websites/ {id} /代码

请求参数:

参数 类型 描述
id int 网站ID 要求

如果请求成功,您将收到一个响应:

{"script_url": "//web.webpushs.com/js/push/00008bf5640047e81be53f4a2891dd36e9_1.js", "script_code": ""}

激活/停用订阅者

要激活或停用订阅者,发送POST请求到:

https://api.半岛客户端下载官网m.ekobsc.com/push/subscriptions/state

请求参数:

参数 类型 描述
id int 订阅者ID 要求
状态 int 订阅者状态触发器;1——激活,0——释放 要求

如果请求成功,您将收到一个响应:

{"result": true}

创建一个新的网络推送活动

要创建一个新的网络推送活动,发送一个POST请求到:

https://api.半岛客户端下载官网m.ekobsc.com/push/tasks

请注意,每个网站的限制是每15分钟一个广告活动。

使用Automation360用于触发活动的工具集。

请求参数:

参数 类型 描述
标题 字符串 标题 要求
website_id int 网站ID 要求
身体 字符串 Web推送通知内容 要求
ttl int 推送通知时间以秒为单位,最大- 86400秒(24小时) 要求
链接 字符串 导航链接;如果没有指定,将使用网站URL 可选
filter_lang 字符串 按语言筛选订阅者(例如, 可选
filter_browser 字符串 通过浏览器过滤订阅者;该参数可以接受多个以逗号分隔的值(例如-)Safari 可选
filter_region 字符串 区域过滤器,接受带有国家代码的JSON字符串,例如["UK"] 可选
filter_url 字符串 URL过滤器,接受这种格式的JSON字符串{“类型”:“包括”,“搜索”:“pu”}类型可以有三个值——”直接”、“包括”、“排除”。当type = '直接”- - -搜索是一个链接数组,在其他情况下-搜索将是用于搜索的常规字符串吗 可选
filter_subscription_date_from 字符串 使用“YYYY-MM-DD格式指定间隔的开始和结束日期,以便按添加到列表中的日期过滤订阅者 可选
filter_subscription_date_to 字符串 使用“YYYY-MM-DD格式指定间隔的开始和结束日期,以便按添加到列表中的日期过滤订阅者 可选
过滤器 对象 由其中一个变量分割 可选
stretch_time int 战役必须完成的时间范围。在几秒钟内。如果未指定,则使用默认时间(5小时)。 可选
send_date 字符串 在特定的日期和时间安排活动:YYYY-MM-DD HH: MM: SS(例如,2020-09-11 16:19:10 可选
按钮 字符串 插入一个按钮到活动,接受一个JSON字符串,列出按钮和它们的值,例如:[{“文本”:“Button1”,“链接”:“link1”}](最多两个按钮) 可选
图像 字符串

在网页推送通知中插入较大的图像;图像参数必须包含这样一个JSON字符串{" name ": " test.jpg”、“数据”:“file_content”},在那里test.jpg-是图像名称,和file_content- Base64_encode(文件内容),可以使用PHP通过“file_get_contents”获得

*图片必须为JPG、PNG或GIF格式,且小于200KB

可选

图标 字符串

此参数用于插入标准尺寸的自定义图像:
参数必须包含这样一个JSON字符串{" name ": " icon.jpg”、“数据”:“base64_file_content”},在那里icon.jpg-是图像名称,并且base64_file_content-文件的内容

可选

请注意:你可以为一个活动添加多达10个过滤器。

滤波器参数结构示例:

{“variable_name”:“uname”、“操作符”:“或”,“条件”:[{“条件”:“像”,“价值”:“a”},{“条件”:“不等号”、“价值”:“b”}]}

反应参数:

参数 类型 描述
variable_name 字符串 变量名
操作符 字符串 连接操作员,只接受
条件 数组 条件数组
条件 接受以下值:
平等的 完全平等
不等号 完全不相等
greaterthan 超过
不超过 不到
startwith 开始于
endwith 结尾
包含
notlikewith 不包含
价值 变量值

如果请求成功,您将收到一个响应:

{"result": true, "id": 1}

获取发送活动的统计数据

要获取已发送活动的统计信息,请发送get请求到:

https://api.半岛客户端下载官网m.ekobsc.com/push/tasks/ {id}

请求参数:

参数 类型 描述
id int 网络推送活动ID 要求

如果请求成功,您将收到一个响应:

{" id ": 36岁的“消息”:{“标题”:“s”、“文本”:“s”,“链接”:“http://aaa。aaa”},“网站”:“www.google.com”,“website_id”:53岁的“状态”:3,“送”:“21”、“交付”:14日“定向”:13}

网络推送活动状态:

代码 描述
0 新赛季
2 在进行中
3. 发送
8 测试活动发送
12 没有活跃的收件人
13 正在创建战役-复制订阅
15 等待A/B测试结果的活动
16 被用户取消
30. 存档
Baidu
map