获取企业安装的应用
该接口用于查询企业安装的应用列表,只能被企业自建应用调用。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/application/v6/applications |
| HTTP Method | GET |
| 接口频率限制 | 100 次/分钟 |
| 支持的应用类型 | custom |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 | admin:app.info:readonly 获取应用信息 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
page_size | int | 否 | 分页大小 示例值:50 默认值: 50数据校验规则: - 最大值: 50 |
page_token | string | 否 | 分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果 示例值:AQD9/Rn9eij9Pm39ED40/dk53s4Ebp882DYfFaPFbz00L4CMZJrqGdzNyc8BcZtDbwVUvRmQTvyMYicnGWrde9X56TgdBuS+JKiSIkdexPw= |
user_id_type | string | 否 | 用户 ID 类型 示例值:open_id 默认值: open_id |
lang | string | 是 | 应用的图标、描述、帮助文档链接是按照应用的主语言返回;其他内容(如应用权限、应用分类)按照该参数设定返回对应的语言。可选值有: zh_cn:中文 en_us:英文 ja_jp:日文 如不填写,则按照应用的主语言返回 示例值:zh_cn |
status | int | 否 | 不传入代表全部返回。传入则按照这种应用状态返回。应用状态可选值有:0:停用状态1:启用状态 2:未启用状态 示例值:0 可选值有: - 0: 停用 - 1: 启用 - 2: 未启用 |
payment_type | int | 否 | 不传入代表全部返回。传入则按照这种应用状态返回。 付费类型 可选值: 0:免费 1:付费 示例值:0 可选值有: - 0: 免费 - 1: 付费 |
owner_type | int | 否 | 不传入代表全部返回。传入则按照这种应用状态返回。所有者类型,可选值: 0:飞书科技 1:飞书合作伙伴 2:企业内成员 示例值:0 可选值有: - 0: 飞书科技 - 1: 飞书合作伙伴 - 2: 企业内成员 |
响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ app_list | application\[\] | 应用列表 |
└ app_id | string | 应用的 app_id |
└ creator_id | string | 应用创建者(所有者) |
└ status | int | 应用状态 可选值有: - 0: 停用状态 - 1: 启用状态 - 2: 未启用状态 - 3: 未知状态 |
└ scene_type | int | 应用类型 可选值有: - 0: 自建应用 - 1: 应用商店应用 - 2: 个人应用商店应用 - 3: 未知应用类型 |
└ payment_type | int | 付费类型 可选值有: - 0: 免费 - 1: 付费 |
└ create_source | string | 应用创建来源(目前仅Base应用返回) 可选值有: - developer_console: 开发者后台 - base: 多维表格自动化流程创建的应用 - app_engine: 飞书 aPaaS - bot_builder: 机器人助手 - aily: aily(智能伙伴搭建平台) - unknown: 未知来源 |
└ redirect_urls | string\[\] | 安全设置中的重定向 URL |
└ online_version_id | string | 发布在线上的应用版本 ID,若没有则为空 |
└ unaudit_version_id | string | 在审核中的版本 ID,若没有则为空 |
└ app_name | string | 应用名称 |
└ avatar_url | string | 应用图标 url |
└ description | string | 应用默认描述 |
└ scopes | app_scope\[\] | 应用权限列表 |
└ scope | string | 应用权限 |
└ description | string | 应用权限的国际化描述 |
└ level | int | 权限等级描述 可选值有: - 1: 普通权限 - 2: 高级权限 - 3: 超敏感权限 - 0: 未知等级 |
└ back_home_url | string | 后台主页地址 |
└ i18n | app_i18n_info\[\] | 应用的国际化信息列表 |
└ i18n_key | string | 国际化语言的 key 可选值有: - zh_cn: 中文 - en_us: 英文 - ja_jp: 日文 - zh_hk: 繁体中文(中国香港) - zh_tw: 繁体中文(中国台湾) - id_id: 印度尼西亚语 - ms_my: 马来语 - de_de: 德语 - es_es: 西班牙语 - fr_fr: 法语 - it_it: 意大利语 - pt_br: 葡萄牙语(巴西) - vi_vn: 越南语 - ru_ru: 俄语 - th_th: 泰语 - ko_kr: 韩语 |
└ name | string | 应用国际化名称 |
└ description | string | 应用国际化描述(副标题) |
└ help_use | string | 国际化帮助文档链接 |
└ primary_language | string | 应用主语言 可选值有: - zh_cn: 中文 - en_us: 英文 - ja_jp: 日文 |
└ common_categories | string\[\] | 应用分类的国际化描述 |
└ owner | application.owner | 应用的所有者信息 |
└ type | int | 应用所有者类型 可选值有: - 0: 飞书科技 - 1: 飞书合作伙伴 - 2: 企业内成员 |
└ owner_id | string | 应用所有者ID |
└ name | string | 应用开发商名称(仅商店应用返回) |
└ help_desk | string | 应用开发商服务台链接(仅商店应用返回) |
└ email | string | 应用开发商的邮箱(仅商店应用返回) |
└ phone | string | 应用开发商的手机号(仅商店应用返回) |
└ customer_service_account | string | 客服账号,仅当商店应用配置了这种联系方式时才会返回 |
└ mobile_default_ability | string | 移动端默认能力 可选值有: - gadget: 小程序 - web_app: 网页应用 - bot: 机器人 |
└ pc_default_ability | string | PC端默认能力 可选值有: - gadget: 小程序 - web_app: 网页应用 - bot: 机器人 |
└ page_token | string | 分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token |
└ has_more | boolean | 是否还有更多项 |
└ total_count | int | 当前页面数据里,应用状态为“启用”的应用总数 |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"app_list": [
{
"app_id": "cli_9b445f5258795107",
"creator_id": "ou_d317f090b7258ad0372aa53963cda70d",
"status": 1,
"scene_type": 0,
"payment_type": 0,
"create_source": "base",
"redirect_urls": [
"https://www.example.com"
],
"online_version_id": "oav_d317f090b7258ad0372aa53963cda70d",
"unaudit_version_id": "oav_d317f090b7258ad0372aa53963cda70d",
"app_name": "应用名称",
"avatar_url": "https://sf1-ttcdn-tos.pstatp.com/img/avatar/d279000ca4d3f7f6aaff~72x72.jpg",
"description": "应用描述",
"scopes": [
{
"scope": "contact:user.base",
"description": "获取应用信息",
"level": 1
}
],
"back_home_url": "https://www.example.com",
"i18n": [
{
"i18n_key": "zh_cn",
"name": "应用名称",
"description": "应用描述",
"help_use": "https://www.example.com"
}
],
"primary_language": "zh_cn",
"common_categories": [
"分析工具"
],
"owner": {
"type": 0,
"owner_id": "ou_d317f090b7258ad0372aa53963cda70d",
"name": "test tenant",
"help_desk": "https://applink.feishu.cn/client/helpdesk/open?id=6940534140529803284",
"email": "test123@163.com",
"phone": "1234534234234",
"customer_service_account": "feishu@bytedance.com"
},
"mobile_default_ability": "gadget",
"pc_default_ability": "gadget"
}
],
"page_token": "15",
"has_more": true,
"total_count": 20
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 404 | 211005 | invalid app id | 检查 app id |
| 500 | 211002 | internal error | 内部错误,请联系oncall |
| 400 | 211001 | invalid param | 参数错误检查参数 |
| 400 | 211003 | page token 错误 | 检查page token参数是否是之前返回的pagetoken |
| 400 | 211004 | page size 错误 | 检查是否超出限制 |
| 403 | 211006 | 权限缺失 | 检查权限是否满足要求 |
