医联 . 开放平台

问诊API

  • 分页说明

    • 请求参数

      • start: int 请求数据开始位置,从0开始,默认为0

      • limit: int 每次请求条数,默认10,最大50

    • 返回参数

      • total: int 结果集总条数

      • items: array 结果集

  • 同步合作方用户

    • Api Id:syncUser

    • 业务参数

      字段类型描述必需
      userIdstring(64)合作方用户标识(由合作方指定)
      cellphonestring手机号,将作为医联登录手机号(请合作方与医联确认)
      nickNamestring昵称
      avatarstring头像URL
      withTokenint是否需要获取授权令牌,1是,0否
    • 输出 当withToken为1时返回如下令牌信息,否则返回null

      字段类型描述
      authTokenstring令牌
      authUrlstring授权的基础地址,合作方需手动拼接链接参数,格式:https://passport.medlinker.com/auth/token?redirectUrl={授权回调页,需URLEncode}&authToken={令牌}
      expireint过期时间(秒),合作方可根据过期时间适当缓存令牌
  • 发布问诊 调用任何问诊接口前,需先同步合作方用户(同一用户只需同步一次) 同步合作方用户

    • Api Id:create

    • 业务参数

      字段类型描述必需
      userIdstring(64)合作方用户标识(由合作方指定)
      patientPhonestring患者手机号
      patientGenderint患者性别:1男,2女,0未设置
      patientAgeint患者年龄
      questionstring病情描述
      priceint问诊费用(单位分),默认0
      filesstring图片url列表,JSON数组,[“url1”, “url2”, …],图片限制为10张
    • 输出

      字段类型描述
      inquiryIdint问诊Id
  • 支付问诊

    • Api Id:pay

    • 业务参数

      字段类型描述必需
      userIdstring(64)合作方用户标识(由合作方指定)
      inquiryIdint问诊ID
      amountint支付金额(单位分)
    • 输出

  • 问诊退款

    • Api Id:refund

    • 业务参数

      字段类型描述必需
      userIdstring合作方用户标识(由合作方指定)
      inquiryIdint问诊ID
      amountint退款金额(单位分)
      reasonstring退款原因
    • 输出

  • 发送会话消息

    • Api Id:sendMsg

    • 业务参数

      字段类型描述必需
      userIdstring(64)合作方用户标识(由合作方指定)
      inquiryIdint问诊ID
      objectNamestring消息类型 见消息定义
      contentobject消息体(json对象)见消息定义
      channelTypestring会话类型
    • 输出

  • 问诊列表

    • Api Id:list

    • 业务参数

      字段类型描述必需
      userIdstring(64)合作方用户标识(由合作方指定)
      分页参数/参考:分页说明
    • 输出 数组

      字段类型描述
      inquiryIdint问诊Id
      patientPhonestring患者手机
      patientGenderstring患者性别:男,女,未设置
      patientAgeint患者年龄
      questionstring问题
      answerstring解答
      sectionstring归属科室名称
      parentSectionstring归属父级科室名称
      insertTimeint问诊发布时间
      statusint问诊状态,参考问诊状态关系映射
      statusTextstring问诊状态文案
      doctorNamestring医生姓名
      doctorAvatarstring医生头像URL
      doctorHospitalstring医生医院名称
      doctorTitlestring医生职称名称
      doctorSectionstring医生科室名称
      parentIdint上次问诊Id(复诊时有效,否则为0)
      typeint问诊类型,参考问诊类型关系映射
      typeTextstring问诊类型名称
      filesarray文件列表
      files[x].urlstring文件URL
      files[x].typeint文件类型:1患者文件
  • 问诊详情

    • Api Id:detail

    • 业务参数

      字段类型描述必需
      userIdstring(64)合作方用户标识(由合作方指定)
      inquiryIdint问诊ID
    • 输出

      字段类型描述
      inquiryIdint问诊Id
      patientPhonestring患者手机
      patientGenderstring患者性别:男,女,未设置
      patientAgeint患者年龄
      questionstring问题
      answerstring解答
      sectionstring归属科室名称
      parentSectionstring归属父级科室名称
      insertTimeint问诊发布时间
      statusint问诊状态,参考问诊状态关系映射
      statusTextstring问诊状态文案
      doctorNamestring医生姓名
      doctorAvatarstring医生头像URL
      doctorHospitalstring医生医院名称
      doctorTitlestring医生职称名称
      doctorSectionstring医生科室名称
      parentIdint上次问诊Id(复诊时有效,否则为0)
      typeint问诊类型,参考问诊类型关系映射
      typeTextstring问诊类型名称
      filesarray文件列表
      files[x].urlstring文件URL
      files[x].typeint文件类型:1患者文件
  • 关闭问诊 注意:此操作会通知医生去创建解答意见,在医生创建解答之前解答意见为空串

    • Api Id:close

    • 业务参数

      字段类型描述必需
      userIdstring(64)合作方用户标识(由合作方指定)
      inquiryIdint问诊ID
      reasonstring关闭原因
    • 输出

  • 复诊

    • Api Id:again

    • 业务参数

      字段类型描述必需
      userIdstring(64)合作方用户标识(由合作方指定)
      inquiryIdint问诊ID
      questionstring复诊的内容
      filesstring图片url列表,JSON数组,[“url1”, “url2”, …],图片限制为10张
      priceint问诊费用(单位分),默认0
    • 输出

      字段类型描述
      inquiryIdint问诊Id,此问诊与前问诊的解答医生相同,并且处于解答中的状态
  • 会话聊天记录

    • Api Id:msgHistory

    • 业务参数

      字段类型描述必需
      userIdstring(64)合作方用户标识(由合作方指定)
      inquiryIdint问诊ID
      startKeystring起始位置。每一页数据会返回下一页的起始位置。取第一页时可以不传。或者传null.可选
      startScoreint起始排序值。每一页数据会返回下一页的起始位置。取第一页时传0
      limitint分页数量。默认为10
      sortint排序。0:正序 1:倒序。默认 0
    • 输出

      字段类型描述
      startKeystring下一页的起始位置
      startScoreint下一页的起始排序值
      listarray历史消息对象
  • 医生列表

    • Api Id: doctorList

    • 业务参数

      字段类型描述必需
      分页参数/参考:分页说明
    • 输出 数组

      字段类型描述
      doctorIdint医生用户Id
      namestring姓名
      hospitalstring医院名称
      sectionstring二级科室名称
      parentSectionstring一级科室名称
      avatarstring头像
      titlestring职称
  • 医生详情

    • Api Id:doctorDetail

    • 业务参数

      字段类型描述必需
      doctorIdint医生Id
    • 输出 数组

      字段类型描述
      doctorIdint医生用户Id
      namestring姓名
      hospitalstring医院名称
      sectionstring二级科室名称
      parentSectionstring一级科室名称
      avatarstring头像
      titlestring职称
      introstring简介
      skillsarray擅长,可能有多条
      workplacesarray执业地点,可能有多条