爱康云医接口文档

爱康云医API文档


业务消息配置修改

<p><strong>迭代版本:</strong>2.9.1.0(新增)</p> <p><strong>简要描述:</strong></p> <ul> <li>业务消息配置修改</li> </ul> <p><strong>请求URL:</strong> </p> <ul> <li><code>http://aky.mynatapp.cc/chronic/messageSendConfig/update</code></li> </ul> <p><strong>请求方式:</strong></p> <ul> <li>POST</li> <li>Content-Type:application/json</li> </ul> <p><strong>参数:</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">code</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>业务编码,修改时不允许编辑</td> </tr> <tr> <td style="text-align: left;">name</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>业务名称</td> </tr> <tr> <td style="text-align: left;">description</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>业务场景描述</td> </tr> <tr> <td style="text-align: left;">beanName</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String</td> <td>自定义类名</td> </tr> <tr> <td style="text-align: left;">methodName</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String</td> <td>自定义方法名</td> </tr> <tr> <td style="text-align: left;">sqlQuery</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String</td> <td>自定义SQL</td> </tr> <tr> <td style="text-align: left;">wxChannelList</td> <td style="text-align: left;">否</td> <td style="text-align: left;">list</td> <td>微信通道配置列表</td> </tr> <tr> <td style="text-align: left;">title</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>标题或描述</td> </tr> <tr> <td style="text-align: left;">platform</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>平台</td> </tr> <tr> <td style="text-align: left;">templateId</td> <td style="text-align: left;">是</td> <td style="text-align: left;">int</td> <td>模板</td> </tr> <tr> <td style="text-align: left;">sqlQuery</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String</td> <td>自定义SQL</td> </tr> <tr> <td style="text-align: left;">linkUrl</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String</td> <td>跳转链接</td> </tr> <tr> <td style="text-align: left;">miniProgram</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String</td> <td>跳转的小程序,150=医生小程序 151=家属小程序 152=音视频小程序</td> </tr> <tr> <td style="text-align: left;">pagePath</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String</td> <td>小程序page</td> </tr> <tr> <td style="text-align: left;">details</td> <td style="text-align: left;">否</td> <td style="text-align: left;">list</td> <td>模板变量列表</td> </tr> <tr> <td style="text-align: left;">keyword</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>变量名</td> </tr> <tr> <td style="text-align: left;">value</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>变量内容</td> </tr> <tr> <td style="text-align: left;">color</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>颜色,默认#173177</td> </tr> <tr> <td style="text-align: left;">smsChannelList</td> <td style="text-align: left;">否</td> <td style="text-align: left;">list</td> <td>短信通道配置列表</td> </tr> <tr> <td style="text-align: left;">title</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>标题或描述</td> </tr> <tr> <td style="text-align: left;">templateId</td> <td style="text-align: left;">是</td> <td style="text-align: left;">int</td> <td>模板</td> </tr> <tr> <td style="text-align: left;">sqlQuery</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String</td> <td>自定义SQL</td> </tr> <tr> <td style="text-align: left;">details</td> <td style="text-align: left;">否</td> <td style="text-align: left;">list</td> <td>模板变量列表</td> </tr> <tr> <td style="text-align: left;">keyword</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>变量名</td> </tr> <tr> <td style="text-align: left;">value</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>变量内容</td> </tr> <tr> <td style="text-align: left;">vmsChannelList</td> <td style="text-align: left;">否</td> <td style="text-align: left;">list</td> <td>语音通道配置列表</td> </tr> <tr> <td style="text-align: left;">title</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>标题或描述</td> </tr> <tr> <td style="text-align: left;">templateId</td> <td style="text-align: left;">是</td> <td style="text-align: left;">int</td> <td>模板</td> </tr> <tr> <td style="text-align: left;">sqlQuery</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String</td> <td>自定义SQL</td> </tr> <tr> <td style="text-align: left;">details</td> <td style="text-align: left;">否</td> <td style="text-align: left;">list</td> <td>模板变量列表</td> </tr> <tr> <td style="text-align: left;">keyword</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>变量名</td> </tr> <tr> <td style="text-align: left;">value</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>变量内容</td> </tr> <tr> <td style="text-align: left;">sysChannelList</td> <td style="text-align: left;">是</td> <td style="text-align: left;">list</td> <td>系统通知通道配置列表</td> </tr> <tr> <td style="text-align: left;">title</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>标题或描述</td> </tr> <tr> <td style="text-align: left;">sendTo</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>用户类型 2=医生 4=患者 5=家属</td> </tr> <tr> <td style="text-align: left;">msgType</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>通知类型 TZ=通知 YJ=预警 DQ=到期</td> </tr> <tr> <td style="text-align: left;">sqlQuery</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String</td> <td>自定义SQL</td> </tr> <tr> <td style="text-align: left;">linkUrl</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String</td> <td>跳转链接</td> </tr> <tr> <td style="text-align: left;">messageTitle</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>通知标题</td> </tr> <tr> <td style="text-align: left;">messageDesc</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String</td> <td>通知描述</td> </tr> <tr> <td style="text-align: left;">messageRemark</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String</td> <td>通知备注</td> </tr> <tr> <td style="text-align: left;">kfChannelList</td> <td style="text-align: left;">否</td> <td style="text-align: left;">list</td> <td>微信客服通道配置列表</td> </tr> <tr> <td style="text-align: left;">title</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>标题或描述</td> </tr> <tr> <td style="text-align: left;">sendTo</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>平台 100=患者微信公众号 101=医生微信公众号 102=家属微信公众号 103=村医微信公众号</td> </tr> <tr> <td style="text-align: left;">sqlQuery</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String</td> <td>自定义SQL</td> </tr> <tr> <td style="text-align: left;">content</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>内容</td> </tr> <tr> <td style="text-align: left;">tochChannelList</td> <td style="text-align: left;">否</td> <td style="text-align: left;">list</td> <td>智能音箱通道配置列表</td> </tr> <tr> <td style="text-align: left;">title</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>标题或描述</td> </tr> <tr> <td style="text-align: left;">sqlQuery</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String</td> <td>自定义SQL</td> </tr> <tr> <td style="text-align: left;">content</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>内容</td> </tr> <tr> <td style="text-align: left;">watchChannelList</td> <td style="text-align: left;">否</td> <td style="text-align: left;">list</td> <td>智能手表通道配置列表</td> </tr> <tr> <td style="text-align: left;">title</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>标题或描述</td> </tr> <tr> <td style="text-align: left;">msgType</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>消息类型 YY = 吃药提醒 XY=血压测量提醒 XT=血糖测量提醒 YD=运动提醒 CF=处方提醒 HJ=患教推送</td> </tr> <tr> <td style="text-align: left;">sqlQuery</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String</td> <td>自定义SQL</td> </tr> <tr> <td style="text-align: left;">messageTitle</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>通知标题</td> </tr> <tr> <td style="text-align: left;">content</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>内容</td> </tr> <tr> <td style="text-align: left;">imChannelList</td> <td style="text-align: left;">否</td> <td style="text-align: left;">list</td> <td>IM消息通道配置列表</td> </tr> <tr> <td style="text-align: left;">title</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>标题或描述</td> </tr> <tr> <td style="text-align: left;">sendBy</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>消息发送人类型,2=医生 4=患者 5=家属</td> </tr> <tr> <td style="text-align: left;">sendTo</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>消息接收人类型 2=医生 4=患者 5=家属</td> </tr> <tr> <td style="text-align: left;">msgType</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>消息类型, TXT=文本 SGXY=首关注册服务宣誓...</td> </tr> <tr> <td style="text-align: left;">sqlQuery</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String</td> <td>自定义SQL</td> </tr> <tr> <td style="text-align: left;">syncMachine</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>消息同步</td> </tr> <tr> <td style="text-align: left;">callback</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>是否微信回调,0=否 1=是</td> </tr> <tr> <td style="text-align: left;">content</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>消息内容</td> </tr> </tbody> </table> <p><strong>请求示例</strong></p> <pre><code>{ "code": "PATIENT_JOIN_GROUP11", "name": "患者入医生组", "description": "患者成功加入医生组,给患者IM推送服务宣誓词和咨询提醒,给医生推送绑定消息", "beanName": null, "methodName": null, "sqlQuery": "select a.patient_name patientName, c.openid openid_100, b.doctor_name doctorName, d.openid openid_101 from patient_info a, doctor_info b, user_platform_info c, user_platform_info d where a.patient_id = c.user_id and c.platform = '100' and b.doctor_id = d.user_id and d.platform = '101' and a.patient_id = ${patientId} and b.doctor_id = ${doctorId}", "wxChannelList": [ { "title": "给患者发送咨询提醒", "platform": "100", "templateId": 1056, "sqlQuery": null, "linkUrl": "${serverDomain}/patient/#/chat?userId=D${doctorId}", "miniProgram": null, "pagePath": null, "details": [ { "keyword": "first", "value": "您有1条未读消息!", "color": "#173177" }, { "keyword": "keyword1", "value": "${doctorName}向您发起了在线对话", "color": "#173177" }, { "keyword": "keyword2", "value": "${currentTime}", "color": "#173177" }, { "keyword": "remark", "value": "↓点击“详情”查看对话并回复医生!", "color": "#173177" } ] } ], "smsChannelList": [ { "title": "发送短信验证码", "templateId": 1014, "sqlQuery": null, "details": [ { "channelId": null, "keyword": "code", "value": "${code}", "color": null } ] } ], "vmsChannelList": [ { "title": "手表SOS", "templateId": 1014, "sqlQuery": null, "details": [ { "keyword": "name", "value": "${patientName}!" }, { "keyword": "time", "value": "${date}" }, { "keyword": "address1", "value": "${address1}" }, { "keyword": "address2", "value": "${address2}" } ] } ], "sysChannelList": [ { "title": "给医生插入系统通知", "sendTo": "2", "msgType": "TZ", "sqlQuery": null, "linkUrl": "/pages/patient/patientDetail?patientId=${patientId}", "messageTitle": "${patientName}已经绑定成为您的患者!", "messageDesc": "内容:${patientName}已经绑定成为您的患者!;时间:${currentTime}", "messageRemark": "请帮ta尽早恢复健康!" } ], "kfChannelList": [ { "title": "注册成功通知", "sendTo": "100", "sqlQuery": null, "content": "您的积分已存入您的账户,可在&lt;a href='${serverDomain}/patient/#/mine'&gt;个人中心&lt;/a&gt;查看,您成功和${doctorName}${jobTitle:-}建立了医患关系,可以享受${doctorName}${jobTitle:-}提供的以下服务:\n\n1、免费咨询绑定医生,记录监测指标\n&lt;a href='${serverDomain}/patient/#/mydoctor01'&gt;→免费咨询医生&lt;/a&gt;\n&lt;a href='${serverDomain}/patient/#/monitor'&gt;→日常健康监测&lt;/a&gt;\n\n2、完成任务获得现金、积分,用积分抵扣商城购物更划算\n&lt;a href='${serverDomain}/patient/#/task'&gt;→完成每日任务&lt;/a&gt;\n&lt;a href='https://h5.youzan.com/wscump/multistore/index?kdt_id=42975919'&gt;→进入健康商城&lt;/a&gt;\n\n3、查看医院检测结果\n&lt;a href='${serverDomain}/patient/#/healthReportList'&gt;→查看体检报告&lt;/a&gt;\n\n如需获取使用帮助,请点击查看视频\n&lt;a href='${serverDomain}/patient/#/static/welcome.html'&gt;→查看操作指导&lt;/a&gt;" } ], "tochChannelList": [ { "title": "天气播报", "sqlQuery": null, "content": "早上好${patientName},今天是${date},今天${city}的天气是${weather}" } ], "watchChannelList": [ { "title": "提醒患者吃药", "msgType": "YY", "sqlQuery": null, "messageTitle": "吃药提醒", "content": "您的主管医生${assistPrefix:-}${doctorName}提醒您按时服药,${period}服用${durgName},请在${durgTime}前后一个小时服用,祝您身体健康。" } ], "imChannelList": [ { "title": "医生给患者发送IM消息", "sendBy": "2", "sendTo": "4", "msgType": "TXT", "sqlQuery": null, "syncMachine": "1", "callback":"0", "content": "您好,我是您的主管医生,非常荣幸为您提供健康管理服务,希望您在我的管理下身体越来越健康,您有任何疑问,都可以在这里咨询我!" } ] }</code></pre> <p><strong>返回示例</strong></p> <pre><code>{ "retcode": "0000", "errMsg": "操作成功", "body": null }</code></pre> <p><strong>返回参数说明</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">retcode</td> <td style="text-align: left;">string</td> <td>0000=成功,其他=失败</td> </tr> <tr> <td style="text-align: left;">errMsg</td> <td style="text-align: left;">string</td> <td>错误信息</td> </tr> </tbody> </table> <p><strong>备注</strong> </p> <ul> <li>更多返回错误代码请看首页的错误代码描述</li> </ul>

页面列表

ITEM_HTML