微信小程序开发文档微信小程序城市服务消息通路接口

2024-02-25 开发教程微信小程序开发文档匿名 5℃

results-page

接入微信城市服务，业务方需确保功能的闭环服务体验，需接入消息通路。点击此处查看城市服务消息通路说明。

调用方法

1、接口调用请求

请求方式：POST 请求地址：https://api.weixin.qq.com/cityservice/sendmsgdata?access_token=ACCESS_TOKEN

（1）获取access_token方式请点击此处查看；获取openid方式请点击此处查看。

（2）通过小程序提供服务时，需使用小程序用户 openid ，并使用与小程序关联的、且申请了“消息通路”的公众号的 access_token

2、以POST方式传入json格式的参数

（1）模板申请成功后，将会分配biz_template_id，并根据模板推送渠道不同分别提供样式ID：result_page_style_id、deal_msg_style_id、card_style_id。

（2）调用接口时，通过POST方式传入json格式的以下参数，所有参数的数据类型均为“字符串”，且字符集默认使用UTF-8。

字段说明

参数	说明	是否必填
openid	用户唯一标识	必填
`biz_template_id`	城市服务分配给公众号的模板id	必填
`result_page_style_id`	结果页样式id	含结果页必填
`deal_msg_style_id`	办事记录样式id	含办事记录必填
`card_style_id`	页卡样式id	含页卡必填
`order_no`	订单号，同一订单号的办事记录会合并	必填
url	跳转链接，用于服务通知、结果页、待办提醒	含结果页必填
data	模板json数据，其中color字段只对服务通知有效	必填

参数示例

{
           "openid":"OPENID",
           "biz_template_id":"ngqIpbwh8bUfcSsECmogfXcV14J0tQlEpBO27izEYtY",
           "result_page_style_id":"cUjfPSEtwasWQFsJ5PXo218PexBaHy5jg_peVDe4WkY",
           "deal_msg_style_id":"cUjfPSEtwasWQFsJ5PXo24LeNjWbwMObXSHPNjVZ0uQ",
           "card_style_id":"cUjfPSEtwasWQFsJ5PXo2z8LSM0Q6FH05DCerWEVkDs",
           "order_no":"ORDER_NO",
           "url":"http://weixin.qq.com/download",
           "data":{
                   "first": {
                       "value":"恭喜你购买成功！",
                       "color":"#173177"
                   },
                   "keynote1":{
                       "value":"巧克力",
                       "color":"#173177"
                   },
                   "keynote2": {
                       "value":"39.8元",
                       "color":"#173177"
                   },
                   "keynote3": {
                       "value":"2014年9月22日",
                       "color":"#173177"
                   },
                   "remark":{
                       "value":"欢迎再次购买！",
                       "color":"#173177"
                   }
           }
}

注：data为数组时用[ ]括起“data”字段内数据。

3、返码说明

在调用消息通路接口后，返回JSON数据包：

返回结果	返回码	说明
`result_page_url`	结果页url	需跳转至该url，替代原有的服务结果页面。如未传入`result_page_style_id`，则调用后`result_page_url`返回为空。
errcode	48001	api未授权
errcode	40097	1.参数错误。2.或openid不来自有“消息通路”api权限的公众号
errcode	82020	未关注公众号的用户，从未在城市服务访问过服务
errcode	82021	未关注公众号的用户，未在近30天内通过城市服务访问服务
errcode	82022	未关注公众号的用户，通过城市服务访问服务后，30天内被下发数超过10次（医疗行业超过20次）
errcode	82023	未关注公众号的用户，1个小时内被下发次数超过5次
errcode	82024	order_no异常，例如所有用户的业务订单号都用同一个
errcode	82025	URL无效
errcode	82026	1.服务已下线。2.或服务在审核中且审核期超过了30天

正常时的返回JSON数据包示例：

{
"errcode":0,
"errmsg":"ok",
"result_page_url":"https://city.weixin.qq.com/static/resultpagenew.html?openid=ont-9vjAcIdSU-LgB7ubALAVJO9U&biz_template_id=ngqIpbwh8bUfcSsECmogfXcV14J0tQlEpBO27izEYtY #wechat_redirect"
}

注：如未传入结果页样式ID（result_page_style_id），则result_page_url结果为空

4、页面报错提示

提示信息	说明
中文显示错误	字符集未用utf8
参数错误	json参数错误
非本人，页面打开失败	非本人openid；或登录态获取失败
请在微信内打开	需在微信内打开页面
系统错误	其他错误

上一节：微信小程序城市服务接入安全检测

下一节：微信小程序城市服务快速填写组件

"微信小程序开发文档"的目录