# **myApps平台App接口说明文档 V1.0** ## 1. **用户** ### 1.1获取企业域列表 **请求方式:** GET **请求地址:** /runtime/app/domains/list.action **参数说明:** | **参数** | **必须** | **说明** | |----------|----------|----------| | 无 | 否 | | **权限说明:** 无。 **返回结果:** ``` { “errcode”: 0, "errmsg": "ok", "data": [ { "id": "uuid", "name": "无限极公司" } ] } ``` **参数说明:** | **参数** | **说明** | |--------------|--------------------------| | errcode | 返回码(0=成功,1=失败) | | errmsg | 对返回码的文本描述内容 | | data | 企业域集合 | | data[0].id | 企业域id | | data[0].name | 企业域名称 | ### 1.2用户登录 -------- **请求方式:** POST **请求地址:** /runtime/app/security/login.action **请求包体:** ``` { "domainName": "无限极公司", "username": "test", "password": "123456", "checkcode": "1234" } ``` **参数说明:** | **参数** | **必须** | **说明** | |------------|----------|------------| | domainName | 是 | 企业域名称 | | username | 是 | 账号 | | password | 是 | 密码 | | checkcode | 否 | 验证码 | **权限说明:** 无。 **返回结果:** ``` { “errcode”: 0, "errmsg": "ok", "data": { "username": "测试账号", "mobile2": "12345123563", "email": "3426143645@qq.com", "department": "11e1-81e2-afbbfc08-9124-47aada6b7467", "userId": "11e7-bed7-aff20845-87b6-fb8170f92bdc", "domain": "我的公司", "avatar": "http://shp.qpic.cn/bizmp/c2SNvgUbuacFutC1zGdEiaPribuWVrkk0vlt1aEkaMVFPYITus9relog/", "loginno": "abc01", "access_token": "92c797758a5489fea358266b518d8dda82cdb80caea457547a0c4d8219a7894f1b4d7a22ba52842550565445e8bf505038141d462c7961a670d14757e30b1dd70bf52e3f0acedca6896d3a9f5da89e6c3fc8622087dbdc5258af2947bb6d9560ffd39e21399cbeafd9019bd373611533", "mobile": "12345678901" } } ``` **参数说明:** | **参数** | **说明** | |--------------------|-------------------------------------------------------------------------------------| | errcode | 返回码(0=登录成功,1=账号或密码错误) | | errmsg | 状态码对应的信息文本 | | data | 用户访问凭证 | | data. access_token | 用户访问凭证,大部分API调用需要access_token才能访问,一个access_token对应一个用户。 | ### 1.3 图片验证码获取 -------------- 当登陆失败超过3次的时候,登陆接口会返回showCode字段,获取验证码 **请求方式:** GET **请求地址:** /checkCodeImg **权限说明:** 无。 ### 1.4 单点登录 -------- **请求方式:** POST **请求地址:{**http://192.168.80.177:8080**}**/portal/phone/main.jsp?application={applicationId}&mode=app&access_token={access_token} **参数说明:** | **参数** | **必须** | **说明** | |--------------|----------|----------| | application | 是 | 软件id | | mode | 是 | 模块 | | access_token | 是 | 令牌 | **权限说明:** access_token在登陆的时候会生成唯一的,一个月的有效期。 ### 1.5 获取用户资料 ------------ **请求方式:** GET **请求地址:**/runtime/app/users/queryUser.action?access_token={access_token} **参数说明:** | **参数** | **必须** | **说明** | |--------------|----------|---------------------------| | access_token | 是 | 访问凭据,获取方式参考1.2 | **权限说明:** 无。 **返回结果:** ``` { “errcode”: 0, "errmsg": "ok", "data": { "id": "11e7-7045-31a4aecf-85f9-cbfc8973e987", "name": "张三", "loginno": "zhangsan", "email": "shangsan@qq.com", "mobile": "13414523456", "mobile2": "13414523453", "avatar": "http://shp.qpic.cn/bizmp/wD4d11FtibicHlEvR4DovbkiaIPFvzOZf3u1fG5Bw7ibUrR1rwDs1KWLbg/", "domain": "无限极公司", "department": "售后服务部" } } ``` **参数说明:** | **参数** | **说明** | |-----------------|--------------------------| | errcode | 返回码(0-成功,1=失败) | | errmsg | 状态码对应的信息文本 | | data | 用户基本信息 | | data.id | 主键 | | data.name | 用户名称 | | data. loginno | 账号 | | data.email | 邮箱 | | data. telephone | 手机号 | | data.telephone2 | 手机号2 | | data.avatar | 用户头像地址 | | data.domain | 所属企业域名称 | | data.department | 所属部门名称(默认) | ### 1.6 获取联系人资料 -------------- 可获取多个联系人资料 **请求方式:** GET **请求地址:** /runtime/app/users/getUser.action?access_token={access_token}&ids={ids} **参数说明:** | **参数** | **必须** | **说明** | |--------------|----------|-------------------------------------| | access_token | 是 | 访问凭据,获取方式参考1.2 | | ids | 是 | 联系人主键(多个联系人用逗号","隔开) | **权限说明:** 无。 **返回结果:** ``` { “errcode”: 0, "errmsg": "ok", "data": [{ "id": "11e7-7045-31a4aecf-85f9-cbfc8973e987", "name": "张三", "loginno": "zhangsan", "email": "shangsan@qq.com", "mobile": "13414523456", "mobile2": "13414523453", "avatar": "http://shp.qpic.cn/bizmp/wD4d11FtibicHlEvR4DovbkiaIPFvzOZf3u1fG5Bw7ibUrR1rwDs1KWLbg/", "domain": "无限极公司", "department": "售后服务部", "favoriteContact": true }] } ``` **参数说明:** | **参数** | **说明** | |-------------------------|--------------------------| | errcode | 返回码(0-成功,1=失败) | | errmsg | 状态码对应的信息文本 | | data | 用户基本信息集合 | | data[0].id | 主键 | | data[0].name | 用户名称 | | data[0]. loginno | 账号 | | data[0].email | 邮箱 | | data[0]. telephone | 手机号 | | data[0].telephone2 | 手机号2 | | data[0].avatar | 用户头像地址 | | data[0].domain | 所属企业域名称 | | data[0].department | 所属部门名称(默认) | | data[0].favoriteContact | 是否常用联系人 | ### 1.7 更新用户资料 ------------ **请求方式:** POST **请求地址:** /runtime/app/users/save.action?access_token={access_token} **请求包体:** ``` { "avatar": "", "name": "张三", "loginno": "zhangsan", "password": "abc123456", "email": "shangsan@qq.com", "mobile": "13414523453", "mobile2": "13414523453", "oldPassword": "13414523453" } ``` **参数说明:** | **参数** | **必须** | **说明** | |--------------|----------|-------------------------------------| | access_token | 是 | 访问凭据,获取方式参考1.2 | | 请求包体 | 是 | 用户基本信息对象,数据结构参考\#1.3 | **权限说明:** 无。 **返回结果:** ``` { "errcode" : 0, "errmsg" : "保存成功", "data" : null } ``` **参数说明:** | **参数** | **说明** | |----------|----------------------| | errcode | 返回码 | | errmsg | 状态码对应的信息文本 | | data | 无 | ## 2. **事项通知** ### 2.1 获取通知 **请求方式:** GET **请求地址:** /runtime/app/notice/list.action?access_token={access_token} **参数说明:** | **参数** | **必须** | **说明** | |--------------|----------|---------------------------| | access_token | 是 | 访问凭据,获取方式参考1.2 | **权限说明:** 无。 **返回结果:** ``` { “errcode”: 0, "errmsg": "ok", "data": [ { "id": "uuid", "summary": "