文档修订记录
版本 | 更新日期 | 更新内容 |
---|---|---|
3.2.1 | 2024.12.13 | 提供批量推送微信小游戏的订阅模板消息接口 |
3.1.1 | 2024.07.25 | 提供推送微信小游戏的订阅模板消息接口 |
1. 批量推送微信小游戏的订阅模板消息接口
1.1 说明
目前支持了将微信平台的订阅模板消息内容批量推送到用户,具体接入找平台协助处理。
v3.1.1 单条推送的接口 将不再维护,并且有下线计划。期望接入游戏优先接入本文档的推送接口。
1.2 Api地址
地址: https://api-combine.feiyu.com/v1/wechatMiniGame/template/batchPush
1.3 请求方式
POST
1.4 请求头
"Content-type":"application/json"
1.5 请求参数
请求示例:
{
"app_id": "30035",
"message_list": [
{
"data": {
"date4": {
"value": "2024年7月26日"
},
"thing1": {
"value": "推送测试1"
},
"thing3": {
"value":"测试一下x"
},
"time5": {
"value":"14:44"
}
},
"miniprogram_state": "developer",
"open_id": "0498313ebb8b0e43a585e9ffc1700821",
"template_id": "_g4yIicAZiT6qIQK176inSOSDDMPUUpWLHfIceJ_cJM"
},
{
"data": {
"date4": {
"value": "2024年7月26日"
},
"thing1": {
"value": "推送测试2"
},
"thing3": {
"value":"测试一下y"
},
"time5": {
"value":"14:44"
}
},
"miniprogram_state": "developer",
"open_id": "54f45aec7bde1bfc2333a6a263c79ed6",
"template_id": "_g4yIicAZiT6qIQK176inSOSDDMPUUpWLHfIceJ_cJM"
}
],
"sign": "838d7d35c014e87377a7837091952994",
"sign_nonce": "OuptFmUa",
"sign_type": "md5",
"sign_version": "1.1",
"timestamp": "1721980354"
}
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
app_id | 是 | string | 应用ID |
message_list | 是 | list<Object> |
消息列表(一批最多支持推送1000条消息,超过则取前1000个) |
message_list.open_id | 是 | string | 用户的聚合openID(不是微信openID) |
message_list.template_id | 是 | string | 微信模板ID(在“微信公众平台-功能-订阅消息”中查看) |
message_list.data | 是 | Object | 模板内容,格式形如 { "key1": { "value": any }, "key2": { "value": any } } |
message_list.page | 否 | string | 点击模板卡片后的跳转页面,仅限本小程序内的页面。支持带参数,(示例index?foo=bar)。该字段不填则模板无跳转。 |
message_list.miniprogram_state | 否 | string | 跳转小程序类型:developer为开发版;trial为体验版;formal为正式版;默认为正式版 |
message_list.lang | 否 | string | 进入小程序查看”的语言类型,支持zh_CN(简体中文)、en_US(英文)、zh_HK(繁体中文)、zh_TW(繁体中文),默认为zh_CN |
timestamp | 是 | string | 10位时间戳 |
sign | 是 | string | 签名值 |
sign_type | 是 | string | 签名类型(默认:md5) |
sign_nonce | 是 | string | 签名随机数(随机数字+字符串共8位) |
sign_version | 是 | string | 签名版本,1.1 |
1.6 返回参数
返回实例:
{
"trace_id": "66be5dedc787190804a0b0202ae39758",
"status": 0,
"message": "OK",
"data": {
}
}
通用参数
参数名 | 类型 | 说明 |
---|---|---|
trace_id | string | 请求唯一ID |
status | int | 状态码, 0代表成功,非0状态码可参考如下错误码表格确认信息 |
message | string | 返回结果描述 |
错误码
status | 说明 |
---|---|
400 | 错误请求,参数有误 |
500 | 未知的服务内部错误(无法拿到明确message,可联系平台研发排查问题) |
4000 | 业务内部错误(能拿到明确message) |
数据参数
暂无
2 签名规则
2.1 MD5签名
2.1.1、获取基础接入参数
在【对接中心->渠道打包->配置参数】,:App ID(请求参数app_id)
和App Secret(签名密钥)
。