飞书开放平台 Server API 文档

主题

修改系统状态 ​

修改租户维度系统状态。

Tip: 注意事项：

  • 修改系统状态对已经开启过该系统状态的用户无效。
  • 操作的数据为租户维度数据，请小心操作。
  • 修改系统状态后，并不影响正在使用的用户。该用户的系统状态可用时间到期后，再次被开启可用的时候，用户客户端才会同步到更新后的系统状态。

请求 ​

项目值
HTTP URLhttps://open.feishu.cn/open-apis/personal_settings/v1/system_statuses/:system_status_id
HTTP MethodPATCH
接口频率限制100 次/分钟
支持的应用类型custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用personal_settings:status:system_status_update 获取与更新系统状态

请求头 ​

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

路径参数 ​

名称类型描述
system_status_idstring系统状态ID
获取系统状态ID
示例值："7101214603622940633"

请求体 ​

名称类型必填描述
system_statussystem_status是系统状态
  └ titlestring是系统状态名称，名称字符数要在1到20范围内。不同系统状态的title不能重复。
注意： - 1中文=2英文=2其他语言字符=2字符
示例值："出差"
  └ i18n_titlesystem_status_i18n_name否系统状态国际化名称，名称字符数要在1到20范围内。不同系统状态之间i18n_title中任何一种title都不能重复。
注意： - 1中文=2英文=2其他语言字符=2字符
    └ zh_cnstring否中文名
示例值："出差"
    └ en_usstring否英文名
示例值："On business trip"
    └ ja_jpstring否日文名
示例值："出張中"
  └ icon_keystring是图标
了解icon_key可选值
示例值："GeneralBusinessTrip"
可选值有：
- GeneralDoNotDisturb: GeneralDoNotDisturb - GeneralInMeetingBusy: GeneralInMeetingBusy - Coffee: Coffee - GeneralBusinessTrip: GeneralBusinessTrip - GeneralWorkFromHome: GeneralWorkFromHome - StatusEnjoyLife: StatusEnjoyLife - GeneralTravellingCar: GeneralTravellingCar - StatusBus: StatusBus - StatusInFlight: StatusInFlight - Typing: Typing - EatingFood: EatingFood - SICK: SICK - GeneralSun: GeneralSun - GeneralMoonRest: GeneralMoonRest - StatusReading: StatusReading - Status_PrivateMessage: Status_PrivateMessage - StatusFlashOfInspiration: StatusFlashOfInspiration - GeneralVacation: GeneralVacation
  └ colorstring否颜色
示例值："BLUE"
可选值有：
- BLUE: 蓝色 - GRAY: 灰色 - INDIGO: 靛青色 - WATHET: 浅蓝色 - GREEN: 绿色 - TURQUOISE: 绿松石色 - YELLOW: 黄色 - LIME: 酸橙色 - RED: 红色 - ORANGE: 橙色 - PURPLE: 紫色 - VIOLET: 紫罗兰色 - CARMINE: 胭脂红色
默认值：BLUE
  └ priorityint否优先级，数值越小，客户端展示的优先级越高。不同系统状态的优先级不能一样。
示例值：1
默认值：0
数据校验规则：
- 取值范围：0 ～ 9
  └ sync_settingsystem_status_sync_setting否同步设置
    └ is_open_by_defaultboolean否是否默认开启
示例值：true
默认值：true
    └ titlestring否同步设置名称，名称字符数要在1到30范围内。
注意： - 1中文=2英文=2其他语言字符=2字符
示例值："出差期间自动开启"
默认值：自动开启
    └ i18n_titlesystem_status_sync_i18n_name否同步设置国际化名称，名称字符数要在1到30范围内。
注意： - 1中文=2英文=2其他语言字符=2字符
      └ zh_cnstring否中文名
示例值："出差期间自动开启"
      └ en_usstring否英文名
示例值："Auto display Business Trip"
      └ ja_jpstring否日文名
示例值："出張中に自動的にオンにする"
    └ explainstring否同步设置解释文案，解释字符数要在1到60范围内。
注意： - 1中文=2英文=2其他语言字符=2字符
示例值："出差审批通过后，将自动开启并优先展示该状态。"
默认值：从相关系统进行信息同步，同步后将自动开启并优先展示该状态。
    └ i18n_explainsystem_status_sync_i18n_explain否同步设置国际化解释文案，解释字符数要在1到60范围内。
注意： - 1中文=2英文=2其他语言字符=2字符
      └ zh_cnstring否中文名
示例值："出差审批通过后，该状态将自动开启并优先展示"
      └ en_usstring否英文名
示例值："Auto-display after travel request is approved."
      └ ja_jpstring否日文名
示例值："申請が承認されると、このステータスが優先的に表示されます"
update_fieldsstring\[\]是需要更新的字段
示例值：["ICON"]
可选值有：
- TITLE: 系统状态名称 - I18N_TITLE: 系统状态国际化名称 - ICON: 图标 - COLOR: 颜色 - PRIORITY: 优先级 - SYNC_SETTING: 同步设置
数据校验规则：
- 最小长度：1

请求体示例 ​

json
{
    "system_status": {
        "title": "出差",
        "i18n_title": {
            "zh_cn": "出差",
            "en_us": "On business trip",
            "ja_jp": "出張中"
        },
        "icon_key": "GeneralBusinessTrip",
        "color": "BLUE",
        "priority": 1,
        "sync_setting": {
            "is_open_by_default": true,
            "title": "出差期间自动开启",
            "i18n_title": {
                "zh_cn": "出差期间自动开启",
                "en_us": "Auto display Business Trip",
                "ja_jp": "出張中に自動的にオンにする"
            },
            "explain": "出差审批通过后，将自动开启并优先展示该状态。",
            "i18n_explain": {
                "zh_cn": "出差审批通过后，该状态将自动开启并优先展示",
                "en_us": "Auto-display after travel request is approved.",
                "ja_jp": "申請が承認されると、このステータスが優先的に表示されます"
            }
        }
    },
    "update_fields": [
        "ICON"
    ]
}

响应 ​

响应体 ​

名称类型描述
codeint错误码，非 0 表示失败
msgstring错误描述
data\--
  └ system_statussystem_status系统状态
    └ system_status_idstring系统状态ID
    └ titlestring系统状态名称，名称字符数要在1到20范围内。不同系统状态的title不能重复。
注意： - 1中文=2英文=2其他语言字符=2字符
    └ i18n_titlesystem_status_i18n_name系统状态国际化名称，名称字符数要在1到20范围内。不同系统状态之间i18n_title中任何一种title都不能重复。
注意： - 1中文=2英文=2其他语言字符=2字符
      └ zh_cnstring中文名
      └ en_usstring英文名
      └ ja_jpstring日文名
    └ icon_keystring图标
了解icon_key可选值
可选值有：
- GeneralDoNotDisturb: GeneralDoNotDisturb - GeneralInMeetingBusy: GeneralInMeetingBusy - Coffee: Coffee - GeneralBusinessTrip: GeneralBusinessTrip - GeneralWorkFromHome: GeneralWorkFromHome - StatusEnjoyLife: StatusEnjoyLife - GeneralTravellingCar: GeneralTravellingCar - StatusBus: StatusBus - StatusInFlight: StatusInFlight - Typing: Typing - EatingFood: EatingFood - SICK: SICK - GeneralSun: GeneralSun - GeneralMoonRest: GeneralMoonRest - StatusReading: StatusReading - Status_PrivateMessage: Status_PrivateMessage - StatusFlashOfInspiration: StatusFlashOfInspiration - GeneralVacation: GeneralVacation
    └ colorstring颜色
可选值有：
- BLUE: 蓝色 - GRAY: 灰色 - INDIGO: 靛青色 - WATHET: 浅蓝色 - GREEN: 绿色 - TURQUOISE: 绿松石色 - YELLOW: 黄色 - LIME: 酸橙色 - RED: 红色 - ORANGE: 橙色 - PURPLE: 紫色 - VIOLET: 紫罗兰色 - CARMINE: 胭脂红色
    └ priorityint优先级，数值越小，客户端展示的优先级越高。不同系统状态的优先级不能一样。
    └ sync_settingsystem_status_sync_setting同步设置
      └ is_open_by_defaultboolean是否默认开启
      └ titlestring同步设置名称，名称字符数要在1到30范围内。
注意： - 1中文=2英文=2其他语言字符=2字符
      └ i18n_titlesystem_status_sync_i18n_name同步设置国际化名称，名称字符数要在1到30范围内。
注意： - 1中文=2英文=2其他语言字符=2字符
        └ zh_cnstring中文名
        └ en_usstring英文名
        └ ja_jpstring日文名
      └ explainstring同步设置解释文案，解释字符数要在1到60范围内。
注意： - 1中文=2英文=2其他语言字符=2字符
      └ i18n_explainsystem_status_sync_i18n_explain同步设置国际化解释文案，解释字符数要在1到60范围内。
注意： - 1中文=2英文=2其他语言字符=2字符
        └ zh_cnstring中文名
        └ en_usstring英文名
        └ ja_jpstring日文名

响应体示例 ​

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "system_status": {
            "system_status_id": "7101214603622940633",
            "title": "出差",
            "i18n_title": {
                "zh_cn": "出差",
                "en_us": "On business trip",
                "ja_jp": "出張中"
            },
            "icon_key": "GeneralBusinessTrip",
            "color": "BLUE",
            "priority": 1,
            "sync_setting": {
                "is_open_by_default": true,
                "title": "出差期间自动开启",
                "i18n_title": {
                    "zh_cn": "出差期间自动开启",
                    "en_us": "Auto display Business Trip",
                    "ja_jp": "出張中に自動的にオンにする"
                },
                "explain": "出差审批通过后，将自动开启并优先展示该状态。",
                "i18n_explain": {
                    "zh_cn": "出差审批通过后，该状态将自动开启并优先展示",
                    "en_us": "Auto-display after travel request is approved.",
                    "ja_jp": "申請が承認されると、このステータスが優先的に表示されます"
                }
            }
        }
    }
}

错误码 ​

HTTP状态码错误码描述排查建议
4002005001Your request contains an invalid request parameter.参数错误，请根据接口返回的错误信息并参考文档检查输入参数。
4002005002The same name or i18n name has already be created within your tenant.该名称或国际化名称中所对应的系统状态已经被创建，请使用其他名称。
4002005003Name or i18n name contains sensitive words.该名称或国际化名称包含敏感词，请使用其他名称。
4002005005The priority of tenant system status has already be created within your tenant.不同系统状态的优先级不可以重复。使用其他的优先级，或者调整其他系统状态的优先级。
4002005007Tenant does not have permission to api.租户没有访问api权限。

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

本镜像仅供学习与查阅，文档版权归飞书所有