Sign in
Video Conferences

Get video conference

Retrieves one managed Video Conference by ID so you can inspect its hosted experience and current activity. Use List video conferences to discover conference IDs.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Video.

Learn more about API scopes.

get/api/video/conferences/{id}

Path parameters

idstring uuid required

Universal Unique Identifier.

Unique ID of the video conference.

Query parameters

include_active_sessionboolean

Specifies whether to include information about the conference's active session (if any).

Response

Conference response wrapper.

idstring uuid required

Universal Unique Identifier.

namestring required

A named unique identifier for the conference. Allowed characters: A-Za-z0-9_-.

display_namestring nullable required

Display name of the video conference. Maximum of 200 characters.

descriptionstring nullable required

Description of the conference. Maximum of 3000 characters.

join_fromstring date-time nullable required

Conference does not accept new participants before this time.

join_untilstring date-time nullable required

Conference stops accepting new participants at this time, but keeps running until all participants leave.

quality'720p' | '1080p' required

Video quality resolution.

layout'grid-responsive' | 'grid-responsive-mobile' | 'highlight-1-responsive' | '1x1' | '2x1' | '2x2' | '5up' | '3x3' | '4x4' | '5x5' | '6x6' | '8x8' | '10x10' required

Video room layout options.

size'small' | 'medium' | 'large' required

Conference size options.

record_on_startboolean required

Whether to start recording when a conference session begins.

tone_on_entry_and_exitboolean required

Whether a tone is played when a member enters or exits the conference.

user_join_video_offboolean required

Whether participants join with video off by user setting.

room_join_video_offboolean required

Whether participants join with video off by room setting.

enable_chatboolean required

Whether group chat is enabled for conference participants.

enable_room_previewsboolean nullable required

Whether a preview video of the conference content is generated.

dark_primarystring nullable required

CTA buttons and selected items color (dark theme).

dark_backgroundstring nullable required

Main background color (dark theme).

dark_foregroundstring nullable required

Main foreground color (dark theme).

dark_successstring nullable required

Success indication color (dark theme).

dark_negativestring nullable required

Error indication color (dark theme).

light_primarystring nullable required

CTA buttons and selected items color (light theme).

light_backgroundstring nullable required

Main background color (light theme).

light_foregroundstring nullable required

Main foreground color (light theme).

light_successstring nullable required

Success indication color (light theme).

light_negativestring nullable required

Error indication color (light theme).

metaobject nullable required

User-defined metadata for the conference.

created_atstring date-time required

Timestamp when the conference was created.

updated_atstring date-time required

Timestamp when the conference was last updated.

Example response

{
  "name": "my_conference",
  "display_name": "My Conference's Name",
  "description": "This conference will be used for full company all hands meetings",
  "join_from": "2022-01-01T00:00:00Z",
  "join_until": "2022-12-31T23:59:59Z",
  "tone_on_entry_and_exit": true,
  "enable_chat": true,
  "dark_primary": "#044EF4",
  "dark_background": "#FFFFFF",
  "dark_foreground": "#1D2127",
  "dark_success": "#17BB58",
  "dark_negative": "#F42C50",
  "light_primary": "#044EF4",
  "light_background": "#FFFFFF",
  "light_foreground": "#1D2127",
  "light_success": "#17BB58",
  "light_negative": "#F42C50",
  "created_at": "2022-01-01T10:00:00Z",
  "updated_at": "2022-01-01T11:00:00Z",
  "active_session": {
    "id": "c22d24f6-5a47-4597-9a23-c7d01e696b92",
    "room_id": "a1b2c3d4-5e6f-7890-abcd-ef1234567890",
    "name": "my_example_room",
    "display_name": "My Room's Name",
    "join_from": "2022-01-01T00:00:00Z",
    "join_until": "2022-12-31T23:59:59Z",
    "remove_at": "2022-12-31T23:59:59Z",
    "remove_after_seconds_elapsed": 120,
    "layout": "grid-responsive",
    "max_members": 20,
    "start_time": "2022-01-01T10:00:00Z",
    "end_time": "2022-01-01T11:00:00Z",
    "duration": 120,
    "record_on_start": true,
    "enable_room_previews": true,
    "preview_url": "https://example.signalwire.com/api/video/room_sessions/c22d24f6-5a47-4597-9a23-c7d01e696b92/preview",
    "audio_video_sync": true
  }
}

Changes

No changes found, but 3 of the 137 revisions have a changelog that could not be searched — this endpoint may have changed in one of them.