批量获取主日历信息

根据user id列表批量查询指定用户的主日历信息。

Tip: 如果使用应用身份调用该接口，则需要确保应用开启了机器人能力。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/calendar/v4/calendars/primarys
HTTP Method	POST
接口频率限制	1000 次/分钟、50 次/秒
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可	calendar:calendar:read 读取日历信息 calendar:calendar:readonly 获取日历、日程及忙闲信息
字段权限要求	> Tip: 该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头

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

查询参数

名称	类型	必填	描述
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，字段权限要求： contact:user.employee_id:readonly 获取用户 user ID

请求体

名称	类型	必填	描述
user_ids	string\[\]	是	用户 ID 列表，多个 ID 的取值格式为 ["ou_c186b6833e2d5faf2bc587e71ddabcef", "ou_7d8a6e6df7621556ce0d21922b676706"]。 需要传入与查询参数 user_id_type 相匹配的 ID。例如，user_id_type=open_id 时，需要传入用户的 open_id。了解用户 ID 参见用户相关的 ID 概念。 示例值：["ou_c186b6833e2d5faf2bc587e71ddabcef"] 数据校验规则： - 长度范围：1 ～ 10

请求体示例

{
    "user_ids": [
        "ou_c186b6833e2d5faf2bc587e71ddabcef"
    ]
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ calendars	user_calendar\[\]	主日历列表。
└ calendar	calendar	日历实体信息。
└ calendar_id	string	日历 ID。后续可以通过该 ID 查询、更新或删除日历信息。更多信息可参见日历 ID 字段说明。
└ summary	string	日历标题。
└ description	string	日历描述。
└ permissions	string	日历公开范围。 可选值有： - private: 私密 - show_only_free_busy: 仅展示忙闲信息 - public: 公开，他人可查看日程详情
└ color	int	日历颜色，由颜色 RGB 值的 int32 表示。实际在客户端展示时会映射到色板上最接近的一种颜色，且该字段仅对当前身份生效。
└ type	string	日历类型。 可选值有： - unknown: 未知类型 - primary: 用户或应用的主日历 - shared: 由用户或应用创建的共享日历 - google: 用户绑定的谷歌日历 - resource: 会议室日历 - exchange: 用户绑定的 Exchange 日历
└ summary_alias	string	日历备注名，仅对当前身份生效。
└ is_deleted	boolean	对于当前身份，日历是否已经被标记为删除。true表示已删除。
└ is_third_party	boolean	当前日历是否是第三方数据。三方日历及日程只支持读，不支持写入。
└ role	string	当前身份对于该日历的访问权限。 可选值有： - unknown: 未知权限 - free_busy_reader: 游客，只能看到忙碌、空闲信息 - reader: 订阅者，可查看所有日程详情 - writer: 编辑者，可创建及修改日程 - owner: 管理员，可管理日历及共享设置
└ user_id	string	日历创建者的用户 ID，根据查询参数 user_id_type 设置的 ID 类型进行返回。

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "calendars": [
            {
                "calendar": {
                    "calendar_id": "feishu.cn_xxxxxxxxxx@group.calendar.feishu.cn",
                    "summary": "测试日历",
                    "description": "使用开放接口创建日历",
                    "permissions": "private",
                    "color": -1,
                    "type": "primary",
                    "summary_alias": "日历备注名",
                    "is_deleted": false,
                    "is_third_party": false,
                    "role": "reader"
                },
                "user_id": "ou_c186b6833e2d5faf2bc587e71ddabcef"
            }
        ]
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
400	190002	invalid parameters in request	无效的请求参数。排查建议如下： - 确认请求参数的字段名称、传参类型正确。 - 确认已经申请了相应资源的权限。 - 确认相应资源未被删除。
500	190003	internal service error	内部服务错误，请咨询技术支持。
429	190004	method rate limited	方法频率限制。建议稍后再试，并适当减小请求 QPS。
429	190005	app rate limited	应用频率限制。建议稍后再试，并适当减小请求 QPS。
403	190006	wrong unit for app tenant	请求错误，检查应用 App ID 和 App Secret 是否正确。如仍无法解决请咨询技术支持。
404	190007	app bot_id not found	应用的 bot_id 没有找到。你需要确保应用开启了机器人能力。如仍未解决请咨询技术支持。
429	190010	current operation rate limited	当前操作被限流，原因一般为公用资源并发抢占失败。你可以适当降低当前操作频率，然后重试。
404	191000	calendar not found	日历没有找到。你需要检查并改为正确的日历 ID。
400	191001	invalid calendar_id	calendar_id 无效。你需要检查并改为正确的日历 ID。
403	191002	no calendar access_role	当前身份没有日历的访问权限。如需查询日历信息，则需要确保当前身份拥有该日历的访问权限。
403	191003	calendar is deleted	日历被删除。无法查询被删除的日历。
403	191004	invalid calendar type	日历类型错误。你可以调用查询日历信息接口获取日历类型信息，然后确保日历类型适用于当前接口。
404	195100	user is dismiss or not exist in the tenant	当前身份或指定用户已经离职，或者不在该租户内。请检查并改为正确的身份来调用接口。
400	198001	the number of user IDs exceeds the limit	用户 ID 列表的数量为 0 或超出了数量的最大值。你需要确保传入的 ID 数量符合参数的数据校验规则。

更多错误码信息，参见通用错误码。