跳转至

consts

feishu.consts

FEISHU_BASE_URL module-attribute

Python
FEISHU_BASE_URL = 'https://open.feishu.cn'

LARK_BASE_URL module-attribute

Python
LARK_BASE_URL = 'https://open.larksuite.com'

REGION_BASE_URLS module-attribute

Python
REGION_BASE_URLS = {'feishu': FEISHU_BASE_URL, 'lark': LARK_BASE_URL}

API_PREFIX module-attribute

Python
API_PREFIX = '/open-apis'

DEFAULT_TIMEOUT module-attribute

Python
DEFAULT_TIMEOUT = 30.0

TOKEN_REFRESH_OFFSET module-attribute

Python
TOKEN_REFRESH_OFFSET = 1800

MIN_TOKEN_TTL module-attribute

Python
MIN_TOKEN_TTL = 10

MAX_PAGE_SIZE module-attribute

Python
MAX_PAGE_SIZE = 50

FEISHU_ACCOUNTS_URL module-attribute

Python
FEISHU_ACCOUNTS_URL = 'https://accounts.feishu.cn'

LARK_ACCOUNTS_URL module-attribute

Python
LARK_ACCOUNTS_URL = 'https://accounts.larksuite.com'

REGION_ACCOUNTS_URLS module-attribute

Python
REGION_ACCOUNTS_URLS = {'feishu': FEISHU_ACCOUNTS_URL, 'lark': LARK_ACCOUNTS_URL}

AUTHORIZE_PATH module-attribute

Python
AUTHORIZE_PATH = 'authen/v1/authorize'

OAUTH_TOKEN_PATH module-attribute

Python
OAUTH_TOKEN_PATH = 'authen/v2/oauth/token'

USER_INFO_PATH module-attribute

Python
USER_INFO_PATH = 'authen/v1/user_info'

resolve_base_url

Python
resolve_base_url(region: str | None, base_url: str | None) -> str

解析开放平台 API 的基础地址。

显式传入的 base_url 优先级最高，会去除末尾斜杠后直接返回；否则按 region 选择内置地址（feishu 对应飞书国内站，lark 对应国际站 Lark）。

参数：

名称 类型 描述 默认

region

str | None

区域标识，feishu 或 lark；为 None 时默认 feishu。

 必需

base_url

str | None

自定义基础地址，传入时优先于 region。

 必需

返回：

类型 描述
str

去除末尾斜杠的基础地址。

引发：

类型 描述
ValueError

当未提供 base_url 且 region 不在内置区域列表中时抛出。

示例：

Python Console Session
1
2
3
4
5
6
>>> resolve_base_url("feishu", None)
'https://open.feishu.cn'
>>> resolve_base_url("lark", None)
'https://open.larksuite.com'
>>> resolve_base_url(None, "https://example.com/")
'https://example.com'
源代码位于： feishu/consts.py
Python
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
def resolve_base_url(region: str | None, base_url: str | None) -> str:
    r"""
    解析开放平台 API 的基础地址。

    显式传入的 `base_url` 优先级最高，会去除末尾斜杠后直接返回；否则按 `region`
    选择内置地址（`feishu` 对应飞书国内站，`lark` 对应国际站 Lark）。

    Args:
        region: 区域标识，`feishu` 或 `lark`；为 `None` 时默认 `feishu`。
        base_url: 自定义基础地址，传入时优先于 `region`。

    Returns:
        去除末尾斜杠的基础地址。

    Raises:
        ValueError: 当未提供 `base_url` 且 `region` 不在内置区域列表中时抛出。

    Examples:
        >>> resolve_base_url("feishu", None)
        'https://open.feishu.cn'
        >>> resolve_base_url("lark", None)
        'https://open.larksuite.com'
        >>> resolve_base_url(None, "https://example.com/")
        'https://example.com'
    """
    if base_url is not None:
        return base_url.rstrip("/")
    region = region or "feishu"
    if region not in REGION_BASE_URLS:
        raise ValueError(f"unknown region {region!r}; expected one of {sorted(REGION_BASE_URLS)}")
    return REGION_BASE_URLS[region]

resolve_accounts_url

Python
resolve_accounts_url(region: str | None, accounts_url: str | None = None) -> str

解析用户 OAuth 授权页所在的账号中心地址。

显式传入的 accounts_url 优先级最高，会去除末尾斜杠后直接返回；否则按 region 选择内置地址。该地址用于拼接用户登录授权（consent）链接，与 feishu.consts.resolve_base_url 返回的 API 基础地址不同。

参数：

名称 类型 描述 默认

region

str | None

区域标识，feishu 或 lark；为 None 时默认 feishu。

 必需

accounts_url

str | None

自定义账号中心地址，传入时优先于 region。

 None

返回：

类型 描述
str

去除末尾斜杠的账号中心地址。

引发：

类型 描述
ValueError

当未提供 accounts_url 且 region 不在内置区域列表中时抛出。
飞书文档

获取登录预授权码

示例：

Python Console Session
1
2
3
4
>>> resolve_accounts_url("feishu", None)
'https://accounts.feishu.cn'
>>> resolve_accounts_url("feishu", "https://accounts.internal.example.com/")
'https://accounts.internal.example.com'
源代码位于： feishu/consts.py
Python
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
def resolve_accounts_url(region: str | None, accounts_url: str | None = None) -> str:
    r"""
    解析用户 OAuth 授权页所在的账号中心地址。

    显式传入的 `accounts_url` 优先级最高，会去除末尾斜杠后直接返回；否则按
    `region` 选择内置地址。该地址用于拼接用户登录授权（consent）链接，与
    [feishu.consts.resolve_base_url][] 返回的 API 基础地址不同。

    Args:
        region: 区域标识，`feishu` 或 `lark`；为 `None` 时默认 `feishu`。
        accounts_url: 自定义账号中心地址，传入时优先于 `region`。

    Returns:
        去除末尾斜杠的账号中心地址。

    Raises:
        ValueError: 当未提供 `accounts_url` 且 `region` 不在内置区域列表中时抛出。

    飞书文档:
        [获取登录预授权码](https://open.feishu.cn/document/server-docs/authentication-management/login-state-management/obtain-code)

    Examples:
        >>> resolve_accounts_url("feishu", None)
        'https://accounts.feishu.cn'
        >>> resolve_accounts_url("feishu", "https://accounts.internal.example.com/")
        'https://accounts.internal.example.com'
    """
    if accounts_url is not None:
        return accounts_url.rstrip("/")
    region = region or "feishu"
    if region not in REGION_ACCOUNTS_URLS:
        raise ValueError(f"unknown region {region!r}; expected one of {sorted(REGION_ACCOUNTS_URLS)}")
    return REGION_ACCOUNTS_URLS[region]