Skip to content

获取企业安装的应用

该接口用于查询企业安装的应用列表,只能被企业自建应用调用。

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/application/v6/applications
HTTP MethodGET
接口频率限制100 次/分钟
支持的应用类型custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用admin:app.info:readonly 获取应用信息

请求头

名称类型必填描述
Authorizationstringtenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token

查询参数

名称类型必填描述
page_sizeint分页大小
示例值:50
默认值50
数据校验规则
- 最大值:50
page_tokenstring分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果
示例值:AQD9/Rn9eij9Pm39ED40/dk53s4Ebp882DYfFaPFbz00L4CMZJrqGdzNyc8BcZtDbwVUvRmQTvyMYicnGWrde9X56TgdBuS+JKiSIkdexPw=
user_id_typestring用户 ID 类型
示例值:open_id
默认值open_id
langstring应用的图标、描述、帮助文档链接是按照应用的主语言返回;其他内容(如应用权限、应用分类)按照该参数设定返回对应的语言。可选值有: zh_cn:中文 en_us:英文 ja_jp:日文 如不填写,则按照应用的主语言返回
示例值:zh_cn
statusint不传入代表全部返回。传入则按照这种应用状态返回。应用状态可选值有:0:停用状态1:启用状态 2:未启用状态
示例值:0
可选值有
- 0: 停用 - 1: 启用 - 2: 未启用
payment_typeint不传入代表全部返回。传入则按照这种应用状态返回。 付费类型 可选值: 0:免费 1:付费
示例值:0
可选值有
- 0: 免费 - 1: 付费
owner_typeint不传入代表全部返回。传入则按照这种应用状态返回。所有者类型,可选值: 0:飞书科技 1:飞书合作伙伴 2:企业内成员
示例值:0
可选值有
- 0: 飞书科技 - 1: 飞书合作伙伴 - 2: 企业内成员

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ app_listapplication\[\]应用列表
    └ app_idstring应用的 app_id
    └ creator_idstring应用创建者(所有者)
    └ statusint应用状态
可选值有
- 0: 停用状态 - 1: 启用状态 - 2: 未启用状态 - 3: 未知状态
    └ scene_typeint应用类型
可选值有
- 0: 自建应用 - 1: 应用商店应用 - 2: 个人应用商店应用 - 3: 未知应用类型
    └ payment_typeint付费类型
可选值有
- 0: 免费 - 1: 付费
    └ create_sourcestring应用创建来源(目前仅Base应用返回)
可选值有
- developer_console: 开发者后台 - base: 多维表格自动化流程创建的应用 - app_engine: 飞书 aPaaS - bot_builder: 机器人助手 - aily: aily(智能伙伴搭建平台) - unknown: 未知来源
    └ redirect_urlsstring\[\]安全设置中的重定向 URL
    └ online_version_idstring发布在线上的应用版本 ID,若没有则为空
    └ unaudit_version_idstring在审核中的版本 ID,若没有则为空
    └ app_namestring应用名称
    └ avatar_urlstring应用图标 url
    └ descriptionstring应用默认描述
    └ scopesapp_scope\[\]应用权限列表
      └ scopestring应用权限
      └ descriptionstring应用权限的国际化描述
      └ levelint权限等级描述
可选值有
- 1: 普通权限 - 2: 高级权限 - 3: 超敏感权限 - 0: 未知等级
    └ back_home_urlstring后台主页地址
    └ i18napp_i18n_info\[\]应用的国际化信息列表
      └ i18n_keystring国际化语言的 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: 韩语
      └ namestring应用国际化名称
      └ descriptionstring应用国际化描述(副标题)
      └ help_usestring国际化帮助文档链接
    └ primary_languagestring应用主语言
可选值有
- zh_cn: 中文 - en_us: 英文 - ja_jp: 日文
    └ common_categoriesstring\[\]应用分类的国际化描述
    └ ownerapplication.owner应用的所有者信息
      └ typeint应用所有者类型
可选值有
- 0: 飞书科技 - 1: 飞书合作伙伴 - 2: 企业内成员
      └ owner_idstring应用所有者ID
      └ namestring应用开发商名称(仅商店应用返回)
      └ help_deskstring应用开发商服务台链接(仅商店应用返回)
      └ emailstring应用开发商的邮箱(仅商店应用返回)
      └ phonestring应用开发商的手机号(仅商店应用返回)
      └ customer_service_accountstring客服账号,仅当商店应用配置了这种联系方式时才会返回
    └ mobile_default_abilitystring移动端默认能力
可选值有
- gadget: 小程序 - web_app: 网页应用 - bot: 机器人
    └ pc_default_abilitystringPC端默认能力
可选值有
- gadget: 小程序 - web_app: 网页应用 - bot: 机器人
  └ page_tokenstring分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token
  └ has_moreboolean是否还有更多项
  └ total_countint当前页面数据里,应用状态为“启用”的应用总数

响应体示例

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状态码错误码描述排查建议
404211005invalid app id检查 app id
500211002internal error内部错误,请联系oncall
400211001invalid param参数错误检查参数
400211003page token 错误检查page token参数是否是之前返回的pagetoken
400211004page size 错误检查是否超出限制
403211006权限缺失检查权限是否满足要求

内容来源:飞书开放平台 · 自动爬取整理