# 消息推送接口
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:cityservice_sendchannelmsg
用于下发就医助手消息,结合通用参数和不同子状态status参数组合实现各类业务消息推送
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/cityservice/sendchannelmsg?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:22、105、113、134
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String parameters
参数名 | 类型 | 必填 | 示例 | 说明 |
---|---|---|---|---|
access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token、authorizer_access_token |
# 请求体 Request Payload
参数名 | 类型 | 必填 | 示例 | 说明 |
---|---|---|---|---|
status | number | 是 | 1501001 | 消息子状态(如:1501001-预约挂号成功通知) |
open_id | string | 是 | osdjkfhsdlkfjhdslkjfh | 用户openid(公众号/小程序) |
order_id | string | 是 | order_123456 | 业务方生成的唯一订单ID |
msg_id | string | 是 | msg_0001 | 消息唯一标识(需保证同用户同order_id下唯一) |
app_id | string | 是 | wx23dde3xd34569cba | 公众号appid(需开通就医助手) |
business_id | number | 是 | 150 | 固定值150 |
business_info | string | 否 | {"pat_name":"李*龙","doc_name":"王小二"} | 业务字段(不同status对应不同结构) |
# 3. 返回参数
# 返回体 Response Payload
参数名 | 类型 | 说明 |
---|---|---|
errcode | number | 错误码 |
errmsg | string | 错误信息 |
# 4. 注意事项
- 仅支持公立医院及卫健委主体的公众号/小程序使用
- 需先开通就医助手能力
- 需使用同主体公众号的access_token调用
- 同次就医流程需使用相同order_id
# 5. 代码示例
请求示例
{
"status": 1501001,
"open_id": "osdjkfhsdlkfjhdslkjfh",
"order_id": "order_123456",
"msg_id": "msg_0001",
"app_id": "wx23dde3xd34569cba",
"business_id": 150,
"business_info": {
"pat_name": "李*龙",
"doc_name": "王小二",
"pat_hospital_id": "a123456",
"department_name": "门诊3楼五官科",
"appointment_time": "2023-06-07 10:30-11:00",
"redirect_page": {
"page_type": "web",
"url": "https:zhongshanyi.com/guahao?order_id=order1"
}
}
}
返回示例
{
"errcode": 0,
"errmsg": "ok"
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码
错误码 | 错误描述 | 解决方案 |
---|---|---|
0 | ok | 成功 |
40001 | invalid credential | 不合法的access_token |
# 7. 适用范围
本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请已实际调用情况为准。