# 消息通路发消息
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南。
接口英文名:cityservice_sendmsgdata
接入微信城市服务,业务方需确保功能的闭环服务体验,需接入消息通路。点击此处查看城市服务消息通路说明。
模板申请成功后,将会分配biz_template_id,并根据模板推送渠道不同分别提供样式ID:result_page_style_id、deal_msg_style_id、card_style_id。
- 通过公众号提供服务时,需使用公众号用户 openid,获取openid方式请 点击此处查看。
- 通过小程序提供服务时,需使用小程序用户 openid ,并使用与小程序关联的、且申请了“消息通路”的公众号的 access_token
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/cityservice/sendmsgdata?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用。
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:22、105
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String Parameters
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token、authorizer_access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| openid | string | 是 | 用户唯一标识 |
| biz_template_id | string | 是 | 城市服务分配给公众号的模板id |
| result_page_style_id | string | 否 | 结果页样式id,含结果页必填 |
| deal_msg_style_id | string | 否 | 办事记录样式id,含办事记录必填 |
| card_style_id | string | 否 | 页卡样式id,含页卡必填 |
| order_no | string | 是 | 订单号,同一订单号的办事记录会合并 |
| url | string | 否 | 跳转链接,用于服务通知、结果页、待办提醒,。含结果页必填 |
| data | object | 是 | 模板json数据,对象信息请按照模板要求,其中color字段只对服务通知有效。如为数组时可用[ ]括起字段内数据。 |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| result_page_url | string | 需跳转至该url,替代原有的服务结果页面。如未传入result_page_style_id,则调用后result_page_url返回为空。 |
| errcode | number | 错误码 |
| errmsg | string | 错误描述 |
# 4. 注意事项
result_page_url 页面报错提示
| 提示信息 | 说明 |
|---|---|
| 中文显示错误 | 字符集未用utf8 |
| 参数错误 | json参数错误 |
| 非本人,页面打开失败 | 非本人openid;或登录态获取失败 |
| 请在微信内打开 | 需在微信内打开页面 |
| 系统错误 | 其他错误 |
# 5. 代码示例
请求示例
{
"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"
}
}
}
返回示例
{
"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"
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 |
|---|---|
| 40097 | 1.参数错误。2.或openid不来自有“消息通路”api权限的公众号 |
| 48001 | api未授权 |
| 82020 | 未关注公众号的用户,从未在城市服务访问过服务 |
| 82021 | 未关注公众号的用户,未在近30天内通过城市服务访问服务 |
| 82022 | 未关注公众号的用户,通过城市服务访问服务后,30天内被下发数超过10次(医疗行业超过20次) |
| 82023 | 未关注公众号的用户,1个小时内被下发次数超过5次 |
| 82024 | order_no异常,例如所有用户的业务订单号都用同一个 |
| 82025 | URL无效 |
| 82026 | 1.服务已下线。2.或服务在审核中且审核期超过了30天 |
# 7. 适用范围
本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请已实际调用情况为准。