获取管理员推荐的应用
获取管理员推荐的应用。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/application/v5/applications/recommend |
| HTTP Method | GET |
| 接口频率限制 | 1000 次/分钟、50 次/秒 |
| 支持的应用类型 | custom |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 | admin:app.info:readonly 获取应用信息 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | user_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
language | string | 否 | 应用信息的语言版本 示例值:"zh_cn" 可选值有: - zh_cn: 中文 - en_us: 英文 - ja_jp: 日文 |
recommend_type | string | 否 | 推荐应用类型,默认为用户不可移除的推荐应用列表 示例值:"user_unremovable" 可选值有: - user_unremovable: 用户不可移除的推荐应用列表 - user_removable: 用户可移除的推荐应用列表默认值: user_unremovable |
page_token | string | 否 | 分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果 示例值:"new-e11ee058b4a8ed2881da11ac7e37c4fc" |
page_size | int | 否 | 分页大小 示例值:10 默认值: 10 |
响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ page_token | string | 分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token |
└ page_size | int | 分页数量 |
└ total_count | int | 总的数量 |
└ has_more | boolean | 是否还有更多项 |
└ app_list | application\[\] | 应用数据列表 |
└ app_id | string | 应用ID |
└ app_name | string | 应用名 |
└ description | string | 应用描述 |
└ app_type | string | 应用类型 可选值有: - app: 普通应用 - shortcut: 快捷入口 |
└ avatar_url | string | 应用图标 |
└ open_methods | open_method\[\] | 可以打开应用的方式, 包含移动端小程序applink、移动端网页applink、PC端小程序applink、移动端小程序applink、PC端网页applink、机器人applink |
└ type | string | applink类型 可选值有: - mobile_gadget: 移动端小程序 - mobile_web: 移动端Web - pc_gadget: pc端小程序 - pc_web: pc端web - bot: 机器人 |
└ applink | string | applink链接 |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"page_token": "new-e11ee058b4a8ed2881da11ac7e37c4fc",
"page_size": 10,
"total_count": 7,
"has_more": false,
"app_list": [
{
"app_id": "cli_9f9f8825d53xxxx",
"app_name": "效率工具",
"description": "提升办公效率的一款应用效率工具",
"app_type": "app",
"avatar_url": "https://s1-xxxxxx/static-resource/v1/ca597e6e-28c1-4178-961a-1xxxxx",
"open_methods": [
{
"type": "mobile_gadget",
"applink": "https://applink.feishu.cn/client/web_app/open?appId=cli_9f9f8825d53xxxx"
}
]
}
]
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 400 | 213001 | user_id is invalid | 检查用户身份信息是否正确 |
| 400 | 213002 | page_size is invalid | 请检查 page_size 范围是否在指定范围内 |
| 400 | 213003 | page_token is invalid | page_token 在应用间不互通,请检查该 page_token 是否由调用接口的应用获取到 |
| 400 | 213004 | request param is invalid | 检查请求参数是否合法 |
| 400 | 213006 | get recommend apps fail | 服务器内部错误,请联系技术支持 |
| 409 | 213007 | get apps detail fail | 服务器内部错误,请联系技术支持 |
| 409 | 213008 | get visibility fail | 服务器内部错误,请联系技术支持 |
