获取当前设置的推荐规则列表

获取当前设置的推荐规则列表。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/application/v6/app_recommend_rules
HTTP Method	GET
支持的应用类型	custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	application:app_recommend_rule:readonly 获取应用的推荐规则信息
字段权限要求	> Tip: 该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头

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

查询参数

名称	类型	必填	描述
page_size	int	是	分页大小 示例值：10 数据校验规则： - 最大值：50
page_token	string	否	分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 示例值："new-e11ee058b4a8ed2881da11ac7e37c4fc"
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	\-	-
└ rules	app_recommend_rule\[\]	推荐规则列表
└ id	string	推荐规则 ID
└ name	string	推荐规则名称
└ status	string	推荐规则启用状态 可选值有： - open: 启用 - closed: 停用
└ visibility_info	app_recommend_rule.visibility_info	推荐规则可见性信息
└ is_all	boolean	是否全员可见
└ department_ids	string\[\]	可见部门 ID 列表
└ user_ids	string\[\]	可见用户 ID 列表
└ group_ids	string\[\]	可见用户组 ID 列表
└ recommend_item_infos	app_recommend_rule.item_info\[\]	不可移除推荐应用项列表
└ item_id	string	推荐应用项 ID
└ item_type	string	推荐应用项类型 可选值有： - application: 应用类型 - link: 链接类型
└ name	string	推荐应用项名称
└ description	string	推荐应用项描述
└ link_url	string	链接类型应用项的跳转链接（应用类型该字段为空）
└ client_id	string	应用类型应用项的 app id（链接类型该字段为空）
└ icon_url	string	应用项图标链接
└ default_locale	string	链接类型应用项的默认展示语种（应用类型该字段为空） 可选值有： - zh_cn: 简体中文 - zh_hk: 繁体中文（中国香港） - zh_tw: 繁体中文（中国台湾） - en_us: 英文 - ja_jp: 日文
└ i18n_name	app_recommend_rule.item_info.i18n_name	应用项的多语种名称
└ zh_cn	string	应用项的简体中文名称
└ zh_hk	string	应用项的繁体中文（中国香港）名称
└ zh_tw	string	应用项的繁体中文（中国台湾）名称
└ en_us	string	应用项的英文名称
└ ja_jp	string	应用项的日文名称
└ distributed_recommend_item_infos	app_recommend_rule.item_info\[\]	可移除推荐应用项列表
└ item_id	string	推荐应用项 ID
└ item_type	string	推荐应用项类型 可选值有： - application: 应用类型 - link: 链接类型
└ name	string	推荐应用项名称
└ description	string	推荐应用项描述
└ link_url	string	链接类型应用项的跳转链接（应用类型该字段为空）
└ client_id	string	应用类型应用项的 app id（链接类型该字段为空）
└ icon_url	string	应用项图标链接
└ default_locale	string	链接类型应用项的默认展示语种（应用类型该字段为空） 可选值有： - zh_cn: 简体中文 - zh_hk: 繁体中文（中国香港） - zh_tw: 繁体中文（中国台湾） - en_us: 英文 - ja_jp: 日文
└ i18n_name	app_recommend_rule.item_info.i18n_name	应用项的多语种名称
└ zh_cn	string	应用项的简体中文名称
└ zh_hk	string	应用项的繁体中文（中国香港）名称
└ zh_tw	string	应用项的繁体中文（中国台湾）名称
└ en_us	string	应用项的英文名称
└ ja_jp	string	应用项的日文名称
└ page_token	string	分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token
└ has_more	boolean	是否还有更多项

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "rules": [
            {
                "id": "7137896480337641492",
                "name": "管理员小白的推荐规则",
                "status": "open",
                "visibility_info": {
                    "is_all": true,
                    "department_ids": [
                        "od-fef5204d44fa03fad66278cb8e8036e4"
                    ],
                    "user_ids": [
                        "ou_35101d538d5b3ad10a5f3480f4c27972"
                    ],
                    "group_ids": [
                        "7137608198773686291"
                    ]
                },
                "recommend_item_infos": [
                    {
                        "item_id": "7137896480337625108",
                        "item_type": "application",
                        "name": "审批",
                        "description": "审批应用的描述",
                        "link_url": "http://www.example.com",
                        "client_id": "cli_a274440757b8901c",
                        "icon_url": "https://internal-api-lark-file.feishu-boe.cn/static-resource/v1/v2_6150f3c3-ceee-453e-a1ae-7c11d7f13edj~?image_size=&cut_type=&quality=&format=&sticker_format=.webp",
                        "default_locale": "zh_cn",
                        "i18n_name": {
                            "zh_cn": "审批",
                            "zh_hk": "審批",
                            "zh_tw": "審批",
                            "en_us": "Approval",
                            "ja_jp": "承認"
                        }
                    }
                ],
                "distributed_recommend_item_infos": [
                    {
                        "item_id": "7137896480337625108",
                        "item_type": "application",
                        "name": "审批",
                        "description": "审批应用的描述",
                        "link_url": "http://www.example.com",
                        "client_id": "cli_a274440757b8901c",
                        "icon_url": "https://internal-api-lark-file.feishu-boe.cn/static-resource/v1/v2_6150f3c3-ceee-453e-a1ae-7c11d7f13edj~?image_size=&cut_type=&quality=&format=&sticker_format=.webp",
                        "default_locale": "zh_cn",
                        "i18n_name": {
                            "zh_cn": "审批",
                            "zh_hk": "審批",
                            "zh_tw": "審批",
                            "en_us": "Approval",
                            "ja_jp": "承認"
                        }
                    }
                ]
            }
        ],
        "page_token": "new-e11ee058b4a8ed2881da11ac7e37c4fc",
        "has_more": true
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
400	210500	page_token does not exist or has expired	请检查 page_token 是否合法，page_token 过期时间为 2h，若超过 2h 请重新获取
400	210501	invalid page_token	page_token 在应用间不互通，请检查该 page_token 是否由调用接口的应用获取到
400	210502	page_size out of range, should be between 1 and 50	请检查 page_size 范围是否在 [1, 50] 范围内