分页说明
请求参数
start: int 请求数据开始位置,从0开始,默认为0
limit: int 每次请求条数,默认10,最大50
返回参数
total: int 结果集总条数
items: array 结果集
同步合作方用户
Api Id:syncUser
业务参数
| 字段 | 类型 | 描述 | 必需 |
|---|---|---|---|
| userId | string(64) | 合作方用户标识(由合作方指定) | 是 |
| cellphone | string | 手机号,将作为医联登录手机号(请合作方与医联确认) | 否 |
| nickName | string | 昵称 | 否 |
| avatar | string | 头像URL | 否 |
| withToken | int | 是否需要获取授权令牌,1是,0否 | 否 |
输出 当withToken为1时返回如下令牌信息,否则返回null
| 字段 | 类型 | 描述 |
|---|---|---|
| authToken | string | 令牌 |
| authUrl | string | 授权的基础地址,合作方需手动拼接链接参数,格式:https://passport.medlinker.com/auth/token?redirectUrl={授权回调页,需URLEncode}&authToken={令牌} |
| expire | int | 过期时间(秒),合作方可根据过期时间适当缓存令牌 |
发布问诊 调用任何问诊接口前,需先同步合作方用户(同一用户只需同步一次) 同步合作方用户
Api Id:create
业务参数
| 字段 | 类型 | 描述 | 必需 |
|---|---|---|---|
| userId | string(64) | 合作方用户标识(由合作方指定) | 是 |
| patientPhone | string | 患者手机号 | 否 |
| patientGender | int | 患者性别:1男,2女,0未设置 | 否 |
| patientAge | int | 患者年龄 | 否 |
| question | string | 病情描述 | 是 |
| price | int | 问诊费用(单位分),默认0 | 否 |
| files | string | 图片url列表,JSON数组,[“url1”, “url2”, …],图片限制为10张 | 否 |
输出
| 字段 | 类型 | 描述 |
|---|---|---|
| inquiryId | int | 问诊Id |
支付问诊
Api Id:pay
业务参数
| 字段 | 类型 | 描述 | 必需 |
|---|---|---|---|
| userId | string(64) | 合作方用户标识(由合作方指定) | 是 |
| inquiryId | int | 问诊ID | 是 |
| amount | int | 支付金额(单位分) | 是 |
输出 无
问诊退款
Api Id:refund
业务参数
| 字段 | 类型 | 描述 | 必需 |
|---|---|---|---|
| userId | string | 合作方用户标识(由合作方指定) | 是 |
| inquiryId | int | 问诊ID | 是 |
| amount | int | 退款金额(单位分) | 是 |
| reason | string | 退款原因 | 是 |
输出 无
发送会话消息
问诊列表
Api Id:list
业务参数
| 字段 | 类型 | 描述 | 必需 |
|---|---|---|---|
| userId | string(64) | 合作方用户标识(由合作方指定) | 是 |
| 分页参数 | / | 参考:分页说明 | 否 |
输出 数组
| 字段 | 类型 | 描述 | |
|---|---|---|---|
| inquiryId | int | 问诊Id | |
| patientPhone | string | 患者手机 | |
| patientGender | string | 患者性别:男,女,未设置 | 否 |
| patientAge | int | 患者年龄 | |
| question | string | 问题 | |
| answer | string | 解答 | |
| section | string | 归属科室名称 | |
| parentSection | string | 归属父级科室名称 | |
| insertTime | int | 问诊发布时间 | |
| status | int | 问诊状态,参考问诊状态关系映射 | |
| statusText | string | 问诊状态文案 | |
| doctorName | string | 医生姓名 | |
| doctorAvatar | string | 医生头像URL | |
| doctorHospital | string | 医生医院名称 | |
| doctorTitle | string | 医生职称名称 | |
| doctorSection | string | 医生科室名称 | |
| parentId | int | 上次问诊Id(复诊时有效,否则为0) | |
| type | int | 问诊类型,参考问诊类型关系映射 | |
| typeText | string | 问诊类型名称 | |
| files | array | 文件列表 | |
| files[x].url | string | 文件URL | |
| files[x].type | int | 文件类型:1患者文件 |
问诊详情
Api Id:detail
业务参数
| 字段 | 类型 | 描述 | 必需 |
|---|---|---|---|
| userId | string(64) | 合作方用户标识(由合作方指定) | 是 |
| inquiryId | int | 问诊ID | 是 |
输出
| 字段 | 类型 | 描述 | |
|---|---|---|---|
| inquiryId | int | 问诊Id | |
| patientPhone | string | 患者手机 | |
| patientGender | string | 患者性别:男,女,未设置 | 否 |
| patientAge | int | 患者年龄 | |
| question | string | 问题 | |
| answer | string | 解答 | |
| section | string | 归属科室名称 | |
| parentSection | string | 归属父级科室名称 | |
| insertTime | int | 问诊发布时间 | |
| status | int | 问诊状态,参考问诊状态关系映射 | |
| statusText | string | 问诊状态文案 | |
| doctorName | string | 医生姓名 | |
| doctorAvatar | string | 医生头像URL | |
| doctorHospital | string | 医生医院名称 | |
| doctorTitle | string | 医生职称名称 | |
| doctorSection | string | 医生科室名称 | |
| parentId | int | 上次问诊Id(复诊时有效,否则为0) | |
| type | int | 问诊类型,参考问诊类型关系映射 | |
| typeText | string | 问诊类型名称 | |
| files | array | 文件列表 | |
| files[x].url | string | 文件URL | |
| files[x].type | int | 文件类型:1患者文件 |
关闭问诊 注意:此操作会通知医生去创建解答意见,在医生创建解答之前解答意见为空串
Api Id:close
业务参数
| 字段 | 类型 | 描述 | 必需 |
|---|---|---|---|
| userId | string(64) | 合作方用户标识(由合作方指定) | 是 |
| inquiryId | int | 问诊ID | 是 |
| reason | string | 关闭原因 | 是 |
输出 无
复诊
Api Id:again
业务参数
| 字段 | 类型 | 描述 | 必需 |
|---|---|---|---|
| userId | string(64) | 合作方用户标识(由合作方指定) | 是 |
| inquiryId | int | 问诊ID | 是 |
| question | string | 复诊的内容 | 是 |
| files | string | 图片url列表,JSON数组,[“url1”, “url2”, …],图片限制为10张 | 否 |
| price | int | 问诊费用(单位分),默认0 | 否 |
输出
| 字段 | 类型 | 描述 |
|---|---|---|
| inquiryId | int | 问诊Id,此问诊与前问诊的解答医生相同,并且处于解答中的状态 |
会话聊天记录
Api Id:msgHistory
业务参数
| 字段 | 类型 | 描述 | 必需 |
|---|---|---|---|
| userId | string(64) | 合作方用户标识(由合作方指定) | 是 |
| inquiryId | int | 问诊ID | 是 |
| startKey | string | 起始位置。每一页数据会返回下一页的起始位置。取第一页时可以不传。或者传null. | 可选 |
| startScore | int | 起始排序值。每一页数据会返回下一页的起始位置。取第一页时传0 | 是 |
| limit | int | 分页数量。默认为10 | 否 |
| sort | int | 排序。0:正序 1:倒序。默认 0 | 否 |
输出
| 字段 | 类型 | 描述 |
|---|---|---|
| startKey | string | 下一页的起始位置 |
| startScore | int | 下一页的起始排序值 |
| list | array | 历史消息对象 |
医生列表
Api Id: doctorList
业务参数
| 字段 | 类型 | 描述 | 必需 |
|---|---|---|---|
| 分页参数 | / | 参考:分页说明 | 否 |
输出 数组
| 字段 | 类型 | 描述 |
|---|---|---|
| doctorId | int | 医生用户Id |
| name | string | 姓名 |
| hospital | string | 医院名称 |
| section | string | 二级科室名称 |
| parentSection | string | 一级科室名称 |
| avatar | string | 头像 |
| title | string | 职称 |
医生详情
Api Id:doctorDetail
业务参数
| 字段 | 类型 | 描述 | 必需 |
|---|---|---|---|
| doctorId | int | 医生Id | 是 |
输出 数组
| 字段 | 类型 | 描述 |
|---|---|---|
| doctorId | int | 医生用户Id |
| name | string | 姓名 |
| hospital | string | 医院名称 |
| section | string | 二级科室名称 |
| parentSection | string | 一级科室名称 |
| avatar | string | 头像 |
| title | string | 职称 |
| intro | string | 简介 |
| skills | array | 擅长,可能有多条 |
| workplaces | array | 执业地点,可能有多条 |