了解 Amazon Chime SDK 会议生命周期事件 - Amazon Chime SDK

了解 Amazon Chime SDK 会议生命周期事件

Amazon Chime SDK 发送会议生命周期事件,用于触发通知和启动下游工作流程。使用会议事件的部分示例包括:

  • 与会者加入或离开 Amazon Chime SDK 会议时更新元数据。

  • 为 Amazon Chime SDK 会议实施推送通知或花名册。

  • 测量 Amazon Chime SDK 会议中视频和内容共享的使用情况。

您可以将事件发送到 Amazon EventBridge、Amazon Simple Notification Service (SNS) 和 Amazon Simple Queue Service (SQS)。有关更多信息,请参阅 Amazon EventBridge 用户指南中的 AWS 服务中的事件

新会议开始时 Amazon Chime SDK 会发送此事件。

例 事件数据

以下示例显示此事件的数据。

{ "version": "0", "source": "aws.chime", "account": "111122223333", "region": "us-east-1", "detail-type": "Chime Meeting State Change", "time": "yyyy-mm-ddThh:mm:ssZ", "resources": [] "detail": { "version": "0", "eventType": "chime:MeetingStarted", "timestamp": 12344566754, "meetingId": "87654321-4321-4321-1234-111122223333", "externalMeetingId": "87654321-4321-4321-1234-111122223333", "mediaRegion": "us-east-1" } }

活动会议结束时 Amazon Chime SDK 会发送此事件。

注意

为了提高效率,该服务还会在您调用 DeleteMeeting API 时发送此事件。

例 事件数据

以下示例显示此事件的数据。

{ "version": "0", "source": "aws.chime", "account": "111122223333", "region": "us-east-1", "detail-type": "Chime Meeting State Change", "time": "yyyy-mm-ddThh:mm:ssZ", "resources": [] "detail": { "version": "0", "eventType": "chime:MeetingEnded", "timestamp": 12344566754, "meetingId": "87654321-4321-4321-1234-111122223333", "externalMeetingId": "87654321-4321-4321-1234-111122223333", "mediaRegion": "us-east-1" } }

新与会者添加至活动会议时,Amazon Chime SDK 会发送此事件。

例 事件数据

以下示例显示此事件的数据。

{ "version": "0", "source": "aws.chime", "account": "111122223333", "region": "us-east-1", "detail-type": "Chime Meeting State Change", "time": "yyyy-mm-ddThh:mm:ssZ", "resources": [] "detail": { "version": "0", "eventType": "chime:AttendeeAdded", "timestamp": 12344566754, "meetingId": "87654321-4321-4321-1234-111122223333", "attendeeId": "87654321-4321-4321-1234-111122223333", "externalUserId": "87654321-4321-4321-1234-111122223333", "externalMeetingId": "87654321-4321-4321-1234-111122223333", "mediaRegion": "us-east-1" } }

使用 DeleteAttendee API 从活动会议中删除与会者时,Amazon Chime SDK 会发送此事件。

例 事件数据

以下示例显示此事件的数据。

{ "version": "0", "source": "aws.chime", "account": "111122223333", "region": "us-east-1", "detail-type": "Chime Meeting State Change", "time": "yyyy-mm-ddThh:mm:ssZ", "resources": [] "detail": { "version": "0", "eventType": "chime:AttendeeDeleted", "timestamp": 12344566754, "meetingId": "87654321-4321-4321-1234-111122223333", "attendeeId": "87654321-4321-4321-1234-111122223333", "externalUserId": "87654321-4321-4321-1234-111122223333", "externalMeetingId": "87654321-4321-4321-1234-111122223333", "mediaRegion": "us-east-1" } }

当已加入会议的用户使用相同的加入令牌再次加入会议时,Amazon Chime SDK 会发送此事件。例如当用户从台式机切换到移动设备时。这实际上是将会议“移交”到新设备上。

例 事件数据

以下示例显示此事件的数据。

{ "version": "0", "source": "aws.chime", "account": "111122223333", "region": "us-east-1", "detail-type": "Chime Meeting State Change", "time": "yyyy-mm-ddThh:mm:ssZ", "resources": [] "detail": { "version": "0", "eventType": "chime:AttendeeAuthorized", "timestamp": 12344566754, "meetingId": "87654321-4321-4321-1234-111122223333", "attendeeId": "87654321-4321-4321-1234-111122223333", "externalUserId": "87654321-4321-4321-1234-111122223333", "externalMeetingId": "87654321-4321-4321-1234-111122223333", "mediaRegion": "us-east-1" } }

现有与会者加入使用指定网络传输的 Amazon Chime SDK 会议时,Amazon Chime SDK 会发送此事件。

例 事件数据

以下示例显示此事件的数据。

{ "version": "0", "source": "aws.chime", "account": "111122223333", "region": "us-east-1", "detail-type": "Chime Meeting State Change", "time": "yyyy-mm-ddThh:mm:ssZ", "resources": [] "detail": { "version": "0", "eventType": "chime:AttendeeJoined", "timestamp": 12344566754, "meetingId": "87654321-4321-4321-1234-111122223333", "attendeeId": "87654321-4321-4321-1234-111122223333", "externalUserId": "87654321-4321-4321-1234-111122223333", "networkType": "Voip", "externalMeetingId": "87654321-4321-4321-1234-111122223333", "mediaRegion": "us-east-1" } }

现有与会者离开使用指定网络传输 Amazon Chime SDK 会议时,Amazon Chime SDK 会发送此事件。

注意

该服务不会针对一个“离开”操作发送同时发送 chime:AttendeeLeftchime:AttendeeDropped 事件。掉线和离开是不同的操作,系统会发送与每个操作对应的事件。

例如,假设一位网络状况不佳的与会者在上午 11 点加入会议。有可能出现以下操作:

11:00 API – CreateAttendee, CreateMeetingWithAttendee, or BatchCreateAttendee 11:00 Event – chime:AttendeeAdded 11:01 Action – user joins meeting 11:01 Event – chime:AttendeeJoined 11:02 Action – user's connection drops 11:02 Event – chime:AttendeeDropped 11:03 Action – user's connection restored 11:03 Event – chime:AttendeeJoined 11:30 Action – user leaves meeting 11:30 Event – chime:AttendeeLeft
例 事件数据

以下示例显示此事件的数据。

{ "version": "0", "source": "aws.chime", "account": "111122223333", "region": "us-east-1", "detail-type": "Chime Meeting State Change", "time": "yyyy-mm-ddThh:mm:ssZ", "resources": [] "detail": { "version": "0", "eventType": "chime:AttendeeLeft", "timestamp": 12344566754, "meetingId": "87654321-4321-4321-1234-111122223333", "attendeeId": "87654321-4321-4321-1234-111122223333", "externalUserId": "87654321-4321-4321-1234-111122223333", "networkType": "Voip", "externalMeetingId": "87654321-4321-4321-1234-111122223333", "mediaRegion": "us-east-1" } }

当前与会者从 Amazon Chime SDK 会议中掉线时(通常是因为网络不佳),Amazon Chime SDK 会发送此事件。当服务在 10-15 秒内没有收到数据包时,它会认为客户端已掉线并发布事件。

掉线操作通常由该服务触发,但客户端也可以触发。例如,假设用户将笔记本电脑从 Wi-Fi 切换到以太网。这会导致网络适配器的更改,连接被重置。这又会重置 websocket 并触发掉线-加入操作。

注意

该服务不会针对一个“离开”操作发送同时发送 chime:AttendeeLeftchime:AttendeeDropped 事件。掉线和离开是不同的操作,系统会发送与每个操作对应的事件。

例如,假设一位网络状况不佳的与会者在上午 11 点加入会议。有可能出现以下操作:

11:00 API – CreateAttendee, CreateMeetingWithAttendee, or BatchCreateAttendee 11:00 Event – chime:AttendeeAdded 11:01 Action – user joins meeting 11:01 Event – chime:AttendeeJoined 11:02 Action – user's connection drops 11:02 Event – chime:AttendeeDropped 11:03 Action – user's connection restored 11:03 Event – chime:AttendeeJoined 11:30 Action – user leaves meeting 11:30 Event – chime:AttendeeLeft
例 事件数据

以下示例显示此事件的数据。

{ "version": "0", "source": "aws.chime", "account": "111122223333", "region": "us-east-1", "detail-type": "Chime Meeting State Change", "time": "yyyy-mm-ddThh:mm:ssZ", "resources": [] "detail": { "version": "0", "eventType": "chime:AttendeeDropped", "timestamp": 12344566754, "meetingId": "87654321-4321-4321-1234-111122223333", "attendeeId": "87654321-4321-4321-1234-111122223333", "externalUserId": "87654321-4321-4321-1234-111122223333", "networkType": "Voip", "externalMeetingId": "87654321-4321-4321-1234-111122223333", "mediaRegion": "us-east-1" } }

现有与会者开始流视频时,Amazon Chime SDK 会发送此事件。

例 事件数据

以下示例显示此事件的数据。

{ "version": "0", "source": "aws.chime", "account": "111122223333", "region": "us-east-1", "detail-type": "Chime Meeting State Change", "time": "yyyy-mm-ddThh:mm:ssZ", "resources": [] "detail": { "version": "0", "eventType": "chime:AttendeeVideoStarted", "timestamp": 12344566754, "meetingId": "87654321-4321-4321-1234-111122223333", "attendeeId": "87654321-4321-4321-1234-111122223333", "externalUserId": "87654321-4321-4321-1234-111122223333", "externalMeetingId": "87654321-4321-4321-1234-111122223333", "mediaRegion": "us-east-1" } }

现有与会者停止流视频时,Amazon Chime SDK 会发送此事件。

例 事件数据

以下示例显示此事件的数据。

{ "version": "0", "source": "aws.chime", "account": "111122223333", "region": "us-east-1", "detail-type": "Chime Meeting State Change", "time": "yyyy-mm-ddThh:mm:ssZ", "resources": [] "detail": { "version": "0", "eventType": "chime:AttendeeVideoStopped", "timestamp": 12344566754, "meetingId": "87654321-4321-4321-1234-111122223333", "attendeeId": "87654321-4321-4321-1234-111122223333", "externalUserId": "87654321-4321-4321-1234-111122223333", "externalMeetingId": "87654321-4321-4321-1234-111122223333", "mediaRegion": "us-east-1" } }

现有与会者开始共享其屏幕时,Amazon Chime SDK 会发送此事件。

例 事件数据

以下示例显示此事件的数据。

{ "version": "0", "source": "aws.chime", "account": "111122223333", "region": "us-east-1", "detail-type": "Chime Meeting State Change", "time": "yyyy-mm-ddThh:mm:ssZ", "resources": [] "detail": { "version": "0", "eventType": "chime:AttendeeContentJoined", "timestamp": 12344566754, "meetingId": "87654321-4321-4321-1234-111122223333", "attendeeId": "87654321-4321-4321-1234-111122223333", "externalUserId": "87654321-4321-4321-1234-111122223333", "externalMeetingId": "87654321-4321-4321-1234-111122223333", "mediaRegion": "us-east-1" } }

现有与会者停止共享其屏幕时,Amazon Chime SDK 会发送此事件。

例 事件数据

以下示例显示此事件的数据。

{ "version": "0", "source": "aws.chime", "account": "111122223333", "region": "us-east-1", "detail-type": "Chime Meeting State Change", "time": "yyyy-mm-ddThh:mm:ssZ", "resources": [] "detail": { "version": "0", "eventType": "chime:AttendeeContentLeft", "timestamp": 12344566754, "meetingId": "87654321-4321-4321-1234-111122223333", "attendeeId": "87654321-4321-4321-1234-111122223333", "externalUserId": "87654321-4321-4321-1234-111122223333", "externalMeetingId": "87654321-4321-4321-1234-111122223333", "mediaRegion": "us-east-1" } }

当现有与会者的容量更新时,Amazon Chime SDK 会发送此事件。

例 事件数据
{ "version": "0", "source": "aws.chime", "account": "111122223333", "id": "12345678-1234-1234-1234-111122223333", "region": "us-east-1", "detail-type": "Chime Meeting State Change", "time": "yyyy-mm-ddThh:mm:ssZ", "resources": [], "detail": { "version": "0", "eventType": "chime:AttendeeCapabilitiesUpdated", "success": "1", // value can be 1 or 0. 1 means success, 0 means failure "timestamp": 12344566754, "meetingId": "87654321-4321-4321-1234-111122223333", "externalMeetingId": "mymeeting", "attendeeId": "attendeeId", "externalUserId": "externalUserId" "mediaRegion": "us-east-1" "attendeeCapabilities": { "audio": "SendReceive", "video": "SendReceive", "content": "SendReceive" } } }

内容共享加入使用指定网络传输的 Amazon Chime SDK 会议时,Amazon Chime SDK 会发送此事件。

例 事件数据

以下示例显示此事件的数据。

{ "version": "0", "source": "aws.chime", "account": "111122223333", "region": "us-east-1", "detail-type": "Chime Meeting State Change", "time": "yyyy-mm-ddThh:mm:ssZ", "resources": [] "detail": { "version": "0", "eventType": "chime:AttendeeContentJoined", "timestamp": 12344566754, "meetingId": "87654321-4321-4321-1234-111122223333", "attendeeId": "87654321-4321-4321-1234-111122223333", "externalUserId": "87654321-4321-4321-1234-111122223333", "networkType": "Voip", "externalMeetingId": "87654321-4321-4321-1234-111122223333", "mediaRegion": "us-east-1" } }

内容共享离开使用指定网络传输的 Amazon Chime SDK 会议时,Amazon Chime SDK 会发送此事件。

例 事件数据

以下示例显示此事件的数据。

{ "version": "0", "source": "aws.chime", "account": "111122223333", "region": "us-east-1", "detail-type": "Chime Meeting State Change", "time": "yyyy-mm-ddThh:mm:ssZ", "resources": [] "detail": { "version": "0", "eventType": "chime:AttendeeContentLeft", "timestamp": 12344566754, "meetingId": "87654321-4321-4321-1234-111122223333", "attendeeId": "87654321-4321-4321-1234-111122223333", "externalUserId": "87654321-4321-4321-1234-111122223333", "networkType": "Voip", "externalMeetingId": "87654321-4321-4321-1234-111122223333", "mediaRegion": "us-east-1" } }

当内容共享从 Amazon Chime SDK 会议中掉线时(通常是因为带宽过低),Amazon Chime SDK 会发送此事件。

例 事件数据

以下示例显示此事件的数据。

{ "version": "0", "source": "aws.chime", "account": "111122223333", "region": "us-east-1", "detail-type": "Chime Meeting State Change", "time": "yyyy-mm-ddThh:mm:ssZ", "resources": [] "detail": { "version": "0", "eventType": "chime:AttendeeContentDropped", "timestamp": 12344566754, "meetingId": "87654321-4321-4321-1234-111122223333", "attendeeId": "87654321-4321-4321-1234-111122223333", "externalUserId": "87654321-4321-4321-1234-111122223333", "networkType": "Voip", "externalMeetingId": "87654321-4321-4321-1234-111122223333", "mediaRegion": "us-east-1" } }

内容共享开始流视频时,Amazon Chime SDK 会发送此事件。

例 事件数据

以下示例显示此事件的数据。

{ "version": "0", "source": "aws.chime", "account": "111122223333", "region": "us-east-1", "detail-type": "Chime Meeting State Change", "time": "yyyy-mm-ddThh:mm:ssZ", "resources": [] "detail": { "version": "0", "eventType": "chime:AttendeeContentVideoStarted", "timestamp": 12344566754, "meetingId": "87654321-4321-4321-1234-111122223333", "attendeeId": "87654321-4321-4321-1234-111122223333", "externalUserId": "87654321-4321-4321-1234-111122223333", "externalMeetingId": "87654321-4321-4321-1234-111122223333", "mediaRegion": "us-east-1" } }

内容共享停止流视频时,Amazon Chime SDK 会发送此事件。

例 事件数据

以下示例显示此事件的数据。

{ "version": "0", "source": "aws.chime", "account": "111122223333", "region": "us-east-1", "detail-type": "Chime Meeting State Change", "time": "yyyy-mm-ddThh:mm:ssZ", "resources": [] "detail": { "version": "0", "eventType": "chime:AttendeeContentVideoStopped", "timestamp": 12344566754, "meetingId": "87654321-4321-4321-1234-111122223333", "attendeeId": "87654321-4321-4321-1234-111122223333", "externalUserId": "87654321-4321-4321-1234-111122223333", "externalMeetingId": "87654321-4321-4321-1234-111122223333", "mediaRegion": "us-east-1" } }