新增会议日历


接受会议信息,为用户新增WeLink会议日历信息。

该接口用于企业应用中需要会议群发的场景。通过本接口,应用可以将信息推送给WeLink端用户。

请求格式说明

请求方式: POST(HTTPS)

请求地址:

https://open.welink.huaweicloud.com/api/calendar/v1/meetings/add

认证方式: access_token,请参考获取access_token

请求头部:

Content-Type: application/json
x-wlk-Authorization: access_token

请求body参数:

{
  "content": "content",
  "creatorUserId": "huawei@calendar",
  "startTime": "1606322342000",
  "endTime": "1606322542000",
  "location": "location",
  "receiverUserList": [
    "abc@calendar"
  ],
  "reminder": {
    "minutes": 3
  },
  "source": {
    "title": "华为",
    "url": "http://www.huawei.com"
  },
  "summary": "日历综述",
  "recurrence":{"frequency":"YEARLY",
  "interval":2,
  "months":[1,5],
  "days":[{"weekday":"SU"}],
  "hours":[8,15],
  "minutes":[30]
  }
}

请求参数说明:

参数 参数类型 必填 说明
content String 内容
summary String 综述
creatorUserId String 创建者ID
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/meetings/add?=' \
  -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 操作失败

结果。 ""

    无结果。 ""