大白云诊-商务代表公众号接口文档.docx

商务代表公众号接口文档版本号：1.3文档编号：Change HistoryDateVerChange TypeChange DescriptionsPerson2015-06-131.0Create创建文档。fang2015-06-171.1Add补充文档fang2015-06-211.3Add补充修改文档fang2015-03-242.3.0Add添加医生积分列表接口3.2.2刘德龙目录Change History11.引言42.接口规范42.1.协议42.2.地址42.3.公共参数42.4.返回值43.接口详细说明53.1.登录页53.1.1.发送验证码(注册/忘记密码)53.1.2.商务代表注册53.1.3.判断微信用户是否注册63.2.医生管理73.2.1.医生列表73.2.2.提醒医生补充资料73.3.我的积分83.3.1.获取积分信息83.3.2.申请提现83.3.3.个人银行卡列表93.3.4.系统已支持银行列表103.3.5.银行卡录入103.3.6.积分历史记录113.3.7.积分详情(注册)113.3.8.提现记录123.4.个人中心133.4.1.个人基本信息查询133.4.2.个人基本信息修改143.4.3.城市字典查询143.4.4.获取用户二维码154.附录154.1.关于异常状态码定义的建议151. 引言本文档用于描述商务代表微信公众号服务接口规范，主要包括：网络传输协议、数据传输协议,参数及返回值说明等内容。2. 接口规范2.1. 协议接口基于HTTP协议，支持GET/POST请求，以JSON格式返回数据。2.2. 地址接口地址为(测试)：http:/ab.7lk.me接口地址为(正式)：2.3. 公共参数参数名参数含义必选取值_p平台Y1：andorid / 2：iphone_v客户端版本号Y格式：x.x.x例如：1.0.0_m设备的mac地址Y_cJSONP的回调函数名N说明：如上参数为公共参数，请在Http Header中传递2.4. 返回值返回值的基本结构如下：code:,“msg”:”, data:,返回值结构描述属性含义取值code本次请求状态码0：表示成功；其他数字表示异常。msg状态码对应的信息状态码对应的提示信息。data业务相关数据JSON数组。不同接口返回的JSON数据对象3. 接口详细说明3.3.1. 登录页.3.1.1. 发送验证码(注册/忘记密码)描述用户在注册或忘记密码时需要发送手机验证码进行认证，调此接口进行验证码下发(注：发送失败情况可能存在示例情况：今日发送量已达上限/运营商业务繁忙 等)。地址/businessRegist?method=sendVerificCode参数参数名类型必须备注phoneNumY用户输入手机号码typeY功能类型(1/注册；2/修改手机号；3/.。功能类型不同生成规则不同)方法POST响应成功data: ,msg: success,code: 0消息提示：success；(示例：发送失败/)结果码：0/发送成功；非0(1,2,3)/失败失败code的值不为0的时候，请直接显示msg的值备注3.1.2. 商务代表注册描述点击小七联盟公众号注册图注册新用户注册用户用户在此页面输入姓名、手机号、验证码、推荐号，之后点击注册调用此接口进行用户注册。地址/businessRegist?method=reg参数参数名类型必须备注nameY用户真实姓名(长度不能超过10)phoneNumY手机号verifyCodeY验证码(用户点击获取验证码通过手机收到)recommendNumN商务推荐号(商务人员自有)(非必须项)openIdY微信openId(openId+unionId加密串)headUrlY商务代表头像sourceTypeY此医药代表来源(1/医药代表发展而来，下面的parentId表示父级ID)；2/其他来源parentIdN父级ID(此商务代表是被此ID对应商务代表发展而来)isOldY是否扫描1.0二维码(0/2.0二维码;1/1.0二维码)partnerIdY公司ID方法POST响应成功data: ,msg: success,code: 0消息提示：(示例：验证码错误/手机号不规则)结果码：0/成功；非0(1,2,3)/失败失败code的值不为0的时候，请直接显示msg的值备注3.1.3. 获取商务代表分享页面基本信息描述使用商务代表ID获取商务代表分享页面基本信息地址/businessRegist?method=getShareInfo参数参数名类型必须备注unionIdN商务代表对应微信unionId(参数type=2时此项为必填项)businessIdN商务代表ID(此参数与openId有一个不为空即可)typeY分享类型(1/代表推代表；2/代表推医生+代表推医生微信端)方法POST响应成功 code: 0, msg: 成功, data: id: 1040, headUrl: http:/wx., realName: 魏磊, shareUrl: *,shareWUrl:* 商务代表ID头像地址姓名分享二维码图片地址：商代发展好友二维码/商代发展医生APP二维码分享二维码图片地址：商代发展医生微信端二维码(type=1时此节点为null)失败code的值不为0的时候，请直接显示msg的值备注3.1.4. 判断微信用户是否注册描述使用微信标识号码判断用户是否已经注册地址/businessRegist?method=isReg参数参数名类型必须备注unionIdY微信用户unionId方法POST响应成功 code: 114, msg: 用户已注册, data: id: 1281, realName: 李芳, phoneNum: 186820553, recommendNum: , company: , areaName: 铜陵, cityId: 48, openId: oKtMFsz , createdAt: 2015-05-2., updatedAt: 2015-05-2., sourceType: 0, parentId: 0, businessType: 0, accountStatus: 0, headUrl: http:/wx.q., bsToBsUrl: , bsToDrUrl: , unionId: o9sI3t0 结果码：113/未注册，data节点为空；114/此微信已经注册，data节点返回已注册账户信息；非0,1(2,3)/失败消息提示：(示例：验证码错误/手机号不规则)商务代表ID真实姓名手机号推荐号公司名称地区名称地区ID微信openId创建时间更新时间此医药代表来源(1/医药代表发展而来，下面的parentId表示父级ID)；2/其他来源父级商务代表ID商务代表类型(1,商务代表；2,商务经理)账号状态：0,正常；1,禁用商务代表头像链接商务代表推荐商务代表微信短链接地址商务代表推荐医生二维码链接地址微信union_id，唯一标识失败code的值不为0的时候，请直接显示msg的值备注3.1.5. 公司列表描述用户注册过程中选择的公司地址参数参数名类型必须备注方法GET/POST响应成功data: partnerId: 10001,partnerName:步长 ,msg: success,code: 0编号公司名称失败code的值不为0的时候，请直接显示msg的值备注3.2. 医生管理.1. 医生列表描述医生管理医生列表(商务代表自己发展的医生列表)地址/doctorManager?method=doctorListOfBus参数参数名类型必须备注businessIdY商务代表idpageY页码numN每页记录数（不填默认）2方法GET/POST响应成功data: result: name: 张三,status:0,titleId:2,departmentId:35,hospitalId:2598headUrl:http/XXX,totalPoint:200,patientNum:20,goodAssessNum:10,titleName:主任,deparementName:外,hospitalName:二院 , totalCount: 1, totalPages: 1 ,msg: success,code: 0姓名认证状态0:未认证,1:已认证,2:未通过3:再次申请认证职级。0医师，1副主任医师，2主任医师，3主治医师，4主院医师部门id医院ID，0代表其他头像地址总积分数患者数好评数职级。0医师，1副主任医师，2主任医师，3主治医师，4主院医师部门名称医院名称总记录数据总页数消息提示：success，(示例：未知错误 /)结果码：0/成功；非0(1,2,3)/失败失败code的值不为0的时候备注3.2.2. 新版医生列表描述2.3.0版新增医生列表地址/doctorManager/doctorList参数参数名类型必须备注businessIdY商务代表idpageY页码numN每页记录数（不填默认）方法GET/POST响应成功 code: 0, msg: 成功, data: pageNo: 1, pageSize: 10, orderBy: null, order: null, result: list: name: 张三, headUrl: http:/123., lastLoginTime: 2016-03-28., departmentId: 35, departmentName: 儿科, titleId: 2, titleName: 主任, hospitalId: 2598, hospitalName: 二院, status: 0, point: 20, patientNum: 12, orderNum: 2 , waitAuthNum: 20, authSuccNum: 20, authFailNum: 20, authAgainNum: 20, waitSubmitNum: 20, infoNotfullNum: 20 , totalCount: 2, first: 0, orderBySetted: false, totalPages: 1, hasNext: false, nextPage: 1, hasPre: false, prePage: 1 姓名头像地址上次登录时间科室ID科室名称职称ID职称名称医院ID医院名称状态(认证状态0:未认证,1:已认证,2:未通过3:再次申请认证;4未提交资料)积分患者数订单数待审核医生数审核通过医生数审核不通过医生数再次申请审核医生数资料未提交医生数资料未完善医生数失败code的值不为0的时候备注3.2.3. 医生积分列表描述医生积分列表地址/business/doctor/pointList参数参数名类型必须备注doctorIdLongY医生idyearIntegerN年份monthsIntegerN月数pageY页码numN每页记录数（不填默认）方法POST响应成功 code: 0, msg: 成功, data: pageNo: 1, pageSize: 10, orderBy: null, order: null, result: list: pointDesc: “药事服务”, orderSn: 2312334444444 , point : 200, createAt: 12-12, totalPoint: 500, pointStatus : “可提现” ,pointPerMonth: occurTime: 500 , “totalPoint”:1000,“applyingPoint”: “500”，“totalAppliedPoint”:”55” , totalCount: 2, first: 0, orderBySetted: false, totalPages: 1, hasNext: false, nextPage: 1, hasPre: false, prePage: 1 返回状态提示信息当前页码每页记录数积分来源订单号积分变动(+获得,-减少)变动日期所属月份总积分积分状态occurTime为可变key，值为年月份总积分可提现积分累计提现总记录数失败code的值不为0的时候，请直接显示msg的值备注3.2.4. 医生订单列表描述医生订单列表地址/business/order/doctorOrderList参数参数名类型必须备注doctorIdLongY医生idpageIntegerN页数numIntegerN每页记录数方法POST响应成功 code: 0, msg: 成功, data: pageNo: 1, pageSize: 10, orderBy: null, order: null, result: list: recomDrugNum: 10, orderId: 123456, orderTime: 2016-03-28, status: 已下单 , recomTimes: 20, orderNum: 20, recomOrderRate: 20, orderNumCount: 201603: 10, 201602: 10, 201601: 10, 201512: 10, 201511: 10, 201510: 10 , totalCount: 2, first: 0, orderBySetted: false, totalPages: 1, hasNext: false, nextPage: 1, hasPre: false, prePage: 1 返回状态提示信息推荐药品数订单号下单时间订单状态总推荐次数下单数推荐下单转换率月份推荐次数失败code的值不为0的时候，请直接显示msg的值备注3.2.5. 医生订单详情描述医生列表订单详情地址/business/order/doctorOrderInfo参数参数名类型必须备注orderIdY订单ID方法GET/POST响应成功 code: 0, msg: 成功, data: time: 2016-03-08, status: 已发货, info: courierNum: 3, courierCompany: 顺丰快递 , time: 2016-03-08, status: 已下单 时间状态快递单号快递公司失败code的值不为0的时候，请直接显示msg的值备注3.2.6. 新版医生详情描述医生详情地址/doctorManager/doctorInfo参数参数名类型必须备注doctorIdY医生ID方法GET/POST响应成功 code: 0, msg: 成功, data: doctorId: 123, phoneFile: http:/11, emCardFile: http:/11, vocateFile: http:/11, name: 张三, gender: 1, hospitalId: 123, hospitalName: 协和医院, departmentId: 123, departmentName:内科, title: 主任医师, consult: weekIndex: 1, am: 0, pm: 1, night: 0 , weekIndex: 1, am: 0, pm: 1, night: 0 , expertise: 擅长, introduction: 个人简介 医生ID头像工作证执业资格证姓名性别(0,女；1,男)医院ID医院名称科室ID科室名称职称出诊时间擅长个人简介失败code的值不为0的时候，请直接显示msg的值备注3.3. 我的积分...3.3.1. 获取积分信息描述我的积分-积分统计地址/pointBussiness?method=getAllPointInfo参数参数名类型必须备注businessIdY商务代表ID方法GET/POST响应成功code: 0,msg: success,data: canMentionPoint: 500,totalPoint:800,grandMention: 1000,isBindBankCard:1,businessType:1 可提现积分账户总积分累计提现是否绑定银行卡(1/是；2/否)商务代表类型(1,商务代表；2,商务经理)失败code的值不为0的时候，请直接显示msg的值备注3.3.2. 申请提现基本信息查询描述我的积分-提现-提现确认页地址/pointBussiness?method=getBalanceApply参数参数名类型必须备注businessIdY商务代表ID方法POST响应成功 code: 0, msg: 成功, data: businessId: 1001, extraMoney: 5, point: 500,businessType:1 商务代表ID提现金额提现积分商务代表类型(1,商务代表；2,商务经理)失败code的值不为0的时候，请直接显示msg的值备注3.3.3. 申请提现描述我的积分-提现地址/pointBussiness?method= applyBalancePoint参数参数名类型必须备注businessIdY商务代表IDmentionMonY提现金额(元为单位)bankCardIdY关联银行卡表ID方法POST响应成功data: ,msg: success,code: 0消息提示：success；(示例：提示失败/)结果码：0/申请成功；非0(1,2,3)/失败30556/所选银行卡缺少支行信息失败code的值不为0的时候，请直接显示msg的值备注3.3.4. 设置默认银行卡描述我的积分-提现地址/personCenter?method=setDefaultCard参数参数名类型必须备注businessIdY商务代表IDidY银行卡记录ID方法POST响应成功data: ,msg: success,code: 0消息提示：success；(示例：提示失败/)结果码：0/申请成功；非0(1,2,3)/失败失败code的值不为0的时候，请直接显示msg的值备注3.3.5. 个人银行卡列表描述我的积分-提现页面-点击提现-点击储蓄卡出可选银行卡列表地址/personCenter?method=getBankListOfBus参数参数名类型必须备注userIdY用户编号userTypeY用户类型(0,商务代表；1,医生.)方法GET/POST响应成功 code: 0, msg: 成功, data: list: id: 48, userId: 1, name: 魏磊, bankName: 招商银行, bankCardNum: 62*1,bankId: 1, createdAt: 2015-07.,bCode: , isDefault: 1,branch:中关村支行 , applyVo: businessId: 1, extraMoney: 200, point: 2000, businessType: null,existCardId:1 记录ID商务代表ID商务代表名称银行名称银行卡号银行ID创建时间开户行编号是否默认银行卡(0/否;1/是)支行信息商务代表ID提现金额(元为单位)提现积分数商务代表类型(1,商务代表；2,商务经理)是否存在身份证号码(1,存在；2,不存在)失败code的值不为0的时候，请直接显示msg的值备注3.3.6. 系统已支持银行列表描述用户新增银行卡过程中选择使用地址/personCenter?method=getSupportBankList参数参数名类型必须备注方法GET/POST响应成功data: bId: 10001,bCode:,bName: 100.00,createdAt:20150616 ,msg: success,code: 0编号开户行编号银行名称创建时间失败code的值不为0的时候，请直接显示msg的值备注3.3.7. 银行卡录入描述我的积分-提现页面-点击提现-点击储蓄卡里的使用新卡-添加用户新的银行卡地址/personCenter?method=addPersonBankCard参数参数名类型必须备注userIdY用户ID(医生ID，或商务代表ID)nameY用户真实姓名bIdY银行编号()bankCardNumY银行卡号userTypeY用户类型(0,商务代表；1,医生.)branchY银行卡支行信息方法POST响应成功 code: 0, msg: 成功, data: id: 392 消息提示：success；(示例：录入失败/)结果码：0/录入成功；非0(1,2,3)/失败30507/用户不能绑定重复银行卡银行卡记录ID失败code的值不为0的时候，请直接显示msg的值备注3.3.8. 解除银行卡绑定描述个人中心-基本信息-编辑银行卡地址/personCenter?method=delPersonBankCard参数参数名类型必须备注userIdY用户ID(医生ID，或商务代表ID)idY银行卡记录ID方法POST响应成功data: ,msg: success,code: 0消息提示：success；(示例：录入失败/)结果码：0/录入成功；非0(1,2,3)/失败失败code的值不为0的时候，请直接显示msg的值备注3.3.9. 积分历史记录描述我的积分-积分历史记录地址/pointBussiness?method=getIntegral参数参数名类型必须备注businessIdY商务代表IDpageY页码numN每页记录数（不填默认）方法GET/POST响应成功 code: 0, msg: 成功, data: pageNo: 1, pageSize: 10, orderBy: null, order: null, result: id: 38, businessId: 1388, integralNum: 500, actionType: 1, actionId: 23, status: 1, createdAt: 2015-07-04 12:27:24 , totalCount: 1, orderBySetted: false, totalPages: 1, hasNext: false, nextPage: 1, hasPre: false, prePage: 1, first: 0 积分记录ID商务代表ID累计积分数操作类型(1,商务代表推荐商务代表；2,商务代表推荐医生；3,推荐的商务代表下面的医生下面的患者买药；4,提现；20,积分调整)操作ID积分状态(0,冻结；1,可提现；2，申请提现；3，已提现；4,已到账，5.废单）创建时间失败code的值不为0的时候，请直接显示msg的值备注积分历史记录列表前端文字显示规则：1、actionType=1,好友分享： a)、status=0:待确认 b)、status=1:可提现 c)、status=2:提现中 d)、status=3:已提现2、actionType=2，添加医生： a)、status=0:待确认 b)、status=1:可提现 c)、status=2:提现中 d)、status=3:已提现3、actionType=3，药事服务： a)、status=0:预计7天后可提现 b)、status=1:可提现 c)、status=2:提现中 d)、status=3:已提现 e)、status=5:积分无效4、actionType=4，积分提现： a)、统一显示“提现”3.3.10. 商务代表药事服务积分详情描述我的积分-积分历史记录-药事服务积分详情地址/pointBussiness?method=getOrderInteDetail参数参数名类型必须备注idY药事积分记录ID方法GET/POST响应成功 code: 0, msg: 成功, data: id: 1, point: 123, createdAt: 2015-06., changedAt: 2015-06., orderId: 60675, orderAmount: 123, orderStatus: 1,status:0 药事积分记录积分数创建时间修改时间订单ID订单金额订单状态(0,下单；1,确认；2，取消)积分状态(0,冻结；1,可提现；2，申请提现；3，已提现；4,已到账，5.废单）失败code的值不为0的时候，请直接显示msg的值备注前端详情界面显示规则：预计7天后可提现1、status=0，7天后可提现。2、status=1，可提现3、status=2，申请提现4、st