登录
原创

webhookAPI文档

发布于 2021-09-01 阅读 174
  • API
原创

说明

用户在选在聚合云推的推送服务时,当推送方式中存在webhook的方式时,聚合云推方,会在消息推送事件被触发时,根据用户配置的webhook回调地址,向此接口地址采用POST的方式请求。
当用户选择不同的不同时,我们POST的body内容也会因此不同,从而会出现不同的数据格式,我们在此处对于推送数据与数据格式加以说明

请求方式

http POST content-type:application/json

公共推送数据格式

字段名 字段类型 字段说明
push_time string 推送时间,格式为:yyyy-MM-dd HH:ii:ss
data object 推送具体数据,data中的数据格式以及字段,会根据服务的不同而不同,请具体参考具体的api接口
sign string 消息签名,通过使用聚合云推的RSA私钥进行的签名(base64编码),以证明是聚合云推推送的数据

公共推送数据示例

{
	"push_time": "2021-01-02 03:04:05",
	"data": {},
	"sign": "JXU4RkQ5JXU5MUNDJXU2NjJGJXU4OTgxJXU1MkEwJXU1QkM2JXU3Njg0JXU1MTg1JXU1QkI5JXVGRjAx"
}

天气预报推送数据字段

此处我们以天气预报的推送数据格式进行举例说明

字段说明

字段名 字段类型 字段说明
push_time string 推送时间,格式为:yyyy-MM-dd HH:ii:ss
sign string 消息签名
data object 推送数据具体内容
realtime object 当前天气详情情况
realtime.info string 天气情况,如:晴、多云
realtime.wid string 天气标识id,可参考小接口2
realtime.temperature string 温度,可能为空
realtime.humidity string 湿度,可能为空
realtime.direct string 风向,可能为空
realtime.power string 风力,可能为空
realtime.aqi string 空气质量指数,可能为空
future array 近5天天气情况
future.date string 日期
future.temperature string 温度,最低温/最高温
future.weather string 天气情况
future.direct string 风向

json示例

{
	"push_time": "2021-01-02 03:04:05",
	"data": {
		"realtime": {
			"temperature": "30",
			"humidity": "59",
			"info": "多云",
			"wid": "01",
			"direct": "西南风",
			"power": "2级",
			"aqi": "49"
		},
		"future": [{
			"date": "2021-07-08",
			"temperature": "22/33℃",
			"weather": "多云",
			"wid": {
				"day": "01",
				"night": "01"
			},
			"direct": "东南风"
		}, {
			"date": "2021-07-09",
			"temperature": "23/33℃",
			"weather": "多云",
			"wid": {
				"day": "01",
				"night": "01"
			},
			"direct": "东南风转西北风"
		}, {
			"date": "2021-07-10",
			"temperature": "24/33℃",
			"weather": "多云",
			"wid": {
				"day": "01",
				"night": "01"
			},
			"direct": "东北风转东南风"
		}, {
			"date": "2021-07-11",
			"temperature": "23/32℃",
			"weather": "多云转雷阵雨",
			"wid": {
				"day": "01",
				"night": "04"
			},
			"direct": "东北风"
		}, {
			"date": "2021-07-12",
			"temperature": "21/28℃",
			"weather": "中雨转雷阵雨",
			"wid": {
				"day": "08",
				"night": "04"
			},
			"direct": "东南风转东北风"
		}]
	},
	"sign": "JXU4RkQ5JXU5MUNDJXU2NjJGJXU4OTgxJXU1MkEwJXU1QkM2JXU3Njg0JXU1MTg1JXU1QkI5JXVGRjAx"
}

自定义提醒事件推送数据字段

当用户在聚合云推公众号中设置或者通过API发送了自定义的内容后,聚合云推给客户推送的数据格式参见下方

字段说明

字段名 字段类型 字段说明
push_time string 推送时间,格式为:yyyy-MM-dd HH:ii:ss
sign string 消息签名
data object 推送数据具体内容
title string 消息标题
content string 消息内容

json示例

{
	"push_time": "2021-01-02 03:04:05",
	"data": {
		"title": "接孩子",
		"content": "周五三点放学,别忘记接孩子"
	},
	"sign": "JXU4RkQ5JXU5MUNDJXU2NjJGJXU4OTgxJXU1MkEwJXU1QkM2JXU3Njg0JXU1MTg1JXU1QkI5JXVGRjAx"
}

气象灾害预警推送数据字段

当用户在聚合云推公众号中订阅了气象灾害预警服务后,聚合云推给客户推送的数据格式参见下方

字段说明

字段名 字段类型 字段说明
push_time string 推送时间,格式为:yyyy-MM-dd HH:ii:ss
sign string 消息签名
data array 推送数据具体内容
id string 预警消息ID
title string 预警消息标题
level string 预警等级, 橙色/红色/蓝色/黄色/未知
type string 预警类型
time string 预警发布时间
province string 省份, 可能为空
city string 城市, 可能为空
district string 区域, 可能为空
content string 预警详细内容

json示例

{
	"push_time": "2021-01-02 03:04:05",
	"data": [{
			"id": "40915",
			"title": "江苏省常熟市发布高温黄色预警",
			"level": "黄色",
			"type": "高温",
			"time": "2021-09-01 09:34:35",
			"province": "江苏省",
			"city": "苏州市",
			"district": "常熟市",
			"content": "常熟市气象台2021年09月01日09时33分继续发布高温黄色预警信号:预计今天我市最高气温可达35℃左右,请注意防暑降温。(预警信息来源:国家预警信息发布中心)"
		},
		{
			"id": "40907",
			"title": "江苏省苏州市发布高温黄色预警",
			"level": "黄色",
			"type": "高温",
			"time": "2021-09-01 09:28:29",
			"province": "江苏省",
			"city": "苏州市",
			"district": "",
			"content": "苏州市气象台2021年09月01日09时25分继续发布高温黄色预警信号:预计今天我市最高气温可达35℃左右,请注意防暑降温。(预警信息来源:国家预警信息发布中心)"
		}
	],
	"sign": "JXU4RkQ5JXU5MUNDJXU2NjJGJXU4OTgxJXU1MkEwJXU1QkM2JXU3Njg0JXU1MTg1JXU1QkI5JXVGRjAx"
}

评论区

眉上的汗水,眉下的泪水,你总要选择一样

0

0

0

举报