
<公共模块>
    <接口 name="获取公众号管理accessToken" address="/common/getWechatAccessToken.do">
        <请求报文>
            <必填参数>
                <param name="accessTokenKey">获取token的密钥</param>
            </必填参数>
        </请求报文>
        <响应报文>
            <json>{"status":"响应状态码", "message":"响应状态码说明", "data":{"access_token":"accessToken值"}}
            </json>
            <data>
                <param name="access_token">accessToken值</param>
            </data>
        </响应报文>
    </接口>
    <接口 name="小程序登录" address="/common/miniprogramLogin.do">
        <请求报文>
            <必填参数>
                <param name="code" type="string">微信用户授权小程序时得到的code</param>
            </必填参数>
            <可选参数>
                <param name="areaId">用户选择的地区ID</param>
                <param name="inviteCode" type="string">邀请码【即邀请人的会员号】</param>
            </可选参数>
        </请求报文>
        <响应报文>
            <json>{"status":"响应状态码", "message":"响应状态码说明", "data":{"th3rd_session":"会话ID",
                "roleType":"角色类型（0普通1管家2厂长3渠道合作商4渠道物流）","user":{用户信息}, "staff":{员工信息}}}
            </json>
            <data>
                <param name="th3rd_session">会话ID</param>
                <param name="roleType">角色类型（0普通1管家2厂长3渠道合作商4渠道物流）</param>
                <user remark="用户信息(必有值)">
                    <attr name="id">用户编号</attr>
                    <attr name="storeId">所属门店ID</attr>
                    <attr name="comityId">团体客户ID</attr>
                    <attr name="telephone">用户手机号</attr>
                    <attr name="cardNum">会员卡号</attr>
                    <attr name="unionid">微信UniodId</attr>
                    <attr name="openid">公众号openid</attr>
                    <attr name="mpOpenid">小程序openid</attr>
                    <attr name="avatarUrl">用户头像图片的URL</attr>
                    <attr name="realName">真实姓名</attr>
                    <attr name="nickName">用户昵称</attr>
                    <attr name="country">用户所在国家</attr>
                    <attr name="province">用户所在省份</attr>
                    <attr name="city">用户所在城市</attr>
                    <attr name="language">语言</attr>
                    <attr name="userType">用户类型（1微信用户2电话用户）</attr>
                    <attr name="levelId">用户级别（0为普通用户）</attr>
                    <attr name="birthday">出生日期</attr>
                    <attr name="gender">性别</attr>
                    <attr name="pwd">登录密码</attr>
                    <attr name="balance">账户余额</attr>
                    <attr name="points">用户积分</attr>
                    <attr name="qq">用户QQ</attr>
                    <attr name="email">电子邮箱</attr>
                    <attr name="areaId">用户所在区县编号</attr>
                    <attr name="address">用户地址</attr>
                    <attr name="longitude">用户所在位置-经度</attr>
                    <attr name="latitude">用户所在位置-纬度</attr>
                    <attr name="remark">备注信息</attr>
                    <attr name="createTime">用户信息创建时间</attr>
                    <attr name="updateTime">最近更新时间</attr>
                    <attr name="state">用户状态：-2已删除，-1已注销，0已禁用（黑名单），1正常</attr>
                    <attr name="levelName">用户级别名称</attr>
                    <attr name="userGroupName">客户所属分组名称</attr>
                    <attr name="comityName">团体客户名称</attr>
                    <attr name="couponsNum">优惠券数量</attr>
                </user>
                <staff remark="员工信息(roleType=1|2|3时有值)">
                    <attr name="id">编号</attr>
                    <attr name="storeId">所属门店ID</attr>
                    <attr name="roleId">角色ID</attr>
                    <attr name="staffName">员工姓名</attr>
                    <attr name="jobNo">工号</attr>
                    <attr name="telephone">手机号</attr>
                    <attr name="unionid">微信UniodId</attr>
                    <attr name="openid">公众号openid</attr>
                    <attr name="mpOpenid">小程序openid</attr>
                    <attr name="pwd">登录密码</attr>
                    <attr name="pwdSalt">密码加密盐值</attr>
                    <attr name="addTime">账号创建时间</attr>
                    <attr name="state">账号状态 1可用，0禁用</attr>
                    <attr name="pickupProp">取件提成比例(单位%)</attr>
                    <attr name="deliveryProp">送件提成比例(单位%)</attr>
                    <attr name="sellCardProp">售卡提成比例(单位%)</attr>
                    <attr name="distributeProp">推广提成比例(单位%)</attr>
                    <attr name="rechargeProp">充值提成比例(单位%)</attr>
                    <attr name="imgUrl">员工图片URL</attr>
                    <attr name="avatarUrl">微信头像URL</attr>
                    <attr name="balance">员工账户余额</attr>
                    <attr name="areaId">员工所属地区ID</attr>
                    <attr name="areaName">员工所属地区名称</attr>
                    <attr name="roleType">角色类型（0普通1管家2厂长3渠道合作商4渠道物流）</attr>
                    <attr name="roleName">员工角色名称</attr>
                    <attr name="storeName">员工角门店名称色名称</attr>
                    <attr name="storeAddr">门店详细地址</attr>
                    <attr name="wxQrcodeUrl">员工专属分销二维码地址</attr>
                </staff>
            </data>
        </响应报文>
    </接口>
    <接口 name="获取短信验证码" address="/common/getSmsCode.do">
        <请求报文>
            <必填参数>
                <param name="th3rd_session">会话ID</param>
                <param name="telephone">手机号码</param>
            </必填参数>
        </请求报文>
        <响应报文>
            <json>{"status":"响应状态码", "message":"响应状态码说明", "data":{"requestCode":"请求唯一标识"}}</json>
            <data>
                <requestCode>请求唯一标识(在校验短信验证码时必须传入)</requestCode>
            </data>
        </响应报文>
    </接口>
    <接口 name="校验短信验证码" address="/common/checkSmsCode.do">
        <请求报文>
            <必填参数>
                <param name="th3rd_session">会话ID</param>
                <param name="requestCode">请求唯一标识（调用【获取短信验证码】接口时返回】）</param>
                <param name="telephone">手机号码</param>
                <param name="smsCode">短信验证码</param>
            </必填参数>
        </请求报文>
        <响应报文>
            <json>{"status":"响应状态码", "message":"响应状态码说明"}</json>
        </响应报文>
    </接口>
    <接口 name="通过短信验证码绑定手机号" address="/common/bindTelephoneBySms.do">
        <请求报文>
            <必填参数>
                <param name="th3rd_session">会话ID</param>
                <param name="requestCode">请求唯一标识（调用【获取短信验证码】接口时返回】）</param>
                <param name="telephone">手机号码</param>
            </必填参数>
        </请求报文>
        <响应报文>
            <json>{"status":"响应状态码", "message":"响应状态码说明", "data":{"telephone":"用户绑定的手机号"}}</json>
            <data>
                <telephone>用户绑定的手机号</telephone>
            </data>
        </响应报文>
    </接口>
    <接口 name="通过获取微信手机号绑定手机号" address="/common/bindTelephoneByWx.do">
        <请求报文>
            <必填参数>
                <param name="th3rd_session">会话ID</param>
                <param name="encryptedData">包括敏感数据在内的完整用户信息的加密数据(需进行base64编码)</param>
                <param name="iv">加密算法的初始向量(需进行base64编码)</param>
            </必填参数>
        </请求报文>
        <响应报文>
            <json>{"status":"响应状态码", "message":"响应状态码说明", "data":{"telephone":"用户绑定的手机号"}}</json>
            <data>
                <telephone>用户绑定的手机号</telephone>
            </data>
        </响应报文>
    </接口>
    <接口 name="获取当前平台开通服务的城市" address="/common/getSupportCity.do">
        <请求报文></请求报文>
        <响应报文>
            <json>{"status":"响应状态码", "message":"响应状态码说明", "data":{"cities":[{地区信息},{地区信息}...]}}</json>
            <data>
                <cities remark="地区信息">
                    <attr name="id">地区编号</attr>
                    <attr name="name">地区名称</attr>
                    <attr name="descn">地区描述</attr>
                    <attr name="longitude">地区经度</attr>
                    <attr name="latitude">地区纬度</attr>
                    <attr name="zipCode">地区区号</attr>
                    <attr name="state">可用状态(1可用，0禁用)</attr>
                </cities>
            </data>
        </响应报文>
    </接口>
    <接口 name="获取所有基础地区信息" address="/common/getAreas.do">
        <请求报文>
            <可选参数>
                <param name="areaId">地区ID（如果不传值，则返回所有地区数据；若传值，则返回当前地区下的地区数据）</param>
            </可选参数>
        </请求报文>
        <响应报文>
            <json>{"status":"响应状态码", "message":"响应状态码说明", "data":{"areas":[{地区信息},{地区信息}...]}}</json>
            <data>
                <areas remark="地区信息">
                    <attr name="id">地区编号</attr>
                    <attr name="parentId">父区域ID</attr>
                    <attr name="name">地区名称</attr>
                    <attr name="descn">地区描述</attr>
                    <attr name="longitude">地区经度</attr>
                    <attr name="latitude">地区纬度</attr>
                    <attr name="zipCode">地区区号</attr>
                    <attr name="state">可用状态(1可用，0禁用)</attr>
                </areas>
            </data>
        </响应报文>
    </接口>
    <接口 name="统计各渠道分销数据记录信息" address="/common/addDistRecord.do">
        <请求报文>
            <必填参数>
                <param name="operateType">操作事件类型（subscribe-关注公众号，register-注册登录）</param>
                <param name="openid">用户openid</param>
            </必填参数>
            <可选参数>
                <param name="distName">分销商名称（当operateType=subscribe时不能为空）</param>
                <param name="usrTelephone">客户手机号（当operateType=register时不能为空）</param>
            </可选参数>
        </请求报文>
        <响应报文>
            <json>{"status":"响应状态码", "message":"响应状态码说明"}</json>
        </响应报文>
    </接口>
    <接口 name="获取评价基础标签" address="/common/getSuggestTags.do">
        <请求报文></请求报文>
        <响应报文>
            <json>{"status":"响应状态码", "message":"响应状态码说明", "data":{"suggestTags":[{评价基础标签},{评价基础标签}...]}}</json>
            <data>
                <suggestTags remark="评价基础标签">
                    <attr name="id">ID</attr>
                    <attr name="names">标签名称</attr>
                    <attr name="sortNum">排序序号</attr>
                    <attr name="state">是否可用 1是0否</attr>
                </suggestTags>
            </data>
        </响应报文>
    </接口>
    <接口 name="提交用户评价建议" address="/common/addSuggest.do">
        <请求报文>
            <必填参数>
                <param name="th3rd_session">会话ID</param>
                <param name="orderId">订单ID</param>
                <param name="servicePerformance">服务态度</param>
                <param name="washQuality">洗涤质量</param>
                <param name="logisticsService">物流服务</param>
                <param name="softExperience">软件体验</param>
            </必填参数>
            <可选参数>
                <param name="remark">评价建议</param>
            </可选参数>
        </请求报文>
        <响应报文>
            <json>{"status":"响应状态码", "message":"响应状态码说明"}</json>
        </响应报文>
    </接口>
    <接口 name="回复用户评价" address="/common/replySuggest.do">
        <请求报文>
            <必填参数>
                <param name="th3rd_session">会话ID</param>
                <param name="suggestId">用户评价ID</param>
                <param name="content">回复内容</param>
            </必填参数>
        </请求报文>
        <响应报文>
            <json>{"status":"响应状态码", "message":"响应状态码说明", "data":{"replys":[{评价回复},{评价回复}...]}}</json>
            <data>
                <replys remark="评价回复">
                    <attr name="id">ID</attr>
                    <attr name="suggestId">意见反馈ID</attr>
                    <attr name="userId">回复用户ID</attr>
                    <attr name="userName">回复用户名</attr>
                    <attr name="avatarUrl">用户头像地址</attr>
                    <attr name="content">回复内容</attr>
                    <attr name="createTime">回复时间</attr>
                    <attr name="state">审核状态(-1不通过 0待审核 1通过)</attr>
                </replys>
            </data>
        </响应报文>
    </接口>
    <接口 name="点赞用户评价" address="/common/likeSuggest.do">
        <请求报文>
            <必填参数>
                <param name="th3rd_session">会话ID</param>
                <param name="suggestId">用户评价ID</param>
            </必填参数>
        </请求报文>
        <响应报文>
            <json>{"status":"响应状态码", "message":"响应状态码说明"}</json>
        </响应报文>
    </接口>
    <接口 name="分页查询用户评价及回复" address="/common/getSuggestList.do">
        <请求报文>
            <必填参数></必填参数>
            <可选参数>
                <param name="recommend">是否推荐(1是 0否)</param>
                <param name="page.curPage">当前查询页码，默认值为1</param>
                <param name="page.rowsPerPage">每页获取的记录数，默认值为5.</param>
            </可选参数>
        </请求报文>
        <响应报文>
            <json>{"status":"响应状态码", "message":"响应状态码说明""data":{"suggests":[{评价信息},{评价信息}...], "page":{分页属性信息}}}</json>
            <data>
                <suggests remark="评价信息">
                    <attr name="id">ID</attr>
                    <attr name="userId">评价用户ID</attr>
                    <attr name="userName">评价用户名</attr>
                    <attr name="avatarUrl">用户头像地址</attr>
                    <attr name="servicePerformance">服务态度</attr>
                    <attr name="washQuality">洗涤质量</attr>
                    <attr name="logisticsService">物流服务</attr>
                    <attr name="softExperience">软件体验</attr>
                    <attr name="createTime">评价时间</attr>
                    <attr name="remark">评价建议</attr>
                    <attr name="likeNum">点赞数</attr>
                    <attr name="replyNum">回复数</attr>
                    <attr name="state">审核状态(-1不通过 0待审核 1通过)</attr>
                    <attr name="recommend">是否推荐(1是 0否)</attr>
                    <replys remark="评价回复">
                        <attr name="id">ID</attr>
                        <attr name="suggestId">意见反馈ID</attr>
                        <attr name="userId">回复用户ID</attr>
                        <attr name="userName">回复用户名</attr>
                        <attr name="avatarUrl">用户头像地址</attr>
                        <attr name="content">回复内容</attr>
                        <attr name="createTime">回复时间</attr>
                        <attr name="state">审核状态(-1不通过 0待审核 1通过)</attr>
                        <attr name="isOfficial">是否官方回复 1是0否</attr>
                    </replys>
                </suggests>
                <page remark="分页属性信息">
                    <attr name="curPage">当前页码</attr>
                    <attr name="nextPage">下一页</attr>
                    <attr name="prePage">上一页</attr>
                    <attr name="rowsPerPage">每页获取的记录数</attr>
                    <attr name="totalPages">总页数</attr>
                    <attr name="totalRows">总记录数</attr>
                </page>
            </data>
        </响应报文>
    </接口>
    <接口 name="获取用户评价回复" address="/common/getSuggestReply.do">
        <请求报文>
            <必填参数>
                <param name="suggestId">用户评价ID</param>
            </必填参数>
        </请求报文>
        <响应报文>
            <json>{"status":"响应状态码", "message":"响应状态码说明", "data":{"replys":[{评价回复},{评价回复}...]}}</json>
            <data>
                <replys remark="评价回复">
                    <attr name="id">ID</attr>
                    <attr name="suggestId">意见反馈ID</attr>
                    <attr name="userId">回复用户ID</attr>
                    <attr name="userName">回复用户名</attr>
                    <attr name="avatarUrl">用户头像地址</attr>
                    <attr name="content">回复内容</attr>
                    <attr name="createTime">回复时间</attr>
                    <attr name="state">审核状态(-1不通过 0待审核 1通过)</attr>
                    <attr name="isOfficial">是否官方回复 1是0否</attr>
                </replys>
            </data>
        </响应报文>
    </接口>
    <接口 name="获取常用服务列表" address="/common/getAllBaseService.do">
        <请求报文></请求报文>
        <响应报文>
            <json>{"status":"响应状态码", "message":"响应状态码说明", "data":{"services":[{服务信息},{服务信息}...]}</json>
            <data>
                <services remark="服务信息">
                    <attr name="id">编号</attr>
                    <attr name="title">标题</attr>
                    <attr name="brief">简介</attr>
                    <attr name="imageUrl">图标</attr>
                    <attr name="content">内容</attr>
                    <attr name="contentUrl">内容链接</attr>
                    <attr name="state">状态(1可用0禁用)</attr>
                </services>
            </data>
        </响应报文>
    </接口>
    <接口 name="分页获取附近门店信息" address="/common/getNearbyStores.do">
        <请求报文>
            <必填参数>
                <param name="longitude">当前所在位置-经度</param>
                <param name="latitude">当前所在位置-纬度</param>
            </必填参数>
            <可选参数>
                <param name="page.curPage">当前查询页码，默认值为1</param>
                <param name="page.rowsPerPage">每页获取的记录数，默认值为5.</param>
            </可选参数>
        </请求报文>
        <响应报文>
            <json>{"status":"响应状态码", "message":"响应状态码说明", "data":{"stores":[{门店信息},{门店信息}...], "page":{分页属性信息}}</json>
            <data>
                <stores remark="门店信息">
                    <attr name="id">编号</attr>
                    <attr name="areaId">门店所在地区ID</attr>
                    <attr name="storeLevel">门店级别(0公司 1工厂 2门店)</attr>
                    <attr name="isFactory">是否工厂店(1是0否)</attr>
                    <attr name="storeName">名店名称</attr>
                    <attr name="address">门店详细地址</attr>
                    <attr name="longitude">所在位置-经度</attr>
                    <attr name="latitude">所在位置-纬度</attr>
                    <attr name="telephone">门店联系电话</attr>
                    <attr name="xp_printer">【小票】打印机名称 多个打印机名称以#隔开</attr>
                    <attr name="sxm_printer">【水洗麦】打印机名称 多个打印机名称以#隔开</attr>
                    <attr name="ydm_printer">【运单码】打印机名称 多个打印机名称以#隔开</attr>
                    <attr name="state">门店状态 1启用 0禁用</attr>
                    <attr name="logisticsType">物流公司名称</attr>
                    <attr name="storeImgUrl">门店图片地址</attr>
                    <attr name="distance">门店与当前位置的距离（单位:米）</attr>
                </stores>
                <page remark="分页属性信息">
                    <attr name="curPage">当前页码</attr>
                    <attr name="nextPage">下一页</attr>
                    <attr name="prePage">上一页</attr>
                    <attr name="rowsPerPage">每页获取的记录数</attr>
                    <attr name="totalPages">总页数</attr>
                    <attr name="totalRows">总记录数</attr>
                </page>
            </data>
        </响应报文>
    </接口>
    <接口 name="获取广告列表" address="/common/getAdList.do">
        <请求报文>
            <必填参数>
                <param name="areaId">地区ID</param>
            </必填参数>
        </请求报文>
        <响应报文>
            <json>{"status":"响应状态码", "message":"响应状态码说明", "data":{"adList":[{广告信息},{广告信息}...]}</json>
            <data>
                <adList remark="广告信息">
                    <attr name="id">编号</attr>
                    <attr name="areaId">门店所在地区ID</attr>
                    <attr name="adType">广告类型（audio-音频，vedio-视频，text-纯文本，html-富文本，url-外部链接，miniprogram-小程序）</attr>
                    <attr name="title">广告标题</attr>
                    <attr name="content">广告详情介绍</attr>
                    <attr name="coverImgUrl">封面图片URL</attr>
                    <attr name="adUrl">广告地址</attr>
                    <attr name="duration">时长（单位秒，adType=audio或adType=vedio时不为0）</attr>
                    <attr name="createTime">创建时间</attr>
                    <attr name="staffId">创建人ID</attr>
                    <attr name="location">广告位置（index-首页，order-下单页面）</attr>
                    <attr name="state">发布状态 1发布0未发布</attr>
                </adList>
            </data>
        </响应报文>
    </接口>
    <接口 name="帮助中心" address="/common/helpCenter.do">
        <请求报文></请求报文>
        <响应报文>
            <json>{"status":"响应状态码", "message":"响应状态码说明", "data":{"helpCenters":[{帮助中心内容},{帮助中心内容}...]}</json>
            <data>
                <helpCenters remark="帮助中心内容">
                    <parentNode remark="顶层导航">
                        <attr name="id">ID</attr>
                        <attr name="parentId">父类导航ID</attr>
                        <attr name="navName">导航栏名称</attr>
                        <attr name="navType">导航类型（text-文本，html-富文本，url-外链)</attr>
                        <attr name="navIco">导航图标</attr>
                        <attr name="level">级别 1代表一级，2代表二级</attr>
                        <attr name="url">跳转地址</attr>
                        <attr name="content">具体内容</attr>
                        <attr name="sortNum">排序序号 越小越靠前</attr>
                        <attr name="state">可用状态（1启用0禁用）</attr>
                    </parentNode>
                    <sonNodes remark="二级导航">
                        <attr name="id">ID</attr>
                        <attr name="parentId">父类导航ID</attr>
                        <attr name="navName">导航栏名称</attr>
                        <attr name="navType">导航类型（text-文本，html-富文本，url-外链)</attr>
                        <attr name="navIco">导航图标</attr>
                        <attr name="level">级别 1代表一级，2代表二级</attr>
                        <attr name="url">跳转地址</attr>
                        <attr name="content">具体内容</attr>
                        <attr name="sortNum">排序序号 越小越靠前</attr>
                        <attr name="state">可用状态（1启用0禁用）</attr>
                    </sonNodes>
                </helpCenters>
            </data>
        </响应报文>
    </接口>
    <接口 name="获取平台所有活动" address="/common/getActivities.do">
        <请求报文></请求报文>
        <响应报文>
            <json>{"status":"响应状态码", "message":"响应状态码说明", "data":{"activities":[{活动详情},{活动详情}...],
                "shareCoverImgUrl":"活动列表页分享封面图", "shareContent":"活动列表也分享文案"}
            </json>
            <data>
                <activities remark="活动详情">
                    <attr name="id">ID</attr>
                    <attr name="templateType">活动模板类型（html-富文本，image-图片）</attr>
                    <attr name="title">活动标题</attr>
                    <attr name="briefInfo">活动简介</attr>
                    <attr name="times">活动时间</attr>
                    <attr name="areas">活动区域</attr>
                    <attr name="bannerUrl">活动banner图片地址</attr>
                    <attr name="detailImgUrl">活动详情页图片</attr>
                    <attr name="buttonName">按钮名称</attr>
                    <attr name="destinationUrl">跳转链接</attr>
                    <attr name="price">活动价格</attr>
                    <attr name="state">状态 -1已结束0未开放1已开放</attr>
                    <attr name="createTime">活动创建时间</attr>
                    <attr name="special">是否特殊活动 1是0否</attr>
                </activities>
            </data>
        </响应报文>
    </接口>
    <接口 name="获取活动详情" address="/common/getActivity.do">
        <请求报文>
            <param name="activityId">活动ID</param>
        </请求报文>
        <响应报文>
            <json>{"status":"响应状态码", "message":"响应状态码说明", "data":{"activity":{活动详情}}</json>
            <data>
                <activity remark="活动详情">
                    <attr name="id">ID</attr>
                    <attr name="templateType">活动模板类型（html-富文本，image-图片）</attr>
                    <attr name="title">活动标题</attr>
                    <attr name="briefInfo">活动简介</attr>
                    <attr name="times">活动时间</attr>
                    <attr name="areas">活动区域</attr>
                    <attr name="bannerUrl">活动banner图片地址</attr>
                    <attr name="detailImgUrl">活动详情页图片</attr>
                    <attr name="buttonName">按钮名称</attr>
                    <attr name="destinationUrl">跳转链接</attr>
                    <attr name="price">活动价格</attr>
                    <attr name="state">状态 -1已结束0未开放1已开放</attr>
                    <attr name="createTime">活动创建时间</attr>
                    <attr name="special">是否特殊活动 1是0否</attr>
                </activity>
            </data>
        </响应报文>
    </接口>
    <接口 name="上传文件" address="/common/uploadFile.do" method="post">
        <请求报文>
            <必填参数>
                <param name="th3rd_session">会话ID</param>
                <param name="busType">业务类型(cloth_picture_m:衣物实物图片)</param>
                <param name="file">上传文件（注意：该参数不参与签名校验!）</param>
            </必填参数>
        </请求报文>
        <响应报文>
            <json>{"status":"响应状态码", "message":"响应状态码说明", "data":{"originalFilename":"原文件名",
                "accessUrl":"上传成功后用于访问的资源访问地址（含域名）"}}
            </json>
            <data>
                <param name="originalFilename">原文件名</param>
                <param name="accessUrl">上传成功后用于访问的资源访问地址（含域名）</param>
            </data>
        </响应报文>
    </接口>
</公共模块>