消息实时推送(仅支持APP消息和微信小程序消息)
名称 | 类型 | 是否必须 | 示例值 | 描述 |
---|---|---|---|---|
appMethod | String | Y | suning.custom.category.query | 方法名 |
appRequestTime | String | Y | 2012-04-25 20:23:30 | 时间戳,格式为yyyy-MM-dd HH:mm:ss,例如:2012-04-25 20:23:30。API服务端允许客户端请求时间误差为10分钟。 |
format | String | N | XML | 默认xml,可指定格式为xml,json |
appKey | String | Y | b0c332a133c102765f39de********** | 分配给应用的访问令牌 |
versionNo | String | Y | v1.2 | API的版本,目前为v1.2版本 |
signInfo | String | Y | 460d7ff15b073e463125b4********** | appSecret,appMethod ,appRequestTime, appKey, versionNo, 请求报文base64加密后的数据顺序MD5(32位小写),其中appSecret为appKey对应的密钥 |
access_token | String | N | a1c5c62b08df3a3cbf7efd********** | 采用OAuth授权方式为必填参数 |
名称 | 类型 | 是否必须 | 示例值 | 描述 |
---|---|---|---|---|
snUnionId | String | Y | 69b75ba05b81eab12fa13eeda5da69b75ba1c5b81eab92fa | 混淆会员编码 |
msgSceneCode | String | Y | Y00370 | 场景编码 |
wxMiniProMsg | String | N | ||
appId | String | N | testApp | 小程序appid(必填) |
msgContent | String | N | 消息模板内容 | 微信小程序模板所有内容(必填) |
templeId | String | N | zWiU8DFaL9f14EygPRSyo8ASVaDP-llc60LvUgXNKi8 | 微信小程序模版id(必填) |
pageUrl | String | N | 微信小程序内跳转链接地址 | 微信小程序内跳转链接地址 |
deviceVersion | String | N | 设备版本号 | 设备版本号(仅适用于达尔文小程序) |
sceneCode | String | N | 0 | 场景编码(仅适用于达尔文小程序) |
appMsg | String | N | ||
title | String | N | 签到提醒 | 标题(必填) |
content | String | N | 今天还没有签到哦,快来签到吧! | 消息内容(必填) |
actionType | String | N | 0 | 操作动作(0:无操作动作 1:标识链接到APP内某个页面 2:采用浏览器方式链接到某个WEB页面)(必填) |
action | String | N | https://cuxiao.suning.com/scms/bhnsj2020.html | 详情地址(actionType=0:不需要指定 actionType=1:APP页面Code actionType=2:web页url)(必填) |
actionParam | String | N | 00060010225305*000600102252*31000051132*33004428539 | 跳转后页面需要的参数(actionType=1时,传参方式由路由提供方确定) |
imgUrl | String | N | http://image5.suning.cn/uimg/b2c/newcatentries/0010046166-000000000140028078_1_100x100.jpg | 图片地址 |
category | String | N | 900 | 消息中心分类(交易物流: 400(物流助手),700(交易提醒),1100(超时订单消息(苏宁小店店主端使用)) 通知提醒: 300(通知服务),500(我的提醒),900(店铺提醒),1000(会员关怀) 互动:800(互动消息) 订阅号:2200(订阅号) 精选活动:600(精选活动))(必填) |
receiverType | String | N | 0 | 接收人类型(0.会员编号 1.设备token actionType=0此字段无效) |
templet | String | N | 1 | 消息展示模板类型(1:纯文本; 2:图片左文字右; 3:图片上文字下; 4: 中间两张图片,标题在上,内容在下; 5:中间一张图,标题在上,内容在下; 6:多条目模板 100-110 (SNYG预留编码) 200-210 (SNXD预留) 12:问答)(必填) |
validityDay | String | N | 15 | 消息中心消息有效天数,过期则置灰不可点击(必填) |
displayDay | String | N | 15 | 消息中心消息展示天数,过期则该条消息不展示(必填) |
remark | String | N | 备注 | 备注 |
notifyType | String | N | 0 | 消息类型(0-营销消息 1-通知类消息)(必填) |
mapExt | String | N | * * Key1:xdTitle, value:取浮层标题维护的内容 * * Key2:xdContent, value:取浮层内容里面添加的内容:文本+变量 | 消息子弹扩展字段 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
result | String | Y | 推送消息操作结果 |
<sn_request> <sn_body> <createMsgPush> <wxMiniProMsg> <templeId>zWiU8DFaL9f14EygPRSyo8ASVaDP-llc60LvUgXNKi8</templeId> <msgContent>消息模板内容</msgContent> <sceneCode>0</sceneCode> <appId>testApp</appId> <pageUrl>微信小程序内跳转链接地址</pageUrl> <deviceVersion>设备版本号</deviceVersion> </wxMiniProMsg> <msgSceneCode>Y00370</msgSceneCode> <appMsg> <validityDay>15</validityDay> <templet>1</templet> <displayDay>15</displayDay> <remark>备注</remark> <title>签到提醒</title> <content>今天还没有签到哦,快来签到吧!</content> <mapExt>* <p> * Key1:xdTitle, value:取浮层标题维护的内容 * <p> * Key2:xdContent, value:取浮层内容里面添加的内容:文本+变量</mapExt> <imgUrl>http://image5.suning.cn/uimg/b2c/newcatentries/0010046166-000000000140028078_1_100x100.jpg</imgUrl> <actionType>0</actionType> <notifyType>0</notifyType> <receiverType>0</receiverType> <action>https://cuxiao.suning.com/scms/bhnsj2020.html</action> <category>900</category> <actionParam>00060010225305*000600102252*31000051132*33004428539</actionParam> </appMsg> <snUnionId>69b75ba05b81eab12fa13eeda5da69b75ba1c5b81eab92fa</snUnionId> </createMsgPush> </sn_body> </sn_request>
{ "sn_request": { "sn_body": { "createMsgPush": { "wxMiniProMsg": { "templeId": "zWiU8DFaL9f14EygPRSyo8ASVaDP-llc60LvUgXNKi8", "msgContent": "消息模板内容", "sceneCode": "0", "appId": "testApp", "pageUrl": "微信小程序内跳转链接地址", "deviceVersion": "设备版本号" }, "msgSceneCode": "Y00370", "appMsg": { "validityDay": "15", "templet": "1", "displayDay": "15", "remark": "备注", "title": "签到提醒", "content": "今天还没有签到哦,快来签到吧!", "mapExt": "** Key1:xdTitle, value:取浮层标题维护的内容 *
* Key2:xdContent, value:取浮层内容里面添加的内容:文本+变量", "imgUrl": "http://image5.suning.cn/uimg/b2c/newcatentries/0010046166-000000000140028078_1_100x100.jpg", "actionType": "0", "notifyType": "0", "receiverType": "0", "action": "https://cuxiao.suning.com/scms/bhnsj2020.html", "category": "900", "actionParam": "00060010225305*000600102252*31000051132*33004428539" }, "snUnionId": "69b75ba05b81eab12fa13eeda5da69b75ba1c5b81eab92fa" } } } }
异常码 | 错误描述 | 解决方案 |
---|---|---|
biz.custom.createmsgPush.format-error:* | 参数格式错误 | 请检查此参数的值,*号表示参数字段名 |
biz.custom.createmsgPush.enumeration-error:* | 参数的可选值错误 | 请检查此参数的值,*号表示参数字段名 |
biz.custom.createmsgPush.missing-parameter:* | 参数必填 | 请检查此参数的值,*号表示参数字段名 |
biz.custom.createpushmsg.missing-parameter:* | 参数必填 | 请检查此参数的值,*号表示参数字段名 |
isp.sys.service.unavailable.xhwmp | 服务不可用 | 请联系苏宁技术人员 |
异常码 | 错误描述 | 解决方案 |
---|---|---|
sys.check.user-permission:inexistence | 访问令牌不存在 | 更换访问令牌 |
sys.check.user-permission:overdue | 访问令牌已过期 | 请使用刷新令牌刷新 |
sys.check.api-permission:inexistence | Api方法不存在 | 请参考帮助中心 |
sys.check.api-permission:overdue | Api方法已过期 | 请参考帮助中心 |
sys.check.method-permission:authority | 无权操作此api | 确认是否有访问该方法权限 |
sys.auth.vendor-request:errory | 无权操作此供应商 | 请确认供应商编码是否正确 |
sys.controller.api-request:limit | Api请求受控 | 超过请求次数 |
sys.check.app-time:error | 请求参数错误api请求时间误差大 | 参考帮助中心 |
sys.check.request-params:error | 请求报文结构错误 | 参考帮助中心、日期格式等 |
sys.check.starttime-format:error | 请求开始时间错误 | 参考帮助中心、日期格式等 |
biz.handler.data-get:success | 业务数据查询成功 | 无 |
biz.handler.data-get:fail | 业务数据查询失败 | 检查请求条件 |
biz.handler.data-get:no-result | 业务数据结果为空 | 无 |
sys.check.pageno-format:error | pageNo格式错误,只允许1到99999之间的整数 | 检查pageNo输入是否有误 |
sys.check.pagesize-format:error | pageSize格式错误,只允许1到50之间的整数(订单相关是1到100) | 检查pageSize输入是否有误 |
sys.check.page-param:error | pageNo或者pageSize不在要求范围内,pageNo只允许1到99999之间的整数,pageSize只允许1到50之间的整数(订单相关是1到100) | 检查pageNo和pageSize输入是否有误 |
sys.check.miss-time:starttime | 不存在开始时间(节点) | 检查输入 |
sys.check.miss-time:endtime | 不存在结束时间(节点) | 检查输入 |
sys.check.starttime-value:null | 开始时间为空(值) | 检查输入 |
sys.check.endtime-value:null | 结束时间为空(值) | 检查输入 |
sys.check.starttime-format:error | 校验开始时间不合法,格式yyyy-MM-dd HH:mm:ss | 检查时间格式 |
sys.check.endtime-format:error | 校验结束时间不合法,格式yyyy-MM-dd HH:mm:ss | 检查时间格式 |
sys.check.query-time:error | 开始时间是否小于结束时间 | 检查开始和结束时间大小 |
sys.check.query-time:outofrange | 时间查询是否超出指定范围 | 检查时间范围 |
sys.check.app-sign:null | 签名信息为空 | 检查签名信息 |
sys.check.app-sign:error | 签名信息错误 | 检查签名信息 |
sys.check.missing-parameter:apiversion | API版本号未指定 | 检查API版本号 |
sys.check.missing-parameter:appRequestTime | 请求时间丢失 | 检查请求时间 |
sys.check.missing-nestElement:sn_body | 缺少sn_body节点 | 检查sn_body是否存在 |
sys.check.user-permission:inexistence | 用户key不存在 | 检查用户key是否存在 |
biz.handler.batch-handler:no-support | 非查询类API不支持批量操作 | 检查API类型 |
biz.handler.request-message:error | 查询类API输入多个业务节点 | 检查业务节点 |
sys.check.header-param:null | header参数为空 | 请检查header参数 |
sys.controller.api-access:limit | 访问限制 | 无 |
sys.controller.api-frequency:limit | 访问频率限制 | 无 |
sys.error.network:failure | 网络异常 | 无 |
sys.error.network-status:? | 响应失败 ?为状态码 | 无 |
sys.check.snunionid.length.is.not:48 | 混淆会员编码长度不是48位 | 使用转换器转换混淆会员编码规定要求混淆会员编码48位 |