获取应用信息

根据app_id获取应用的基础信息

Tip: 商店应用必须正式发布版本后，才可以调用该接口获取应用信息。如果灰度发布应用，调用该接口将会报错 210504 错误码。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/application/v6/applications/:app_id
HTTP Method	GET
接口频率限制	50 次/秒
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可	application:application:self_manage 管理应用自身资源 admin:app.info:readonly 获取应用信息
字段权限要求	> Tip: 该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头

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

路径参数

名称	类型	描述
app_id	string	应用的 app_id，需要查询其他应用信息时，必须申请获取应用信息权限，仅查询本应用信息时，可填入 "me" 或者应用自身 app_id 示例值："cli_9b445f5258795107"

查询参数

名称	类型	必填	描述
lang	string	是	指定获取应用在该语言下的信息 示例值：zh_cn 可选值有： - zh_cn: 中文 - en_us: 英文 - ja_jp: 日文 数据校验规则： - 最小长度：1 字符
user_id_type	string	否	用户 ID 类型 示例值：open_id 可选值有： - open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多：如何获取 Open ID - union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多：如何获取 Union ID？ - user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多：如何获取 User ID？ 默认值：open_id 当值为 user_id，字段权限要求： contact:user.employee_id:readonly 获取用户 user ID

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ app	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: 未知等级
└ token_types	string\[\]	返回用户身份类型user、应用身份类型tenant。如果两种类型都支持，则同时返回两个。 可选值有： - tenant: 应用身份类型 - user: 用户身份类型
└ 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: 机器人

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "app": {
            "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,
                    "token_types": [
                        "user"
                    ]
                }
            ],
            "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"
        }
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
400	210503	invalid app_id	请检查请求路径中的 app_id 是否合法
400	210504	no such app in tenant	请检查被查询应用与当前调用接口应用是否在同一企业内
400	210505	target app not a custom app	请检查被查询应用是否是自建应用
400	210506	no such app	请检查请求路径中的 app_id 是否存在
400	210508	insufficient permission level	请检查应用已申请权限与被查询 app_id，当被查询 app_id 非本应用且未申请获取应用版本信息权限时，返回该错误码