Video Room Summary

Complete

com.twilio.video.insights.room-summary.complete

Video Room Summary Complete events are compatible with Webhook and Kinesis sinks. To learn more, you can get started with the Webhook or Kinesis quickstarts and refer to the product documentation.

Examples

1{
2  "specversion" : "1.0",
3  "type" : "com.twilio.video.insights.room-summary.complete",
4  "source" : "AB00000000000000000000000001",
5  "id" : "NO00000000000000000000000001",
6  "dataschema" : "https://events-schemas.twilio.com/VideoInsights.RoomSummaryApi/2",
7  "datacontenttype" : "2025-10-08T07:17:02.363Z",
8  "data" : {
9    "room_sid" : "RM0000000000000000000000000000001",
10    "room_name" : "My room",
11    "room_type" : "go",
12    "account_sid" : "AC0000000000000000000000000000001",
13    "create_time" : "2025-01-01T00:00:00.000Z",
14    "end_time" : "2025-01-01T00:15:00.000Z",
15    "duration_sec" : 248,
16    "total_participant_duration_sec" : 465,
17    "total_recording_duration_sec" : 464,
18    "status" : "in-progress",
19    "processing_state" : "complete",
20    "created_method" : "api",
21    "end_reason" : "disconnected_via_api",
22    "max_participants_allowed" : 4,
23    "participants" : 4,
24    "unique_participant_identities" : 2,
25    "max_concurrent_participants" : 2,
26    "codecs" : [
27      "VP8"
28    ],
29    "media_region" : "us1",
30    "recording_enabled" : true,
31    "detected_issues" : {
32      "details" : [
33        {
34          "issue_type" : "packet_loss",
35          "severity" : "high",
36          "properties" : {
37            "participant_sid" : "PA0000000000000000000000000000001",
38            "participant_identity" : "00000000-0000-0000-0000-000000000001",
39            "directions" : [
40              "outbound"
41            ]
42          }
43        }
44      ]
45    }
46  }
47}

Versions

v2 (latest)

(information)

Info

v2 only contains updates to the schema metadata. In other words, there are no new fields between v1 and v2.

string room_sid (required). Unique identifier for the room.
string room_name (required). Description of the room.
string room_type (required). The type of video room depending on size restrictions and technology implementations.
string account_sid (required). Account SID associated with this room.
string create_time (required). Datetime when the room was created in ISO-8601 format.
string end_time (required). Datetime when the room ended in ISO-8601 format.
integer duration_sec. Total room duration from create time to end time.
integer total_participant_duration_sec. Combined amount of participant time in the room.
integer total_recording_duration_sec. Combined amount of recorded seconds for participants in the room.
string status (required). Status of the room.
string processing_state (required). Video Log Analyzer resource state. in-progress indicates that more details may be appended to the resource. complete indicates no further information will be added.
string created_method (required). How the room was created.
string end_reason (required). Reason the room ended.
integer max_participants_allowed. Max number of total participants allowed by the application settings.
integer participants. Number of participants. May include duplicate identities for participants who left and rejoined.
integer unique_participant_identities. Unique number of participant identities.
integer max_concurrent_participants. Maximum number of participants allowed in the room at the same time allowed by the application settings.
string[] codecs (required). Video or Audio Codecs used by participants in the room.
string media_region (required). Region of Twilio media servers for the room.
boolean recording_enabled (required). Boolean indicating if recording is enabled for the room.
object detected_issues. Issues detected in a room.
- object[] details (required). List of issues that occurred.
  - string issue_type (required). The type of issue the participant experienced.
  - string severity (required). The severity of issue the participant experienced.
  - object properties. Detected issue that happened in the room.
    - string participant_sid. Unique identifier for the participant that was impacted by the issue.
    - string participant_identity. The application-defined string that uniquely identifies the participant within a Room.
    - string[] directions (required). The impacted audio/video direction.

The full specification for version 2 is also available as a JSON schema.

string room_sid (required). Https://www.twilio.com/docs/video/insights/api/room-summary-resource.
string room_name (required). Https://www.twilio.com/docs/video/insights/api/room-summary-resource.
string room_type (required). Https://www.twilio.com/docs/video/insights/api/room-summary-resource.
string account_sid (required). Https://www.twilio.com/docs/video/insights/api/room-summary-resource.
string create_time (required). Https://www.twilio.com/docs/video/insights/api/room-summary-resource.
string end_time (required). Https://www.twilio.com/docs/video/insights/api/room-summary-resource.
integer duration_sec. Https://www.twilio.com/docs/video/insights/api/room-summary-resource.
integer total_participant_duration_sec. Https://www.twilio.com/docs/video/insights/api/room-summary-resource.
integer total_recording_duration_sec. Https://www.twilio.com/docs/video/insights/api/room-summary-resource.
string status (required). Https://www.twilio.com/docs/video/insights/api/room-summary-resource.
string processing_state (required). Https://www.twilio.com/docs/video/insights/api/room-summary-resource.
string created_method (required). Https://www.twilio.com/docs/video/insights/api/room-summary-resource.
string end_reason (required). Https://www.twilio.com/docs/video/insights/api/room-summary-resource.
integer max_participants_allowed. Https://www.twilio.com/docs/video/insights/api/room-summary-resource.
integer participants. Https://www.twilio.com/docs/video/insights/api/room-summary-resource.
integer unique_participant_identities. Https://www.twilio.com/docs/video/insights/api/room-summary-resource.
integer max_concurrent_participants. Https://www.twilio.com/docs/video/insights/api/room-summary-resource.
string[] codecs (required). Https://www.twilio.com/docs/video/insights/api/room-summary-resource.
string media_region (required). Https://www.twilio.com/docs/video/insights/api/room-summary-resource.
boolean recording_enabled (required). Https://www.twilio.com/docs/video/insights/api/room-summary-resource.
object detected_issues. Https://www.twilio.com/docs/video/insights/api/room-summary-resource.
- object[] details (required). Https://www.twilio.com/docs/video/insights/api/room-summary-resource.
  - string issue_type (required). Https://www.twilio.com/docs/video/insights/api/room-summary-resource.
  - string severity (required). Https://www.twilio.com/docs/video/insights/api/room-summary-resource.
  - object properties. Https://www.twilio.com/docs/video/insights/api/room-summary-resource.
    - string participant_sid. Https://www.twilio.com/docs/video/insights/api/room-summary-resource.
    - string participant_identity. Https://www.twilio.com/docs/video/insights/api/room-summary-resource.
    - string[] directions (required). Https://www.twilio.com/docs/video/insights/api/room-summary-resource.

The full specification for version 1 is also available as a JSON schema.