资源介绍

资源定义

参与日程的资源实体信息；有多种类型，包括：用户、群聊、会议室、邮箱。每个日程最多只能有 3000 名参与人。

字段说明

名称	类型	描述
attendee_id	string	参与人ID，标识参与日程的唯一资源实体。参见参与人ID说明示例值："user_xxxxxx"
type	string	参与人类型可选值：`user`: 用户`chat`: 群组`resource`: 会议室`third_party`: 邮箱示例值："user"
rsvp_status	string	参与人的RSVP状态可选值：`needs_action`: 参与人尚未回复状态，或表示会议室预约中`accept`: 参与人回复接受，或表示会议室预约成功`tentative`: 参与人回复待定`decline`: 参与人回复拒绝，或表示会议室预约失败`removed`: 参与人或会议室已经从日程中被移除示例值："accept"
is_optional	boolean	参与人是否为「可选参加」，无法编辑群参与人的此字段示例值：true
is_organizer	boolean	参与人是否为日程组织者示例值：true
is_external	boolean	参与人是否为外部参与人；外部参与人不支持编辑示例值：false
display_name	string	参与人名称
chat_members	attendee_chat_member[]	群中的群成员，当type为Chat时有效；群成员不支持编辑
∟ rsvp_status	string	群参与人RSVP状态可选值：`needs_action`: 参与人尚未回复状态`accept`: 参与人回复接受`tentative`: 参与人回复待定`decline`: 参与人回复拒绝`removed`: 参与人已经从日程中被移除示例值："needs_action"
∟ is_optional	boolean	参与人是否为「可选参加」示例值：true
∟ display_name	string	参与人名称
∟ is_organizer	boolean	参与人是否为日程组织者示例值：true
∟ is_external	boolean	参与人是否为外部参与人示例值：false
user_id	string	参与人的用户id，依赖于user_id_type返回对应的取值，当is_external为true时，此字段只会返回open_id或者union_id，参见用户相关的 ID 概念示例值："ou_xxxxxxxx"
chat_id	string	chat类型参与人的群组chat_id，参见群ID 说明示例值："oc_xxxxxxxxx"
room_id	string	resource类型参与人的会议室room_id示例值："omm_xxxxxxxx"
third_party_email	string	third_party类型参与人的邮箱示例值："wangwu@email.com"
operate_id	string	如果日程是使用应用身份创建的，在添加会议室的时候，用来指定会议室的联系人，在会议室视图展示。参见用户相关的 ID 概念示例值："ou_xxxxxxxx"
resource_customization	calendar.attendee.resource_customization[]	会议室的个性化配置
∟ index_key	string	每个配置的唯一ID示例值："16281481596100"
∟ input_content	string	当type类型为填空时，该参数需要填入示例值："xxx"
∟ options	customization.option[]	每个配置的选项
∟ option_key	string	每个选项的唯一ID示例值："16281481596185"
∟ others_content	string	当type类型为其它选项时，该参数需要填入示例值："xxx"

数据示例

{
    "type": "user",
    "attendee_id": "user_xxxxxx",
    "rsvp_status": "needs_action",
    "is_optional": true,
    "is_organizer": true,
    "is_external": false,
    "display_name": "Zhang San",
    "chat_members": [
        {
            "rsvp_status": "needs_action",
            "is_optional": true,
            "display_name": "Group",
            "is_organizer": false,
            "is_external": false
        }
    ],
    "user_id": "ou_xxxxxxxx",
    "chat_id": "oc_xxxxxxxxx",
    "room_id": "omm_xxxxxxxx",
    "third_party_email": "wangwu@email.com",
    "operate_id": "ou_xxxxxxxx",
    "resource_customization": [
        {
            "index_key": "16281481596100",
            "input_content": "xxx",
            "options": [
                {
                    "option_key": "16281481596185",
                    "others_content": "xxx"
                }
            ]
        }
    ]
}

参与人 ID 说明

什么是 attendee_id

attendee_id是日程参与人实体的唯一标识id，通过该id可以删除一个日程里面对应的参与人，也可以通过该id查询群参与人的具体成员信息。
attendee_id一般具有一下4种格式:

user_xxxxxx表示个人参与人。

chat_xxxxxx表示群参与人，可用于会议群参与人的群成员查询。

resource_xxxxxx表示日程预约的会议室。

third_party_xxxxxx表示参加日程的外部邮箱参与人。

如何获取 attendee_id

attendee_id可以通过创建日程参与人和获取日程参与人列表获取。

资源定义#

字段说明#

数据示例#

参与人 ID 说明#