Skip to content

生成 CalDAV 配置

调用该接口为当前用户生成一个 CalDAV 账号密码,用于将飞书日历信息同步到本地设备日历。

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/calendar/v4/settings/generate_caldav_conf
HTTP MethodPOST
接口频率限制1000 次/分钟、50 次/秒
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可calendar:calendar 更新日历及日程信息 calendar:settings.caldav:create 生成 CalDAV 配置信息

请求头

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

请求体

名称类型必填描述
device_namestring需要同步日历的设备名,在日历中用来展示。
默认值:空
示例值:"iPhone"
数据校验规则
- 最大长度:100 字符

请求体示例

json
{
    "device_name": "iPhone"
}

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ passwordstringCalDAV 密码。
  └ user_namestringCalDAV 用户名。
  └ server_addressstring服务器地址
  └ device_namestring设备名。与你发送请求时传入的设备名一致。

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "password": "A67h23sd8",
        "user_name": "ZhangSan",
        "server_address": "caldav.domain.com",
        "device_name": "iPhone"
    }
}

错误码

HTTP状态码错误码描述排查建议
400190002invalid parameters in request无效的请求参数。排查建议如下: - 确认请求参数的字段名称、传参类型正确。 - 确认已经申请了相应资源的权限。 - 确认相应资源未被删除。
500190003internal service error内部服务错误,请咨询技术支持
429190004method rate limited方法频率限制。建议稍后再试,并适当减小请求 QPS。
429190005app rate limited应用频率限制。建议稍后再试,并适当减小请求 QPS。
403190006wrong unit for app tenant请求错误,检查应用 App ID 和 App Secret 是否正确。如仍无法解决请咨询技术支持
404190007app bot_id not found应用的 bot_id 没有找到。你需要确保应用开启了机器人能力。如仍未解决请咨询技术支持
429190010current operation rate limited当前操作被限流,原因一般为公用资源并发抢占失败。你可以适当降低当前操作频率,然后重试。
404195100user is dismiss or not exist in the tenant当前身份或指定用户已经离职,或者不在该租户内。请检查并改为正确的身份来调用接口。

更多错误码信息,参见通用错误码

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