应用列表相关接口
用户拉取可用应用列表
使用场景: 用户登录机构后,通过该接口拉取可以使用的应用列表 注意: 可配合/app/sort_user_apps接口自定义应用列表排序
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 不需要 | |
应用凭证 | 不支持 | 获取应用凭证 |
用户凭证 | 支持 | 获取用户凭证 |
机构凭证 | 不支持 | 获取机构凭证 |
请求方式: GET(HTTPS)
请求地址: https://test-oapi.epaas.qq.com/app/get_install_apps
Query参数:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | String | 是 | 接口调用凭证 |
terminal_type | Int32 | 是 | 用户登录的终端类型,1:pcweb端,2:企业微信端 3:小程序(移动端) |
platform_id | Int32 | 否 | 可用于获取其他平台的应用列表,要求该平台已安装当前应用 |
sub_corpid | Int32 | 否 | 下级机构id(上级单位管理员可使用) 默认:本机构 |
userid | String | 否 | 用户id(上级单位管理员权限或本机构管理员权限可使用) |
app_name | String | 否 | 应用名称模糊查询 |
school_section | Int32数组 | 否 | 学段列表,参考部门学段对照表 (数组形式在GET里的传参方法:school_section=1&school_section=2) |
payment_method | Int32 | 否 | 收费方式 1-免费 2-收费 |
category_id | Int32 | 否 | 一级分类id |
second_category_id | Int32 | 否 | 二级分类id |
is_marked | Int32 | 否 | 是否只返回收藏的应用 1-是 |
need_marked | Int32 | 否 | 是否返回收藏字段 1-是 |
sort_by_user | Int32 | 否 | 是否按用户自定义应用列表排序 1-是 |
app_forms | Int32数组 | 否 | 应用形态过滤,参考应用形态说明(数组形式在GET里的传参方法:app_forms=1&app_forms=2) |
返回参数:
参数 | 类型 | 说明 |
---|---|---|
errcode | Int32 | 返回码,0为正常 |
errmsg | String | 对返回码的文本描述内容 |
app_list.installed_id | Uint32 | 应用安装记录id |
app_list.appid | Int32 | 应用id |
app_list.version_id | Int32 | 应用版本id |
app_list.name | String | 应用名称 |
app_list.desc | String | 应用描述 |
app_list.icon | String | 应用icon |
app_list.index_url | String | 首页地址 |
app_list.category_id | Int32 | 应用一级分类id |
app_list.second_cate_id | Int32 | 二级应用类型id |
data_list.installed_time | String | 应用安装时间(2022-06-15 10:40:31) |
data_list.app_tags | String数组 | 应用自定义标签列表 |
data_list.mini_app_id | String | 小程序应用ID |
data_list.mini_app_original_id | String | 小程序原始账号 |
data_list.mini_app_home_page | String | 小程序主页 |
data_list.mobile_type | string | 移动端类型 NoMobile:无移动端, MERGE:和包小程序, H5:h5, MINI:独立小程序, QYWX_THIRD_APP:企微第三方应用(仅罗湖项目使用), QYWX:企微原生应用(进罗湖项目使用) |
app_list.is_marked | Int32 | 是否是已收藏的应用 1-是 |
app_list.marked_sort | Int32 | 已收藏应用的排序值 (从1开始,值越小排前面), 未收藏为0 |
data_list.app_form_urls | Object数组 | 应用形态与url |
data_list.app_form_urls.type | Int32 | 应用形态 参考应用形态说明 |
data_list.app_form_urls.url | String | 跳转链接地址 |
data_list.app_form_urls.role_ids | Int32数组 | 角色列表 参考角色类型 |
示例:
请求示例
GET https://test-oapi.epaas.qq.com/app/get_install_apps?access_token=ACCESS_TOKEN&terminal_type=1&platform_id=20000
返回结果:
{
"errcode": 0,
"errmsg": "ok",
"app_list": [
{
"installed_id": 1000010,
"appid": 700259,
"version_id": 1133211,
"name": "测试回调",
"desc":"应用的描述",
"icon": "https://xxx.com/cos1.png",
"index_url": "https://xxx.com/index.html",
"category_id": 32,
"second_cate_id": 33,
"installed_time": "2022-06-15 10:40:31",
"mini_app_id": "",
"mini_app_original_id": "",
"mini_app_home_page": "",
"app_tags": [],
"mobile_type": "MERGE",
"is_marked" : 0,
"marked_sort" : 0
}
]
}
拉取批量用户可用应用列表
使用场景: 管理员用户查询本机构或下级机构的多个用户的可用应用列表
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 不需要 | |
用户凭证 | 支持 | 需要机构管理员 |
机构凭证 | 未支持 |
请求方式: POST(HTTPS)
请求地址: https://test-oapi.epaas.qq.com/app/batch_get_install_apps
请求示例
POST https://test-oapi.epaas.qq.com/app/batch_get_install_apps?access_token=ACCESS_TOKEN
请求参数
{"platform_type":0, "sub_corpid":0, "userids":["3730477619"]}
请求参数:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 接口调用凭证 |
platform_type | int32 | 否 | 平台类型 0-全部 1-PC端 2-移动端 默认:0 |
sub_corpid | int32 | 否 | 子机构id (支持中心校) 默认:本机构 |
userids | string数组 | 是 | 用户id列表 |
app_name | String | 否 | 应用名称模糊查询 |
返回参数:
参数 | 类型 | 说明 |
---|---|---|
errcode | Int32 | 返回码,0为正常 |
errmsg | String | 对返回码的文本描述内容 |
data_list | object数组 | 用户的应用id列表 |
data_list.userid | String | 用户id |
data_list.pc_appids | Uint32数组 | pc端应用id列表 |
data_list.mp_appids | Uint32数组 | 移动端应用id列表 |
app_list | object数组 | 应用详情 |
app_list.installed_id | Uint32 | 应用安装记录id |
app_list.appid | Int32 | 应用id |
app_list.version_id | Int32 | 应用版本id |
app_list.name | String | 应用名称 |
app_list.icon | String | 应用icon |
app_list.index_url | String | 首页地址 |
app_list.category_id | Int32 | 应用类型id |
app_list.category_name | String | 应用类型名称 |
app_list.is_frozen | Int32 | 0.启用,1.停用 |
示例:
返回结果:
{
"errmsg": "ok",
"errcode": 0,
"data_list": [
{
"userid": "3730477619",
"pc_appids": [
700116
],
"mp_appids": [
700116
]
}
],
"app_list": [
{
"installed_id": 42272,
"appid": 700116,
"version_id": 40217,
"name": "选课报名",
"icon": "xxx.jpg",
"index_url": "https://test-v.campus.qq.com/courseregistration/",
"category_id": 34,
"category_name": "教务管理",
"is_frozen": 0,
"desc": "选课报名"
}
]
}
管理员拉取可管理应用列表(区分已安装和未安装)
使用场景: 拉取市场对机构可见的所有应用列表,包括已安装、未安装的
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 不需要 | |
应用凭证 | 不支持 | 获取应用凭证 |
用户凭证 | 支持 | 获取用户凭证 |
机构凭证 | 支持 | 获取机构凭证 |
请求方式: GET(HTTPS)
请求地址: https://test-oapi.epaas.qq.com/app/get_all_apps
Query参数:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | String | 是 | 接口调用凭证 |
platform_id | Int32 | 否 | 可用于获取其他平台的应用列表,要求该平台已安装当前应用 |
sub_corpid | Int32 | 否 | 下级机构id(上级单位管理员可使用) 默认:本机构 |
app_name | String | 否 | 应用名称模糊查询 |
school_section | Int32数组 | 否 | 学段列表,参考部门学段对照表 (数组形式在GET里的传参方法:school_section=1&school_section=2) |
payment_method | Int32 | 否 | 收费方式 1-免费 2-收费 |
category_id | Int32 | 否 | 一级分类id |
second_category_id | Int32 | 否 | 二级分类id |
返回参数:
参数 | 类型 | 说明 |
---|---|---|
errcode | Int32 | 返回码,0为正常 |
errmsg | String | 对返回码的文本描述内容 |
app_list.appid | Int32 | 应用id |
app_list.name | String | 应用名称 |
app_list.desc | String | 应用描述 |
app_list.version_id | Int32 | 应用版本id |
app_list.logo | String | 应用icon |
app_list.is_installed | Boolean | 是否已安装:false-未安装;true-已安装 |
app_list.category_id | Int32 | 应用一级分类id |
app_list.qywx_suiteid | String | 企业微信应用id |
data_list.pc_role_ids | Int32数组 | pc端可见角色列表 |
data_list.mp_role_ids | Int32数组 | 移动端可见角色列表 |
data_list.installed_time | String | 应用安装时间(2022-06-15 10:40:31) |
data_list.app_tags | String数组 | 应用自定义标签列表 |
data_list.mini_app_id | String | 小程序应用ID |
data_list.mini_app_original_id | String | 小程序原始账号 |
data_list.mini_app_home_page | String | 小程序主页 |
data_list.mobile_type | String | 移动端类型 NoMobile:无移动端, MERGE:和包小程序, H5:h5, MINI:独立小程序, QYWX_THIRD_APP:企微第三方应用(仅罗湖项目使用), QYWX:企微原生应用(进罗湖项目使用) |
data_list.visibility_type | Int32 | 已安装应用可见性类型,1-按角色 参考 角色类型,2-按组织架构范围,3-全员可见,0或没有值默认全员可见 |
data_list.visibility_data | String | 可见范围数据,字符串为json形式,示例如下 |
visibility_data示例:
{
"visibility_type": 1,
"visibility_data": "[12,11,13]"
}
{
"visibility_type": 2,
"visibility_data": "[{\"IsParent\":true,\"Name\":\"局内职工\",\"NodeId\":16023484}]"
// IsParent:是否为部门节点,false表示单个成员
// Name:部门名称 or 成员名称
// NodeId:部门id or 成员用户id
}
{
"visibility_type": 3,
"visibility_data": ""
}
示例:
请求示例
GET https://test-oapi.epaas.qq.com/app/get_all_apps?access_token=ACCESS_TOKEN&platform_id=20000
返回结果:
{
"errcode": 0,
"errmsg": "ok",
"app_list": [
{
"appid": 1000010,
"name": "作业",
"desc": "查看提交作业",
"version_id": 34524,
"logo": "https://xxx.com/cos1.png",
"is_installed": true,
"category_id": 32,
"qywx_suiteid": "ww076bee13853ff46a",
"pc_role_ids": [
2,
11,
12,
13,
14,
15,
16,
19
],
"mp_role_ids": [
2,
11,
12,
13,
14,
15,
16,
19
],
"installed_time": "2022-06-15 10:40:31",
"mini_app_id": "",
"mini_app_original_id": "",
"mini_app_home_page": "",
"app_tags": [],
"mobile_type": "MERGE"
}
]
}
获得机构应用安装列表(机构token)
使用场景: 机构token拉取应用已安装列表
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 不需要 | |
应用凭证 | 不支持 | 获取应用凭证 |
用户凭证 | 不支持 | 获取用户凭证 |
机构凭证 | 支持 | 获取机构凭证 |
请求方式: GET(HTTPS)
请求地址: https://test-oapi.epaas.qq.com/suite/get_suite_installed_list
Query参数:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | String | 是 | 接口调用凭证 |
platform_type | Int32 | 否 | 用户登录的终端类型,1:pcweb端,2:企业微信端,3:小程序(不传默认PC) |
platform_id | Int32 | 否 | 可用于获取其他平台的应用列表,要求该平台已安装当前应用 |
app_name | String | 否 | 应用名称模糊查询 |
school_section | Int32数组 | 否 | 学段列表,参考部门学段对照表 (数组形式在GET里的传参方法:school_section=1&school_section=2) |
payment_method | Int32 | 否 | 收费方式 1-免费 2-收费 |
category_id | Int32 | 否 | 一级分类id |
second_category_id | Int32 | 否 | 二级分类id |
app_forms | Int32数组 | 否 | 应用形态过滤,参考应用形态说明(数组形式在GET里的传参方法:app_forms=1&app_forms=2) |
返回参数:
参数 | 类型 | 说明 |
---|---|---|
errcode | Int32 | 返回码,0为正常 |
errmsg | String | 对返回码的文本描述内容 |
data_list.suite_installed_id | Int32 | 应用安装id |
data_list.suiteid | Int32 | 应用id |
data_list.suite_version_id | Int32 | 应用版本id |
data_list.suite_icon | String | 应用icon |
data_list.suite_type | Int32 | 应用类型 |
data_list.suite_desc | String | 应用详情 |
data_list.is_frozen | Int32 | 是否停用 |
data_list.index_url | String | 跳转链接 |
data_list.role_id | Int32 | 角色id, 参考角色类型 |
data_list.type | Int32 | 应用类型 1:小程序 2:h5 |
data_list.teacher_space_url | String | 教师空间地址 |
data_list.school_plat_url | String | 管理端地址 |
data_list.suite_type_name | String | 应用类型名称 |
data_list.suite_initial_name | String | 应用原名称 |
data_list.instruction_notify_url | String | 变更通知回调地址 |
data_list.notify_change_url | String | 变更回调地址 |
data_list.terminal_id | Int32 | 终端id |
data_list.is_contact | Int32 | 是否为通讯录应用 |
data_list.visibility_type | Int32 | 可见范围类型 1-按角色 2-按组织架构可见范围 3-全员可见 |
data_list.role_visibility_data | Object | 角色id列表,当visibility_type传2时填写,参考设置应用的可见角色范围 |
data_list.app_form_urls | Object数组 | 应用形态与url |
data_list.app_form_urls.type | Int32 | 应用形态 参考应用形态说明 |
data_list.app_form_urls.url | String | 跳转链接地址 |
data_list.app_form_urls.role_ids | Int32数组 | 角色列表 参考角色类型 |
示例:
请求示例
GET https://test-oapi.epaas.qq.com/suite/get_suite_installed_list?access_token=ACCESS_TOKEN&platform_id=20000
返回结果:
{
"errcode": 0,
"errmsg": "ok",
"data_list": [
{
"suite_installed_id": 1000010,
"suiteid": 10121,
"suite_version_id": 12115,
"suite_icon": "https://xxx.com/cos1.png",
"suite_type": 1,
"is_frozen": 0,
"index_url": "https://www.qq.com",
"role_id": 12,
"type": 1,
"teacher_space_url": "https://www.qq.com",
"suite_type_name": "教育数据",
"suite_initial_name": "作业",
"instruction_notify_url": "https://www.qq.com/notify",
"notify_change_url": "https://www.qq.com/notify",
"terminal_id": 1,
"is_contact": 0,
"suite_desc": "应用的描述"
}
]
}
查询应用已安装机构简易信息
使用场景: 查询多个应用的已安装机构的数量(查询范围:本机构和下级机构,支持中心校)
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 不需要 | |
应用凭证 | 不支持 | 获取应用凭证 |
用户凭证 | 支持 | 获取用户凭证 |
机构凭证 | 支持 | 获取机构凭证 |
请求方式: POST(HTTPS)
请求地址: https://test-oapi.epaas.qq.com/app/batch_get_install_orgs_simple
请求示例
POST https://test-oapi.epaas.qq.com/app/batch_get_install_orgs_simple?access_token=ACCESS_TOKEN
请求参数
{"app_ids":[1234,1235]}
请求参数:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 接口调用凭证 |
app_ids | int32数组 | 是 | 应用id列表 |
返回参数:
参数 | 类型 | 说明 |
---|---|---|
errcode | Int32 | 返回码,0为正常 |
errmsg | String | 对返回码的文本描述内容 |
data_list | object数组 | 应用数据 |
data_list.app_id | int32 | 应用id |
data_list.orgs_num | int32 | 机构数量 |
返回结果:
{
"errmsg": "ok",
"errcode": 0,
"data_list": [
{
"app_id": 1234,
"orgs_num": 14
},
{
"app_id": 1235,
"orgs_num": 64
}
]
}
查询应用已安装机构详情
使用场景: 管理员用户,查询一个应用的已安装机构的详情(查询范围:本机构和下级机构,支持中心校)
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 不需要 | |
应用凭证 | 不支持 | 获取应用凭证 |
用户凭证 | 支持 | 获取用户凭证 |
机构凭证 | 支持 | 获取机构凭证 |
请求方式: GET(HTTPS)
请求地址: https://test-oapi.epaas.qq.com/app/get_install_orgs_detail
Query参数:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 接口调用凭证 |
app_id | int32 | 是 | 应用id |
返回参数:
参数 | 类型 | 说明 |
---|---|---|
errcode | Int32 | 返回码,0为正常 |
errmsg | String | 对返回码的文本描述内容 |
data_list | object数组 | 机构数据 |
data_list.corpid | int32 | 机构id |
data_list.name | string | 机构名称 |
示例:
请求示例
GET https://test-oapi.epaas.qq.com/app/get_install_orgs_detail?access_token=ACCESS_TOKEN&app_id=APPID
返回结果:
{
"errmsg": "ok",
"errcode": 0,
"data_list": [
{
"corpid": 1234,
"name": "测试小学1"
},
{
"corpid": 1235,
"name": "测试小学2"
}
]
}
拉取教育局市场应用列表
使用场景: 教育局查询自身教育局市场内的所有应用
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 不需要 | |
应用凭证 | 不支持 | 获取应用凭证 |
用户凭证 | 不支持 | 获取用户凭证 |
机构凭证 | 支持 | 获取机构凭证 |
请求方式: GET(HTTPS)
请求地址: https://test-oapi.epaas.qq.com/app/get_market_apps
Query参数:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | String | 是 | 接口调用凭证 |
name | String | 否 | 应用名称关键词 |
pc_role_id | Int32 | 否 | pc端可见角色 |
mp_role_id | Int32 | 否 | 移动端可见角色 |
school_section | Int32数组 | 否 | 学段列表,参考部门学段对照表 (数组形式在GET里的传参方法:school_section=1&school_section=2) |
payment_method | Int32 | 否 | 收费方式 1-免费 2-收费 |
category_id | Int32 | 否 | 一级分类id |
second_category_id | Int32 | 否 | 二级分类id |
返回参数:
参数 | 类型 | 说明 |
---|---|---|
errcode | Int32 | 返回码,0为正常 |
errmsg | String | 对返回码的文本描述内容 |
data_list.app_id | Int32 | 应用id |
data_list.name | String | 应用名称 |
data_list.logo | String | 应用icon |
app_list.category_id | Int32 | 应用一级分类id |
app_list.second_cate_id | Int32 | 二级应用类型id |
data_list.mobile_type | string | 移动端类型 NoMobile:无移动端, MERGE:和包小程序, H5:h5, MINI:独立小程序, QYWX_THIRD_APP:企微第三方应用(仅罗湖项目使用), QYWX:企微原生应用(进罗湖项目使用) |
data_list.desc | String | 应用描述 |
data_list.pc_role_ids | Int32数组 | pc端可见角色列表 |
data_list.mp_role_ids | Int32数组 | 移动端可见角色列表 |
data_list.interface_imgs | String数组 | 应用示例图片url |
data_list.on_market_time | String | 应用上架时间(2022-06-15 10:40:31) |
data_list.web_url | String | pc首页地址 |
data_list.mp_url | String | 小程序首页地址 |
data_list.app_tags | String数组 | 应用自定义标签列表 |
data_list.mini_app_id | String | 小程序应用ID |
data_list.mini_app_original_id | String | 小程序原始账号 |
data_list.mini_app_home_page | String | 小程序主页 |
data_list.app_form_urls | Object数组 | 应用形态与url |
data_list.app_form_urls.type | Int32 | 应用形态 参考应用形态说明 |
data_list.app_form_urls.url | String | 跳转链接地址 |
data_list.app_form_urls.role_ids | Int32数组 | 角色列表 参考角色类型 |
示例:
请求示例
GET https://test-oapi.epaas.qq.com/app/get_market_apps?access_token=ACCESS_TOKEN
返回结果:
{
"RequestId": "0b8e0edf725c1cbe",
"ErrorCode": "OK",
"Data": {
"data_list": [
{
"app_id": 1004,
"name": "通知公告",
"logo": "https://main.qcloudimg.com/raw/65fd487218d167e85cdd3cb5ca4da2d7.svg",
"category_id": 32,
"second_cate_id": 33,
"mobile_type": "MERGE",
"desc": "这是慕课的应用介绍",
"pc_role_ids": [
2,
11,
12,
13,
14,
15,
16,
19
],
"mp_role_ids": [
2,
11,
12,
13,
14,
15,
16,
19
],
"interface_imgs": [],
"on_market_time": "2022-06-15 10:40:31",
"web_url": "",
"mp_url": "",
"mini_app_id": "",
"mini_app_original_id": "",
"mini_app_home_page": "",
"app_tags": []
}
]
}
}
拉取应用分类信息
使用场景: 拉取应用分类信息
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 不需要 | |
应用凭证 | 支持 | 获取应用凭证 |
用户凭证 | 支持 | 获取用户凭证 |
机构凭证 | 支持 | 获取机构凭证 |
请求方式: GET(HTTPS)
请求地址: https://test-oapi.epaas.qq.com/app/get_category_list
Query参数:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | String | 是 | 接口调用凭证。使用应用token时,参数替换为 suite_access_token |
返回参数:
参数 | 类型 | 说明 |
---|---|---|
errcode | Int32 | 返回码,0为正常 |
errmsg | String | 对返回码的文本描述内容 |
category_list.category_id | Int32 | 分类id |
category_list.category_name | String | 分类名称 |
second_cate_list | String | 二级分类 |
second_cate_list.category_id | Int32 | 二级分类id |
second_cate_list.category_name | String | 二级分类名字 |
示例:
请求示例
GET https://test-oapi.epaas.qq.com/app/get_category_list?access_token=ACCESS_TOKEN
返回结果:
{
"errmsg": "ok",
"errcode": 0,
"category_list": [
{
"second_cate_list": [
{
"category_id": 2925,
"category_name": "二级分类222222"
},
{
"category_id": 2927,
"category_name": "二级分类1111"
},
{
"category_id": 2930,
"category_name": "二级分类44444"
}
],
"category_id": 2924,
"category_name": "一级分类"
}
]
}
获取应用详情
使用场景: 获取应用详情
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 不需要 | |
应用凭证 | 支持 | 获取应用凭证 |
用户凭证 | 支持 | 获取用户凭证 |
机构凭证 | 支持 | 获取机构凭证 |
请求方式: GET,POST(HTTPS)
请求地址: https://test-oapi.epaas.qq.com/app/get_app_details
Query参数:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | String | 是 | 接口调用凭证。使用应用token时,参数替换为 suite_access_token |
app_id | Int32 | 是 | 应用id |
返回参数:
参数 | 类型 | 说明 |
---|---|---|
errcode | Int32 | 返回码,0为正常 |
errmsg | String | 对返回码的文本描述内容 |
app_id | Int32 | 应用id |
name | String | 应用名称 |
logo | String | 应用图标 |
desc | String | 应用介绍 |
details | String | 应用详情(html页面文本字符串) |
pricing_mode | Object | 应用价格模式 |
价格模式结构体:
参数 | 类型 | 说明 |
---|---|---|
app_attribute | Int32 | 应用属性 1-公开应用 2-自建要应用 3-统建应用 |
app_source | Int32 | 应用来源 1-国家级 2-省\自治区\直辖市级 3-地区\地级市\自治州级 4-县\县级市\市辖区级 5-乡\镇级 6-校级 |
payment_method | Int32 | 收费方式 1-免费 2-收费 |
pricing_type | Int32 | 收费类型 1-一次性收费 2-订阅收费 3-增值收费 |
usage_restriction_days | Int32 | 试用限制 (天数) |
usage_feature_desc | String | 试用功能说明 |
payment_plan_config | String | 付费方案配置 |
示例:
请求示例
GET https://test-oapi.epaas.qq.com/app/get_app_details?access_token=ACCESS_TOKEN&app_id=50000
返回结果:
{
"errmsg": "ok",
"errcode": 0,
"app_id": 50000,
"name": "腾讯智慧校园3.0",
"logo": "https://v.campus.qq.com/static/img/sc-titleLogo.png",
"desc": "智慧校园",
"details": "",
"pricing_mode": {
"app_attribute": 0,
"app_source": 0,
"payment_method": 0,
"pricing_type": 0,
"usage_restriction_days": 0,
"usage_feature_desc": "",
"payment_plan_config": ""
}
}
获取应用市场应用分类统计数据
使用场景: 获取应用市场应用分类统计数据
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 不需要 | |
应用凭证 | 支持 | 获取应用凭证 |
用户凭证 | 支持 | 获取用户凭证 |
机构凭证 | 支持 | 获取机构凭证 |
请求方式: GET,POST(HTTPS)
请求地址: https://test-oapi.epaas.qq.com/app/get_market_app_statistics
Query参数:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | String | 是 | 接口调用凭证。使用应用token时,参数替换为 suite_access_token |
market_id | Int32 | 是 | 市场id |
返回参数:
参数 | 类型 | 说明 |
---|---|---|
errcode | Int32 | 返回码,0为正常 |
errmsg | String | 对返回码的文本描述内容 |
market_id | Int32 | 市场id |
market_name | String | 市场名称 |
app_num | Int32 | 应用数量 |
category_app_data | Object | 应用一级分类数据 |
应用一级分类数据结构体:
参数 | 类型 | 说明 |
---|---|---|
category_id | Int32 | 分类id |
category_name | string | 分类名称 |
app_num | Int32 | 应用数量 |
second_category_app_data | Object | 二级分类数据 |
应用二级分类数据结构体:
参数 | 类型 | 说明 |
---|---|---|
category_id | Int32 | 分类id |
category_name | string | 分类名称 |
app_num | Int32 | 应用数量 |
示例:
请求示例
GET https://test-oapi.epaas.qq.com/app/get_market_app_statistics?access_token=ACCESS_TOKEN&market_id=22463
返回结果:
{
"errmsg": "ok",
"errcode": 0,
"market_id": 22463,
"market_name": "德育测试",
"app_num": 7,
"category_app_data": [
{
"category_id": 5,
"category_name": "办公",
"app_num": 7,
"second_category_app_data": [
{
"CategoryId": 0,
"CategoryName": "默认",
"AppNum": 7
}
]
}
]
}
添加收藏应用
使用场景: 用户添加收藏应用
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 不需要 | |
用户凭证 | 支持 | - |
机构凭证 | 未支持 |
请求方式: POST(HTTPS)
请求地址: https://test-oapi.epaas.qq.com/app/mark_apps
请求示例
POST https://test-oapi.epaas.qq.com/app/mark_apps?access_token=ACCESS_TOKEN
请求参数
{"app_ids":[800791,800794,800833]}
请求参数:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 接口调用凭证 |
app_ids | int32数组 | 是 | 应用id列表 |
返回参数:
参数 | 类型 | 说明 |
---|---|---|
errcode | Int32 | 返回码,0为正常 |
errmsg | String | 对返回码的文本描述内容 |
data_list | object数组 | 数据列表 |
data_list.app_id | Int32 | 应用id |
data_list.sort | Int32 | 排序值,从1开始,小的排前面 |
示例:
返回结果:
{
"errmsg": "ok",
"errcode": 0,
"data_list": [
{
"app_id": 800791,
"sort": 1
},
{
"app_id": 800794,
"sort": 2
}
]
}
删除收藏应用
使用场景: 用户删除收藏应用
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 不需要 | |
用户凭证 | 支持 | - |
机构凭证 | 未支持 |
请求方式: POST(HTTPS)
请求地址: https://test-oapi.epaas.qq.com/app/delete_marked_apps
请求示例
POST https://test-oapi.epaas.qq.com/app/delete_marked_apps?access_token=ACCESS_TOKEN
请求参数
{"app_ids":[800791,800794,800833]}
请求参数:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 接口调用凭证 |
app_ids | int32数组 | 是 | 应用id列表 |
返回参数:
参数 | 类型 | 说明 |
---|---|---|
errcode | Int32 | 返回码,0为正常 |
errmsg | String | 对返回码的文本描述内容 |
示例:
返回结果:
{
"errmsg": "ok",
"errcode": 0
}
排序收藏应用
使用场景: 用户添加收藏应用
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 不需要 | |
用户凭证 | 支持 | - |
机构凭证 | 未支持 |
请求方式: POST(HTTPS)
请求地址: https://test-oapi.epaas.qq.com/app/sort_marked_apps
请求示例
POST https://test-oapi.epaas.qq.com/app/sort_marked_apps?access_token=ACCESS_TOKEN
请求参数
{"app_ids":[800791,800794,800833]}
请求参数:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 接口调用凭证 |
app_ids | int32数组 | 是 | 应用id列表 (会以该数组的app_id顺序排序,sort值从1->N) |
返回参数:
参数 | 类型 | 说明 |
---|---|---|
errcode | Int32 | 返回码,0为正常 |
errmsg | String | 对返回码的文本描述内容 |
data_list | object数组 | 数据列表 |
data_list.app_id | Int32 | 应用id |
data_list.sort | Int32 | 排序值,从1开始,小的排前面 |
示例:
返回结果:
{
"errmsg": "ok",
"errcode": 0,
"data_list": [
{
"app_id": 800791,
"sort": 1
},
{
"app_id": 800794,
"sort": 2
}
]
}
用户自定义应用列表排序
使用场景: 用户自定义应用列表排序, 在/app/get_install_apps会按此排序
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 不需要 | |
用户凭证 | 支持 | - |
机构凭证 | 未支持 |
请求方式: POST(HTTPS)
请求地址: https://test-oapi.epaas.qq.com/app/sort_user_apps
请求示例
POST https://test-oapi.epaas.qq.com/app/sort_user_apps?access_token=ACCESS_TOKEN
请求参数
{"app_ids":[800791,800794,800833]}
请求参数:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 接口调用凭证 |
app_ids | int32数组 | 是 | 应用id列表 (/app/get_install_apps会以该数组的app_id顺序排序) |
返回参数:
参数 | 类型 | 说明 |
---|---|---|
errcode | Int32 | 返回码,0为正常 |
errmsg | String | 对返回码的文本描述内容 |
示例:
返回结果:
{
"errmsg": "ok",
"errcode": 0
}