登录
原创

webhookAPI文档

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

说明

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

请求方式

http POST content-type:application/json

公共推送数据格式

字段名 字段类型 字段说明
push_time string 推送时间,格式为:yyyy-MM-dd HH:ii:ss
event_title string 消息标题
data object 推送具体数据,data中的数据格式以及字段,会根据服务的不同而不同,请具体参考具体的api接口

公共推送数据示例

{
	"push_time": "2021-01-02 03:04:05",
	"event_title": "接孩子",
	"data": {}
}

天气预报推送数据字段

字段说明

字段名 字段类型 字段说明
push_time string 推送时间,格式为:yyyy-MM-dd HH:ii:ss
event_title 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",
	"event_title": "天气",
	"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": "东南风转东北风"
		}]
	}
}

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

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

字段说明

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

json示例

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

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

字段说明

字段名 字段类型 字段说明
push_time string 推送时间,格式为:yyyy-MM-dd HH:ii:ss
event_title 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",
	"event_title": "自然灾害预警",
	"data": {
		"id": "40915",
		"title": "江苏省常熟市发布高温黄色预警",
		"level": "黄色",
		"type": "高温",
		"time": "2021-09-01 09:34:35",
		"province": "江苏省",
		"city": "苏州市",
		"district": "常熟市",
		"content": "常熟市气象台2021年09月01日09时33分继续发布高温黄色预警信号:预计今天我市最高气温可达35℃左右,请注意防暑降温。(预警信息来源:国家预警信息发布中心)"
	}
}

星座运势推送数据字段

当用户在聚合云推公众号中订阅了星座运势服务后,聚合云推给客户推送的数据格式参见下方

字段说明

字段名 字段类型 字段说明
push_time string 推送时间,格式为:yyyy-MM-dd HH:ii:ss
event_title string 消息标题
data object 推送数据具体内容
name string 星座名称
all string 综合指数
color string 幸运色
health string 健康指数
love string 爱情指数
money string 财运指数
QFriend string 速配星座
summary string 今日概述
work string 工作指数
number string 幸运数字

json示例

{
	"push_time": "2021-01-02 03:04:05",
	"event_title": "星座运势",
	"data": {
		"name": "天秤座",
		"QFriend": "白羊座",
		"color": "浅红色",
		"health": "60",
		"love": "80",
		"work": "70",
		"money": "85",
		"number": 4,
		"summary": "今天的你在和另一半的交往过程当中,沟通能力有所欠缺,不是很想和TA聊天说话,甚至对于另一方的主动沟通,你也会下意识的拒绝。是不是内心正存在着什么问题,才会让你这样的逃避?",
		"all": "80"
	}
}

消息推送API推送数据字段

当用户通过消息推送API接口发送了消息内容后,聚合云推给客户推送的数据格式参见下方

字段说明

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

json示例

{
	"data": {
		"content": "你好,世界",
		"title": "这是标题"
	},
	"event_title": "消息推送API",
	"push_time": "2021-11-11 00:00"
}

评论区

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

0

0

0

举报