TWtwilio
InsightsV1Room

Get Video Log Analyzer data for a Room.

Changed on

Get Video Log Analyzer data for a Room.

get/v1/Video/Rooms/{RoomSid}

Request

  • Base URL
    https://insights.twilio.com
  • URL
    https://insights.twilio.com/v1/Video/Rooms/{RoomSid}
  • Auth
    HTTP basic

Path parameters

RoomSidstring required

The SID of the Room resource.

Response

OK

account_sidstring nullable

Account SID associated with this room.

room_sidstring nullable

Unique identifier for the room.

room_namestring nullable

Room friendly name.

create_timestring date-time nullable

Creation time of the room.

end_timestring date-time nullable

End time for the room.

room_type'go' | 'peer_to_peer' | 'group' | 'group_small'
room_status'in_progress' | 'completed'
status_callbackstring uri nullable

Webhook provided for status callbacks.

status_callback_method'GET' | 'POST' http-method nullable

HTTP method provided for status callback URL.

created_method'sdk' | 'ad_hoc' | 'api'
end_reason'room_ended_via_api' | 'timeout'
max_participantsinteger nullable

Max number of total participants allowed by the application settings.

unique_participantsinteger nullable

Number of participants. May include duplicate identities for participants who left and rejoined.

unique_participant_identitiesinteger nullable

Unique number of participant identities.

concurrent_participantsinteger nullable

Actual number of concurrent participants.

max_concurrent_participantsinteger nullable

Maximum number of participants allowed in the room at the same time allowed by the application settings.

codecsVideoRoomSummaryEnumCodec[] nullable

Codecs used by participants in the room. Can be VP8, H264, or VP9.

media_region'us1' | 'us2' | 'au1' | 'br1' | 'ie1' | 'jp1' | 'sg1' | 'in1' | 'de1' | 'gll'
duration_secinteger nullable

Total room duration from create time to end time.

total_participant_duration_secinteger nullable

Combined amount of participant time in the room.

total_recording_duration_secinteger nullable

Combined amount of recorded seconds for participants in the room.

processing_state'complete' | 'in_progress' | 'timeout' | 'not_started'
recording_enabledboolean nullable

Boolean indicating if recording is enabled for the room.

edge_location'ashburn' | 'dublin' | 'frankfurt' | 'singapore' | 'sydney' | 'sao_paulo' | 'roaming' | 'umatilla' | 'tokyo'
urlstring uri nullable

URL for the room resource.

linksobject nullable

Room subresources.

Changes

  • v169096cb67a25Revision changes
    • info

      removed the dev_us1 enum value from the response property for the response status

    • info

      removed the dev_us2 enum value from the response property for the response status

    • info

      removed the outside enum value from the response property for the response status

    • info

      removed the stage_au1 enum value from the response property for the response status

    • info

      removed the stage_br1 enum value from the response property for the response status

    • info

      removed the stage_de1 enum value from the response property for the response status

    • info

      removed the stage_ie1 enum value from the response property for the response status

    • info

      removed the stage_in1 enum value from the response property for the response status

    • info

      removed the stage_jp1 enum value from the response property for the response status

    • info

      removed the stage_sg1 enum value from the response property for the response status

    • info

      removed the stage_us1 enum value from the response property for the response status

    • info

      removed the stage_us2 enum value from the response property for the response status

  • v18c6fae9ab68cRevision changes
    • warning

      added the new dev_us2 enum value to the response property for the response status

    • warning

      added the new not_started enum value to the response property for the response status

    • warning

      added the new outside enum value to the response property for the response status

    • warning

      added the new stage_au1 enum value to the response property for the response status

    • warning

      added the new stage_br1 enum value to the response property for the response status

    • warning

      added the new stage_de1 enum value to the response property for the response status

    • warning

      added the new stage_ie1 enum value to the response property for the response status

    • warning

      added the new stage_in1 enum value to the response property for the response status

    • warning

      added the new stage_jp1 enum value to the response property for the response status

    • warning

      added the new stage_sg1 enum value to the response property for the response status

    • warning

      added the new stage_us2 enum value to the response property for the response status

    • warning

      added the new timeout enum value to the response property for the response status