Skip to content

获取事件出口 IP

飞书开放平台向应用配置的回调地址推送事件时,是通过特定的 IP 发送出去的,应用可以通过本接口获取所有相关的 IP 地址。

Tip: IP 地址有变更可能,建议定期拉取最新 IP 地址,并自动更新至防火墙规则。此外, IP 变更时,开放平台将会推送卡片消息和发布更新日志提前告知开发者。

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/event/v1/outbound_ip
HTTP MethodGET
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用event:ip_list 获取事件的出口 IP

请求头

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

查询参数

名称类型必填描述
page_sizeint分页大小
示例值:10
数据校验规则: - 最大值:50
page_tokenstring分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果
示例值:"xxx"

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ ip_liststring\[\]outbound ip
  └ page_tokenstring分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token
  └ has_moreboolean是否还有更多项

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "ip_list": [
            "1.1.1.1"
        ],
        "page_token": "xxx",
        "has_more": false
    }
}

错误码

HTTP状态码错误码描述排查建议
4001810001param is invalid检查分页参数是否正确

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