获取日程参与者
更新于 2023-01-18调用本接口，获取日程参与者列表。
调用本接口，可获取日程参与者列表，如下图所示。
权限
要调用此API，需要以下权限之一。
应用类型 | 是否支持 | 权限 | API Explorer调试 |
|---|---|---|---|
| 企业内部应用 | 支持 | 日历应用中日程读权限 | API Explorer |
| 第三方企业应用 | 支持 | 日历应用中日程读权限 | API Explorer |
| 第三方个人应用 | 支持 | 日历应用中日程读权限 | API Explorer |
请求方法
Header参数
名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
x-acs-dingtalk-access-token | String | 是 | 调用该接口的访问凭证。
|
Path参数
名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
userId | String | 是 | 本次请求的资源所归属的用户unionId。
|
calendarId | String | 是 | 日程所属的日历id，统一为primary，表示用户的主日历。 |
eventId | String | 是 | 日程ID。 |
Query参数
名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
maxResults | Integer | 否 | 最大返回记录数，默认值100，最大值500。 |
nextToken | String | 否 | 分页游标。 说明
如果一个查询条件一次无法全部返回结果，会返回分页token，下次查询带上该token后会返回后续数据，直到分页token为null表示数据已经全部查询完毕。 |
返回参数
名称 | 类型 | 描述 |
|---|---|---|
nextToken | String | 分页token。 |
attendees | Array | 日程参与人列表。 |
id | String | 用户的unionId。 |
displayName | String | 用户名。 |
responseStatus | String | 响应状态。
|
self | Boolean | 是否当前用户。
|
isOptional | Boolean | 是否为可选参与人。
|
示例
请求示例
返回示例
错误码
HttpCode | 错误码 | 错误信息 | 说明 |
|---|---|---|---|
400 | invalidParameter.event.calendarId | CalendarId cannot be blank | 日历id不能为空 |
400 | invalidParameter.event.eventId | eventId cannot be blank | 日程id不能为空 |
400 | invalidParameter.subscribed.invalid | Subscribed calendar not support this method | 订阅日历不支持此方法 |
400 | invalidParameter.maxResults | maxResults size must within range [0,500] | maxResults超过范围 |
400 | invalidParameter | forwardErrorMessage | 参数异常 |
