title: myApps.5.0trunk v1.0.0
language_tabs:

  • shell: Shell
  • http: HTTP
  • javascript: JavaScript
  • ruby: Ruby
  • python: Python
  • php: PHP
  • java: Java
  • go: Go
    toc_footers: []
    includes: []
    search: true
    code_clipboard: true
    highlight_theme: darkula
    headingLevel: 2
    generator: “@tarslib/widdershins v4.0.17”

myApps.5.0trunk

v1.0.0

Base URLs:

myApps平台App/用户

GET 获取企业域列表

GET /runtime/app/domains/list.action

请求参数

名称 位置 类型 必选 说明
accessToken cookie string none
adminToken cookie string none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": [
    {
      "id": "uuid",
      "name": "无限极公司"
    }
  ]
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» errcode integer false none none
» errmsg string false none none
» data [object] true none none
»» id string false none none
»» name string false none none

GET 用户登录

GET /runtime/app/security/login.action

Body 请求参数

{
  "username": "{{user1}}",
  "password": "{{userPwd}}",
  "remember": "0",
  "debug": "false",
  "domainName": "公司域管理",
  "checkcode": "",
  "language": "CN"
}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string none
adminToken cookie string none
body body object none
» domainName body string 企业域名称
» username body string 账号
» password body string 密码
» checkcode body string 验证码

返回示例

成功

{
  "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"
  }
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» errcode integer false none 返回码(0=登录成功,1=账号或密码错误)
» errmsg string false none 状态码对应的信息文本
» data object false none 用户访问凭证
»» username string false none none
»» mobile2 string false none none
»» email string false none none
»» department string false none none
»» userId string false none none
»» domain string false none none
»» avatar string false none none
»» loginno string false none none
»» access_token string false none 用户访问凭证,大部分API调用需要access_token才能访问,一个access_token对应一个用户。
»» mobile string false none none

GET 获取用户资料

GET /runtime/app/users/queryUser.action

请求参数

名称 位置 类型 必选 说明
accessToken cookie string none
adminToken cookie string none
access_token query string 访问凭据,获取方式参考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": "售后服务部"
  }
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» errcode integer false none 返回码(0-成功,1=失败)
» errmsg string false none 状态码对应的信息文本
» data object true none 用户基本信息
»» id string true none 主键
»» name string true none 用户名称
»» loginno string false none 账号
»» email null true none 邮箱
»» mobile null true none 手机号
»» mobile2 null true none 手机号2
»» avatar string true none 用户头像地址
»» domain string true none 所属企业域名称
»» department string false none 所属部门名称(默认)

GET 图片验证码获取

GET /runtime/{applicationId}/app/images/checkCodeImg

当登陆失败超过3次的时候,登陆接口会返回showCode字段,获取验证码

请求参数

名称 位置 类型 必选 说明
accessToken cookie string none
adminToken cookie string none
applicationId path string none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

POST 单点登录

POST /portal/phone/main.jsp

请求参数

名称 位置 类型 必选 说明
accessToken cookie string none
adminToken cookie string none
application query string 软件id
mode query string 模块
access_token query string 令牌

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

GET 获取联系人资料

GET /runtime/app/users/getUser.action

可获取多个联系人资料

请求参数

名称 位置 类型 必选 说明
accessToken cookie string none
adminToken cookie string none
access_token query string 访问凭据,获取方式参考1.2
ids query string 联系人主键(多个联系人用逗号”,”隔开)

返回示例

成功

{
  "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
    }
  ]
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» errcode integer false none 返回码(0-成功,1=失败)
» errmsg string false none 状态码对应的信息文本
» data [object] true none 用户基本信息集合
»» id string false none 主键
»» name string false none 用户名称
»» loginno string false none 账号
»» email null false none 邮箱
»» mobile null false none 手机号
»» mobile2 null false none 手机号2
»» avatar string false none 用户头像地址
»» domain string false none 所属企业域名称
»» department string false none 所属部门名称(默认)
»» favoriteContact boolean false none 是否常用联系人

POST 更新用户资料

POST /runtime/app/users/save.action

Body 请求参数

{
  "avatar": "",
  "name": "张三",
  "loginno": "zhangsan",
  "password": "abc123456",
  "email": "shangsan@qq.com",
  "mobile": "13414523453",
  "mobile2": "13414523453",
  "oldPassword": "13414523453"
}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string none
adminToken cookie string none
access_token query string 访问凭据,获取方式参考1.2
body body object none
» avatar body string none
» name body string none
» loginno body string none
» password body string none
» email body string none
» mobile body string none
» mobile2 body string none
» oldPassword body string none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "保存成功",
  "data": null
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» errcode integer false none 返回码
» errmsg string false none 状态码对应的信息文本
» data null false none none

myApps平台App/事项通知

GET 获取通知

GET /runtime/{applicationId}/app/notice/list.action

请求参数

名称 位置 类型 必选 说明
accessToken cookie string none
adminToken cookie string none
applicationId path string none
access_token query string 访问凭据,获取方式参考1.2

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": [
    {
      "id": "uuid",
      "summary": "<span class='....-</span>",
      "toUserId": "uuid",
      "content": {
        "content": "张三申请[事假]2天",
        "event": "发起",
        "type": 3
      },
      "createTime": "2017-9-28",
      "read": false,
      "module": "OA办公",
      "linkParams": {
        "_docid": "11e6-c81d-6c6c6a57-acab-1fbf492f91e2",
        "_formid": "11e6-5fae-3b5b0e16-b3ac-31493634e7af",
        "application": "11de-f053-df18d577-aeb6-19a7865cfdb6",
        "mode": "personalMessageMode"
      },
      "subjectType": 3,
      "messageType": 1
    }
  ]
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» errcode integer false none 返回码(0=成功,1=失败)
» errmsg string false none 对返回码的文本描述内容
» data [object] false none 通知对象集合
»» id string false none 通知主键
»» summary string false none 通知内容
»» toUserId string false none 通知对象id
»» content object false none none
»»» content string true none 通知内容
»»» event string true none 通知动作
»»» type integer true none 通知动作类型
»» createTime string false none 通知日期
»» read boolean false none 是否已读
»» module string false none 所属应用模块
»» linkParams object false none 链接参数
»»» _docid string true none none
»»» _formid string true none none
»»» application string true none none
»»» mode string true none none
»» subjectType integer false none 事项类型(1=提交2=回退3=待办4=催办5=过期提醒6=抄送提醒)
»» messageType integer false none 消息类型(1=代办消息 2=文本消息)

GET 删除通知

GET /api/runtime/app/notice/delete.action

Body 请求参数

{
  "id": [
    ""
  ]
}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string none
adminToken cookie string none
id query string 事项通知的主键
accessToken query string none
body body object none
» id body [string] none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": null
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» errcode integer true none 返回码(0-成功,1=失败)
» errmsg string true none 状态码对应的信息文本
» data null true none none

GET 标记已读

GET /runtime/{applicationId}/app/notice/read.action

请求参数

名称 位置 类型 必选 说明
accessToken cookie string none
adminToken cookie string none
applicationId path string none
access_token query string 访问凭据,获取方式参考1.2
ids query string 事项通知的主键(多个id用逗号隔开)

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": null
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» errcode integer false none 返回码(0=成功,1=失败)
» errmsg string false none 状态码对应的信息文本
» data null false none none

myApps平台App/通讯录

GET 获取通讯录

GET /runtime/app/contacts/tree.action

请求参数

名称 位置 类型 必选 说明
accessToken cookie string none
adminToken cookie string none
access_token query string 访问凭据,获取方式参考1.2
parentId query string 父级部门id,如果参数为空,则获取一级部门

返回示例

成功

{
  "message": "ok",
  "status": 0,
  "data": {
    "datas": [
      {
        "children": [],
        "userCount": 4,
        "id": "11e5-8ea9-7ead9389-b6a8-8959966cbe66",
        "name": "采购部",
        "type": 2
      },
      {
        "id": "uuid",
        "name": "李玲",
        "mobile": "12345678901",
        "avatar": "",
        "email": "1234744@adb.com",
        "dept": "产品部",
        "domain": "我的公司",
        "type": 1,
        "favoriteContact": true
      }
    ],
    "count": 39
  }
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» message string true none none
» status integer true none none

GET 模糊搜索联系人

GET /runtime/app/contacts/getContactsBySearch.action

根据用户姓名,首字母,电话号码进行模糊查询

请求参数

名称 位置 类型 必选 说明
accessToken cookie string none
adminToken cookie string none
keyWord query string 联系人姓名,首字母,电话
access_token query string 访问凭据,获取方式参考1.2

返回示例

成功

{
  "“errcode": 0,
  "errmsg": "ok",
  "data": [
    {
      "id": "uuid",
      "name": "李玲",
      "mobile": "12345678901",
      "avatar": "",
      "email": "1234744@adb.com",
      "dept": "产品部",
      "domain": "我的公司",
      "favoriteContact": true
    }
  ]
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» errcode integer false none 返回码(0=成功,1=失败)
» errmsg string false none 对返回码的文本描述内容
» data [object] true none 用户部门集合
»» id string false none 用户主键
»» name string false none 用户名称
»» avatar string false none 用户头像地址
»» dept string false none 用户所属部门
»» domain string false none 所属企业域
»» favoriteContact boolean false none 是否常用联系人

GET 模糊搜索部门

GET /runtime/app/contacts/getDepartmentsBySearch.action

根据部门名称进行模糊查询

请求参数

名称 位置 类型 必选 说明
accessToken cookie string none
adminToken cookie string none
keyWord query string 联系人姓名,首字母,电话
access_token query string 访问凭据,获取方式参考1.2

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": [
    {
      "children": [],
      "id": "11e1-81e2-a771f18e-9124-47aada6b7467",
      "name": "资讯部",
      "type": 2
    }
  ]
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» errcode integer false none 返回码(0=成功,1=失败)
» errmsg string false none 对返回码的文本描述内容
» data [object] true none 用户部门集合
»» children [string] false none none
»» id string false none 部门主键
»» name string false none 部门名称
»» type integer false none none

POST 模糊搜索联系人和部门

POST /runtime/app/contacts/getContactsAndDeptsBySearch.action

根据用户姓名,首字母,电话号码进行模糊查询联系人
根据部门名称进行模糊查询部门

请求参数

名称 位置 类型 必选 说明
accessToken cookie string none
adminToken cookie string none
keyWord query string 联系人姓名,首字母,电话
access_token query string 访问凭据,获取方式参考1.2

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": [
    {
      "id": "uuid",
      "name": "李玲",
      "mobile": "12345678901",
      "avatar": "",
      "email": "1234744@adb.com",
      "dept": "产品部",
      "domain": "我的公司",
      "favoriteContact": true
    },
    {
      "children": [],
      "id": "11e1-81e2-a771f18e-9124-47aada6b7467",
      "name": "资讯部",
      "type": 2
    }
  ]
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» errcode integer false none 返回码(0=成功,1=失败)
» errmsg string false none 对返回码的文本描述内容
» data [object] true none 用户部门集合
»» id string true none 用户主键
»» name string true none 用户名称
»» mobile string false none 用户手机号码
»» avatar string false none 用户头像地址
»» email string false none 用户邮箱
»» dept string false none 用户所属部门
»» domain string false none 所属企业域
»» favoriteContact boolean false none 是否常用联系人
»» children [string] false none none
»» type integer false none none

GET 获取常用联系人

GET /runtime/app/contacts/getFavoriteContacts.action

常用联系人

请求参数

名称 位置 类型 必选 说明
accessToken cookie string none
adminToken cookie string none
access_token query string 访问凭据,获取方式参考1.2

返回示例

成功

{
  "message": "ok",
  "status": 0,
  "data": {
    "datas": [
      {
        "avatar": "http://shp.qpic.cn/bizmp/c2SNvgUbuafUJkFIXpKficYxqAtJ9s9brvOgiaTV1KDk7YIgTOvSlflA/",
        "dept": "11e1-81e2-714059a0-9124-47aada6b7467",
        "domain": "我的公司",
        "email": "",
        "id": "11e3-8330-bc935dea-8fcc-95326fa8f055",
        "mobile": "",
        "mobile2": "",
        "name": "肖主管(销售主管)",
        "type": 1
      },
      {
        "avatar": "",
        "dept": "11e6-292f-51466c29-9a78-9b801f3f5251",
        "domain": "我的公司",
        "email": "",
        "id": "11e6-292f-73b25f8e-9a78-9b801f3f5251",
        "mobile": "",
        "mobile2": "",
        "name": "李丽_项目经理",
        "type": 1
      }
    ],
    "count": 2
  }
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» message string true none none
» status integer true none none
» data object true none 用户部门集合
»» datas [object] true none none
»»» avatar string true none 用户头像地址
»»» dept string true none 用户所属部门
»»» domain string true none 所属企业域
»»» email string true none 用户邮箱
»»» id string true none 用户主键
»»» mobile string true none 用户手机号码
»»» mobile2 string true none none
»»» name string true none 用户名称
»»» type integer true none none
»» count integer true none 联系人数

GET 移除常用联系人

GET /runtime/app/contacts/removeFavoriteContact.action

移除常用联系人

请求参数

名称 位置 类型 必选 说明
accessToken cookie string none
adminToken cookie string none
access_token query string 访问凭据,获取方式参考1.2
userId query string 联系人主键

返回示例

成功

{
  "errcode": 0,
  "errmsg": "移除成功",
  "data": null
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» errcode integer false none 返回码(0=成功,1=失败)
» errmsg string false none 对返回码的文本描述内容
» data null false none Null

GET 添加常用联系人

GET /runtime/app/contacts/addFavoriteContact.action

添加常用联系人

请求参数

名称 位置 类型 必选 说明
accessToken cookie string none
adminToken cookie string none
access_token query string 访问凭据,获取方式参考1.2
userId query string 联系人主键

返回示例

成功

{
  "errcode": 0,
  "errmsg": "添加成功",
  "data": null
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» errcode integer false none 返回码(0=成功,1=失败)
» errmsg string false none 对返回码的文本描述内容
» data null false none Null

myApps平台App/工作台

POST 文件上传

POST /runtime/app/upload

Body 请求参数

{
  "id": ""
}

请求参数

名称 位置 类型 必选 说明
accessToken cookie string none
adminToken cookie string none
path query string 上传文件保存的路径
fileSaveMode query string 文件保存模式
fieldId query string 表单字段
allowedTypes query string 允许上传的类型
applicationId query string 软件id
files query string files
multipartFiles query string 多个文件
body body object none
» id body string none

返回示例

成功

[
  {
    "name": "啊啊",
    "type": ".xml",
    "path": "uuid",
    "size": "1024"
  }
]

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» name string false none 文件名
» type string false none 文件类型
» path string false none 文件路径
» size string false none 文件大小

GET 模糊查询应用

GET /runtime/app/applications/{applicationId}/getAppcationsBySearch.action

根据应用名称进行模糊查询

请求参数

名称 位置 类型 必选 说明
accessToken cookie string none
adminToken cookie string none
applicationId path string none
keyWord query string 关键字(应用名称)
access_token query string 访问凭据,获取方式参考1.2

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": [
    {
      "id": "uuid",
      "name": "OA办公",
      "description": "应用描述文字",
      "logourl": {
        "key": "value"
      }
    }
  ]
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» errcode integer true none 返回码(0=成功,1=失败)
» errmsg string true none 对返回码的文本描述内容
» data [object] true none 应用集合
»» id string false none 应用id
»» name string false none 应用名称
»» description string false none 应用描述
»» logourl object false none 图标url
»»» key string true none none

GET 获取应用列表

GET /runtime/app/applications/list.action

请求参数

名称 位置 类型 必选 说明
accessToken cookie string none
adminToken cookie string none
access_token query string 访问凭据,获取方式参考1.2

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": [
    {
      "id": "uuid",
      "name": "OA办公",
      "description": "应用描述文字",
      "logourl": {
        "key": "value"
      },
      "jumpToUrl": {
        "url1": {
          "name": "待填写",
          "url": "/qm/wap/pendlist.jsp?application=qm"
        },
        "url2": {
          "name": "问卷中心",
          "url": "/qm/wap/center.jsp?application=qm"
        }
      }
    }
  ]
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» errcode integer false none none
» errmsg string false none none
» data [object] false none 应用集合
»» id string false none 应用id
»» name string false none 应用名称
»» description string false none 应用描述
»» logourl string false none 图标url
»» jumpToUrl object false none 跳转到应用的 url
»»» url1 object true none none
»»»» name string true none none
»»»» url string true none none
»»» url2 object false none none
»»»» name string true none none
»»»» url string true none none

myApps平台App/ 环信IM

GET 获取控件修改历史

GET /api/runtime/{applicationId}/documents/{docId}/formhelper/inputlog

请求参数

名称 位置 类型 必选 说明
accessToken cookie string none
adminToken cookie string none
applicationId path string none
docId path string none
fieldName query string none

返回示例

成功

{
  "errcode": 0,
  "errmsg": "ok",
  "data": [
    {
      "modifier": "sam_test",
      "time": "2019-05-30 11:08",
      "fieldValue": "22"
    },
    {
      "modifier": "sam_test",
      "time": "2019-05-30 11:15",
      "fieldValue": "22222"
    }
  ]
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» errcode integer false none none
» errmsg string false none none
» data [object] false none none
»» modifier string true none none
»» time string true none none
»» fieldValue string true none none

GET 获取环信配置信息

GET /runtime/app/hx/config.action

请求参数

名称 位置 类型 必选 说明
accessToken cookie string none
adminToken cookie string none

返回示例

成功

{
  "message": "ok",
  "status": 0,
  "data": {
    "app_name": "com-tlin-jarod-tlin",
    "client_id": "YXA6kqOBEMNtEeeKPC1YpoCz-A",
    "client_secret": "YXA6-2HmjGsEQutF62F5CviM4jqWsVo",
    "grant_type": "client_credentials",
    "open": "0",
    "org_name": "1180171101178675"
  }
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» message string true none none
» status integer true none none
» data object true none 环信配置信息
»» app_name string true none none
»» client_id string true none none
»» client_secret string true none none
»» grant_type string true none none
»» open string true none none
»» org_name string true none none

数据模型

文档更新时间: 2023-09-12 11:52   作者:admin