# 消息推送接口

调试诊断

接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南

接口英文名:cityservice_sendchannelmsg

用于下发就医助手消息,结合通用参数和不同子状态status参数组合实现各类业务消息推送,要获取所有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_tokenstringACCESS_TOKEN接口调用凭证,可使用 access_tokenauthorizer_access_token

# 请求体 Request Payload

参数名类型必填示例说明
statusnumber1501001消息子状态(如:1501001-预约挂号成功通知)
open_idstringosdjkfhsdlkfjhdslkjfh用户openid(公众号/小程序)
order_idstringorder_123456业务方生成的唯一订单ID
msg_idstringmsg_0001消息唯一标识(需保证同用户同order_id下唯一)
app_idstringwx23dde3xd34569cba公众号appid(需开通就医助手)
business_idnumber150固定值150
business_infoobject业务字段(不同status对应不同结构)

# Body.business_info Object Payload

业务字段(不同status对应不同结构)

参数名类型必填示例说明
pat_hospital_idstring-用户在该医院就诊卡号
pat_namestring-用户姓名
doc_namestring-医生姓名,如果暂无具体分配的医生,则填医生级别(如主治医生)
department_namestring-科室名称,含楼栋楼层(如果有)
department_locationstring-科室位置
appointment_timestring2023-06-07 10:30-11:00预约时间
memostring-就医须知
redirect_pageobject-医院跳转页面信息
elder_redirect_pageobject-医院适老化页面的跳转信息

# Body.business_info.redirect_page Object Payload

医院跳转页面信息

以下参数也使用此结构:

  • Body.business_info.elder_redirect_page : 医院适老化页面的跳转信息
参数名类型必填说明枚举
page_typestring页面路径类型,如果有redirect_page字段需要填,则必填page_type; 否则不用填枚举值
urlstring网页网址,page_type为web类型时必填,url需为业务域名-
app_idstring小程序appid,page_type为小程序时必填,小程序类型时需与当前账号关联主体-
fullpathstring小程序路径,page_type为小程序时必填-

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
errcodenumber错误码
errmsgstring错误信息

# 4. 枚举信息

# Body.business_info.redirect_page.page_type Enum

页面路径类型,如果有redirect_page字段需要填,则必填page_type; 否则不用填

枚举值描述
web网页
mini_program小程序

# 5. 注意事项

  1. 仅支持公立医院及卫健委主体的公众号/小程序使用
  2. 需先开通就医助手能力
  3. 需使用同主体公众号的access_token调用
  4. 同次就医流程需使用相同order_id

# 6. 代码示例

请求示例

{
  "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"
}

# 7. 错误码

以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。

错误码错误描述解决方案
0ok成功
40001invalid credential不合法的access_token

# 8. 适用范围

本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请已实际调用情况为准。