批量开启系统状态

POST

https://open.feishu.cn/open-apis/personal_settings/v1/system_statuses/{system_status_id}/batch_open

错误码

HTTP状态码	错误码	描述	排查建议
400	2005001	Your request contains an invalid request parameter.	参数错误，请根据接口返回的错误信息并参考文档检查输入参数。
400	2005006	Request contains other tenant user.	请检查用户ID是否为本租户ID。
400	2005007	Tenant does not have permission to api.	租户没有访问api权限。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://open.feishu.cn/open-apis/personal_settings/v1/system_statuses//batch_open?user_id_type=' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "user_list": [
        {
            "user_id": "ou_53edd3282dbc2fdbe5c593cfa5ce82ab",
            "end_time": "1665990378"
        }
    ]
}'

响应示例

{
  "code": 0,
  "msg": "success",
  "data": {
    "result_list": [
      {
        "user_id": "ou_53edd3282dbc2fdbe5c593cfa5ce82ab",
        "end_time": "1665990378",
        "result": "success_show"
      }
    ]
  }
}

请求参数

Path 参数

system_status_id

string

必需

系统状态ID

获取系统状态ID

示例值："7101214603622940672"

Query 参数

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，字段权限要求：

获取用户 user ID

Header 参数

Authorization

string

必需

tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560"

默认值:

Bearer {{access_token}}

Content-Type

string

必需

固定值："application/json; charset=utf-8"

默认值:

application/json; charset=utf-8

Body 参数application/json

user_list

array [object {2}]

必需

开启列表数据校验规则：长度范围：1 ～ 50

user_id

string

可选

用户ID，传入的ID类型由user_id_type决定，推荐使用 OpenID，获取方式可参考文档如何获取 Open ID。示例值："ou_53edd3282dbc2fdbe5c593cfa5ce82ab"

end_time

string

可选

结束时间，传入的应为秒单位的时间戳，距当前的时间跨度不能超过365天。示例值："1665990378"

示例

返回响应

🟢200成功

application/json

Body

code

integer

必需

错误码，非 0 表示失败

msg

string

错误描述

必需

data

object

必需

result_list

array [object {3}]

开启结果

必需

获取系统状态

批量关闭系统状态

批量开启系统状态

错误码#

请求参数

返回响应

错误码