获取通道信息

根据通道的ID批量获取通道的名称、编码、描述信息

Tip: 延迟说明：数据库主从延迟2s以内，即：创建通道后2s内调用此接口可能查询不到数据。

Warning: 由于该接口为ByID批量查询接口，当请求参数中的某个通道ID错误或者被删除时，接口不会报错。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/corehr/v2/pathways/batch_get
HTTP Method	POST
接口频率限制	1000 次/分钟、50 次/秒
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可	corehr:pathway:read 获取通道信息 corehr:pathway:write 读写通道信息

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 值格式："Bearer access_token" 示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token
Content-Type	string	是	固定值："application/json; charset=utf-8"

查询参数

名称	类型	必填	描述
page_size	int	否	分页大小，最大 100，默认100 示例值：100 默认值：100 数据校验规则： - 取值范围：1 ～ 100
page_token	string	否	分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 示例值：6891251722631890445

请求体

名称	类型	必填	描述
pathway_ids	string\[\]	否	通道 ID 列表，不填则不做筛选，ID获取方式 - 调用创建通道接口后，从响应结果的pathway_id获取。 - 监听通道创建事件，当触发该事件后可从事件体内获取pathway_id - 监听通道更新事件，当触发该事件后可从事件体内获取pathway_id - 监听通道删除事件，当触发该事件后可从事件体内获取pathway_id 示例值：["4692446793125560154"] 数据校验规则： - 长度范围：1 ～ 100
pathway_codes	string\[\]	否	通道 code 列表，不填则不做筛选 示例值：["A1234"] 数据校验规则： - 长度范围：1 ～ 100
active	boolean	否	是否启用，不填则不做筛选 示例值：true

请求体示例

{
    "pathway_ids": [
        "4692446793125560154"
    ],
    "pathway_codes": [
        "A1234"
    ],
    "active": true
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ items	pathway\[\]	查询的通道信息
└ pathway_id	string	通道 ID
└ code	string	编码
└ names	i18n\[\]	名称
└ lang	string	中文用zh-CN，英文用en-US
└ value	string	文本内容
└ descriptions	i18n\[\]	描述
└ lang	string	中文用zh-CN，英文用en-US
└ value	string	文本内容
└ active	boolean	停启用状态；true：启用，false：停用
└ page_token	string	分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token
└ has_more	boolean	是否还有更多项

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "items": [
            {
                "pathway_id": "4692446793125560154",
                "code": "A01234",
                "names": [
                    {
                        "lang": "zh-CN",
                        "value": "中文示例"
                    }
                ],
                "descriptions": [
                    {
                        "lang": "zh-CN",
                        "value": "中文示例"
                    }
                ],
                "active": true
            }
        ],
        "page_token": "eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0=",
        "has_more": true
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
429	1161604	QPS over limit	请先参考全量错误码详细描述进行错误排查，如问题始终无法解决请联系技术支持

其他错误码参考: 全量错误码详细描述