更新事件日历
接受事件日历信息和待更新事件Id,同步更新事件日历信息。
该接口用于企业应用中需要更新事件日历的场景。通过本接口,应用可以将更新后的事件日历信息推送给WeLink端用户。
请求格式说明
请求方式: PUT(HTTPS)
请求地址:
https://open.welink.huaweicloud.com/api/calendar/v1/events/update
认证方式: access_token,请参考获取access_token
请求头部:
Content-Type: application/json
x-wlk-Authorization: access_token
请求参数:
{
"receiverUserList":[
"a@calendar",
"b@calendar",
"c@calendar"
],
"content": "第3届运动会",
"startTime": "1606322342000",
"endTime": "1606322542000",
"location": "体育馆",
"reminder": {
"minutes": 30
},
"source": {
"title": "运动化宣传资料",
"url": "http://www.sports.com"
},
"summary": "运动会",
"calUid":"待更新日历id"
}
请求参数说明:
参数 | 参数类型 | 必填 | 说明 |
---|---|---|---|
content | String | 否 | 内容 |
summary | String | 否 | 综述 |
calUid | String | 是 | 待更新日历Uid |
receiverUserList | Array[String] | 是 | 接受者ID集合,最大容量500 |
reminder | Object | 否 | 具体参数参考下文 |
source | Object | 否 | 具体参数参考下文 |
startTime | String | 否 | 开始时间,UTC时间,毫秒级 |
endTime | String | 否 | 结束时间,UTC时间,毫秒级 |
location | String | 否 | 地址 |
recurrence | Object | 否 | 日历重复规则,如每周三和周五的早上八点 |
- reminder 参数说明
参数式 | 数据类型 | 必填 | 说明 |
---|---|---|---|
minutes | int | 否 | 距开始时多久进行提醒(单位:分钟) |
remindType | string | 否 | 提醒类型 |
- source 参数说明
参数 | 数据类型 | 必填 | 说明 |
---|---|---|---|
title | String | 否 | 标题 |
urls | Array[String] | 否 | URL列表 |
- reccurence 参数说明
参数 | 数据类型 | 必填 | 说明 |
---|---|---|---|
frequency | String | 是 | 重复基准, "SECONDLY" / "MINUTELY" / "HOURLY" / "DAILY" / "WEEKLY" / "MONTHLY" / "YEARLY" |
count | int | 否 | 重复次数 |
until | String | 否 | 设置截止日期,不可与count同时出现,UTC时间,毫秒级 |
days | Array | 否 | 当frequency为MONTHLY or YEARLY时,表示周中的哪些天,此时集合中的元素只能是weekday,不可待数字和符号。当frequency为MONTHLY or YEARLY时,指定第几周的星期几。如-1MO表示最后一周的星期一,+5SU表示第五周的星期天 |
interval | int | 否 | 依赖freq,重复周期。如:frequency=DAILY;interval=8. 每隔8天重复一次 |
seconds | Array | 否 | 秒刻度集合。 |
minutes | Array | 否 | 分钟刻度集合。 |
hours | Array | 否 | 时辰刻度集合。 |
monthdays | Array | 否 | 单月内,哪些天 |
yeardays | Array | 否 | 一年内,哪些天 |
months | Array | 否 | 一年内,哪些月份 |
weeks | Array | 否 | freq必须为YEARLY,一年中指定哪些周。1 to 53 或者 -53 to -1 |
wkst | enum | 否 | 定义一周从那天开始,默认MO。可选,SU,MO,TU,WE,TH,FR,SA |
bystepos | int | 否 | 和frequency结合使用,如frequency=MONTHLY;bystepos=-1*,表示每个月的最后一天 |
重复规则示例
"recurrence": { "frequency": "DAILY", "interval":2, "count":10 } 每隔一天,发生10次。
"recurrence": { "frequency": "YEARLY", "interval":2, "months":[1], "days":[{"weekday":"SU"}], "hours":[8,9], "minutes":[30] } 每隔一年,一月,星期天,8点半和9点半。
请求示例:
curl -X POST \
' https://open.welink.huaweicloud.com/api/calendar/v1/events/update?=' \
-H 'Content-Type: application/json' \
-H 'x-wlk-Authorization: access_token' \
-d '{"请求body json格式"}'
响应格式说明
返回结果:
正常返回结果:
{
"code": "0",
"message": "OK",
"data": {
"calUid": "calUid",
"succeedUsers": [
"zhansan@abc"
],
"failedUsers": [
"notexites@abc"
]
}
}
异常返回结果:
{
"code": "49400",
"message": "调用集成服务解析收/发件人失败"
}
返回参数说明:
参数 | 数据类型 | 必填 | 说明 |
---|---|---|---|
code | String | 是 | 正常返回“0”,如果发生异常,会返回对应的错误码 |
message | String | 是 | 返回信息 |
error | Object | 否 | 错误内容 |
data | Object | 否 | 返回数据体 |
data.calUid | String | 否 | 日历事件Uid |
data.successdUsers | Array[String] | 否 | 日历处理成功的用户userId |
data.failedUsers | Array[String] | 否 | 日历处理失败的用户userId |
状态码说明:
状态码 | 说明 |
---|---|
0 | 成功 |
49400 | 参数错误 |
49500 | 认证失败 |
49407 | 操作失败 |