批量添加某个日程的参与者
批量添加某个日程的参与者
请求说明
请求地址 | https://openapi.wps.cn/v7/calendars/{calendar_id}/events/{event_id}/attendees/batch_create |
---|---|
请求方法 | POST |
签名方式 | KSO-1 |
权限要求 | 查询和管理日程信息(应用授权) kso.calendar_events.readwrite 查询和管理日程信息(用户授权) kso.calendar_events.readwrite |
请求头(Header)
Header 名称 | 参数类型 | 是否必填 | 说明 |
---|---|---|---|
Content-Type | string | 是 | 使用:application/json |
X-Kso-Date | string | 是 | RFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT |
X-Kso-Authorization | string | 是 | KSO-1 签名值,详见《签名方法》 |
Authorization | string | 是 | 授权凭证,格式为:Bearer {access_token} |
路径参数(Path)
名称 | 参数类型 | 说明 |
---|---|---|
calendar_id | string | |
event_id | string |
请求体(Body)
名称 | 参数类型 | 是否必填 | 说明 |
---|---|---|---|
attendees | array[object] | 是 | 参与者集合 |
∟ type | string[enum] | 是 | 类型,user 情况下 user_id 必填,暂不支持用户组 user ;group |
∟ user_id | string | 否 | 用户 id;v7_user.id |
is_notification | boolean | 否 | 添加的参与者是否通知,默认为 true |
请求地址示例
[POST] https://openapi.wps.cn/v7/calendars/{calendar_id}/events/{event_id}/attendees/batch_create
请求体示例
json
{
"attendees": [
{
"type": "string[enum]",
"user_id": "string"
}
],
"is_notification": false
}
响应体
名称 | 参数类型 | 说明 |
---|---|---|
code | integer | 响应代码。非 0 表示失败,参照《状态码说明》 |
msg | string | 响应信息 |
data | object | 响应数据 |
∟ items | array[object] | |
∟ ∟ group_id | string | 用户组 id |
∟ ∟ id | string | |
∟ ∟ name | string | 名称;type=user: 用户昵称, type=group:用户组名称 |
∟ ∟ response_status | string | 响应状态, 添加参与者不需要传递; not_responded:未答复,declined:拒绝,accepted:接收,tentative:待定 |
∟ ∟ type | string | 参与者类型, user:用户类型; group:用户组,用户组数据需要通过日程参与者成员接口 展开 |
∟ ∟ user_id | string | 用户 id;v7_user.id |
more | object | 更多的错误信息 |
响应体示例
json
{
"code": 0,
"data": {
"items": [
{
"group_id": "string",
"id": "string",
"name": "string",
"response_status": "string",
"type": "string",
"user_id": "string"
}
]
},
"msg": "string"
}