Appearance
Video
FreshGet conference token
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Find a conference token by ID.
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.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)Path parameters
idstringRequiredformat: "uuid"
Unique ID of the conference token.
Response
Conference token response object.
idstringformat: "uuid"
Unique identifier for the conference token.
namestring or null
Name of the conference token.
tokenstring
Conference token's randomly generated sequence.
scopeslist of strings
List of permissions.
Errors
400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error
List conference tokens
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
List conference tokens.
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.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)Path parameters
idstringRequiredformat: "uuid"
Unique ID of the video conference.
Query parameters
page_numberintegerOptional>=0Defaults to 0
Page number to return. Requires page_token for values greater than 0.
page_sizeintegerOptional1-1000Defaults to 50
Specify the number of results to return on a single page. The default page size is 50 and the maximum is 1000.
page_tokenstringOptional
Token for cursor-based pagination. Required when page_number is greater than 0.
Response
The request has succeeded.
linksobject
Pagination links.
datalist of objects
List of conference tokens.
Errors
400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error
Reset conference token
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Reset a conference token by ID.
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.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)Path parameters
idstringRequiredformat: "uuid"
Unique ID of the conference token.
Response
Conference token response object.
idstringformat: "uuid"
Unique identifier for the conference token.
namestring or null
Name of the conference token.
tokenstring
Conference token's randomly generated sequence.
scopeslist of strings
List of permissions.
Errors
400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error
Delete room recording
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Delete a Room Recording.
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.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)Path parameters
idstringRequiredformat: "uuid"
Unique ID of the Room Recording.
Response
There is no content to send for this request, but the headers may be useful.
Errors
400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error
Get room recording
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
A detailed summary of a particular Room Recording.
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.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)Path parameters
idstringRequiredformat: "uuid"
Unique ID of the Room Recording.
Query parameters
media_ttlintegerOptional>=0
Generated media links will be valid for this many seconds. Default is 900 (15 minutes).
Response
Room recording response.
idstringformat: "uuid"
Unique ID of the Room Recording.
room_session_idstringformat: "uuid"
Unique ID of the Room Session the Room Recording was made in.
statusenum or null
Status of the recording.
Allowed values:recordingpausedprocessingcompleted
started_atdatetime or null
Timestamp of when the Room Recording started.
finished_atdatetime or null
Timestamp of when the Room Recording stopped.
durationinteger or null
The length of the Room Recording in seconds.
size_in_bytesinteger or null
The number of bytes of the Room Recording file.
formatstring or null
The MIME type of the Room Recording file.
cost_in_dollarsdouble
The cost of the recording in dollars.
uristring or null
A temporary URL for accessing the recording file. By default, valid for 15 minutes.
created_atdatetime
Timestamp when the recording was created.
updated_atdatetime
Timestamp when the recording was last updated.
Errors
400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error
List room recording events
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
A list of Events for a particular Room Recording.
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.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)Path parameters
idstringRequiredformat: "uuid"
Unique ID of the Room Recording.
Query parameters
page_numberintegerOptional>=0Defaults to 0
Page number to return. Requires page_token for values greater than 0.
page_sizeintegerOptional1-1000Defaults to 50
Specify the number of results to return on a single page. The default page size is 50 and the maximum is 1000.
page_tokenstringOptional
Token for cursor-based pagination. Required when page_number is greater than 0.
Response
The request has succeeded.
linksobject
Pagination links.
Show 4 properties
datalist of objects
List of room recording events.
Show 10 properties
Errors
400
Bad Request Error
401
Unauthorized Error
422
Unprocessable Entity Error
500
Internal Server Error
List room recordings
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
A list of all Room Recordings.
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.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)Query parameters
media_ttlintegerOptional>=0
Generated media links will be valid for this many seconds. Default is 900 (15 minutes).
page_numberintegerOptional>=0Defaults to 0
Page number to return. Requires page_token for values greater than 0.
page_sizeintegerOptional1-1000Defaults to 50
Specify the number of results to return on a single page. The default page size is 50 and the maximum is 1000.
page_tokenstringOptional
Token for cursor-based pagination. Required when page_number is greater than 0.
Response
The request has succeeded.
linksobject
Pagination links.
datalist of objects
List of room recordings.
Errors
400
Bad Request Error
401
Unauthorized Error
422
Unprocessable Entity Error
500
Internal Server Error
Get room session
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Find a Room Session by ID.
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.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)Path parameters
idstringRequiredformat: "uuid"
Unique ID of the Room Session.
Response
Room session response.
idstringformat: "uuid"
Unique ID of the session.
room_idstring or nullformat: "uuid"
Unique ID of the Room if the Session was created from a Room and was not an auto-created Session. Null if the room was set to delete on end.
namestring or null
The named identifier of the room session.
display_namestring or null
Display name of the room. Maximum of 200 characters. Defaults to the value of name.
max_membersinteger or null
The maximum number of members allowed in the room at a time.
qualityenum or null
The room session's resolution.
Allowed values:720p1080p
fpsenum or null
The room session's frames per second.
Allowed values:2030
join_fromdatetime or null
Room Session does not accept new Members before this time.
join_untildatetime or null
Room Session stops accepting new Members at this time.
remove_atdatetime or null
Remove Members from the Room Session at this time.
remove_after_seconds_elapsedinteger or null
Remove Members after they are in the Room Session for N seconds.
layoutstring or null
The room session's initial layout.
record_on_startboolean
Whether a recording was automatically started when this Room Session began.
tone_on_entry_and_exitboolean
Whether a tone is played when a member enters or exits the room session.
room_join_video_offboolean
Whether participants join with video off by room setting.
user_join_video_offboolean
Whether participants join with video off by user setting.
lockedboolean
Whether the room session is locked.
start_timedatetime or null
Start time of the session.
end_timedatetime or null
End time of the session.
durationinteger or null
How long, in seconds, the Room Session lasted.
statusenum or null
Status of the session.
Allowed values:in-progresscompleted
created_atdatetime
Timestamp when the room session was created.
updated_atdatetime
Timestamp when the room session was last updated.
preview_urlstring or null
If room previews are enabled and the room session is in progress, this is the URL of the preview video.
prioritize_handraiseboolean or null
Whether raised hands are prioritized in the layout.
sync_audio_videoboolean or null
Enable/disable jitter buffer audio-video sync.
Errors
400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error
List room session events
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
A list of Events for a particular Room Session.
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.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)Path parameters
idstringRequiredformat: "uuid"
Unique ID of the Room Session.
Query parameters
page_numberintegerOptional>=0Defaults to 0
Page number to return. Requires page_token for values greater than 0.
page_sizeintegerOptional1-1000Defaults to 50
Specify the number of results to return on a single page. The default page size is 50 and the maximum is 1000.
page_tokenstringOptional
Token for cursor-based pagination. Required when page_number is greater than 0.
Response
The request has succeeded.
linksobject
Pagination links.
Show 4 properties
datalist of objects
List of room session events.
Show 10 properties
Errors
400
Bad Request Error
401
Unauthorized Error
422
Unprocessable Entity Error
500
Internal Server Error
List room session members
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
A list of Members for a particular Room Session.
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.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)Path parameters
idstringRequiredformat: "uuid"
Unique ID of the Room Session.
Query parameters
page_numberintegerOptional>=0Defaults to 0
Page number to return. Requires page_token for values greater than 0.
page_sizeintegerOptional1-1000Defaults to 50
Specify the number of results to return on a single page. The default page size is 50 and the maximum is 1000.
page_tokenstringOptional
Token for cursor-based pagination. Required when page_number is greater than 0.
Response
The request has succeeded.
linksobject
Pagination links.
datalist of objects
List of room session members.
Errors
400
Bad Request Error
401
Unauthorized Error
422
Unprocessable Entity Error
500
Internal Server Error
List room session recordings
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
A list of Room Recordings for a particular Room Session.
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.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)Path parameters
idstringRequiredformat: "uuid"
Unique ID of the Room Session.
Query parameters
media_ttlintegerOptional>=0
Generated media links will be valid for this many seconds. Default is 900 (15 minutes).
page_numberintegerOptional>=0Defaults to 0
Page number to return. Requires page_token for values greater than 0.
page_sizeintegerOptional1-1000Defaults to 50
Specify the number of results to return on a single page. The default page size is 50 and the maximum is 1000.
page_tokenstringOptional
Token for cursor-based pagination. Required when page_number is greater than 0.
Response
The request has succeeded.
linksobject
Pagination links.
Show 4 properties
datalist of objects
List of room recordings.
Show 12 properties
Errors
400
Bad Request Error
401
Unauthorized Error
422
Unprocessable Entity Error
500
Internal Server Error
List room sessions
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
A list of past and in-progress Room Sessions.
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.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)Query parameters
room_idstringOptionalformat: "uuid"
Return Sessions started from this Room.
room_namestringOptional
Return Sessions with a matching room name.
room_name_matchesstringOptional
Return Sessions with a room name matching this pattern (substring match).
statusenumOptional
Return Sessions currently in this state.
Allowed values:in-progresscompleted
page_numberintegerOptional>=0Defaults to 0
Page number to return. Requires page_token for values greater than 0.
page_sizeintegerOptional1-1000Defaults to 50
Specify the number of results to return on a single page. The default page size is 50 and the maximum is 1000.
page_tokenstringOptional
Token for cursor-based pagination. Required when page_number is greater than 0.
Response
The request has succeeded.
linksobject
Pagination links.
datalist of objects
List of room sessions.
Errors
400
Bad Request Error
401
Unauthorized Error
422
Unprocessable Entity Error
500
Internal Server Error
Create room token
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Generate a Room Token allowing a client to join a Room.
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.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)Request
This endpoint expects an object.
room_namestringRequiredformat: "^[A-Za-z0-9_-]+$"``<=100 characters
Room’s unique named identifier. Allowed characters: A-Za-z0-9_-. Up to 100 characters. The room does not have to exist when the token is created, but must exist prior to joining, or ensure auto_create_room is set to true.
user_namestringOptional<=100 characters
A display name to use for the user. Up to 100 characters. (If not supplied, a random alphanumeric string will be returned for each authorization with this token.)
permissionslist of enumsOptionalDefaults to ["room.self.audio_mute","room.self.audio_unmute","room.self.video_mute","room.self.video_unmute","room.self.deaf","room.self.undeaf","room.self.set_input_volume","room.self.set_output_volume","room.self.set_input_sensitivity","room.self.screenshare","room.self.additional_source"]
A list of permissions, which define what user can do once they join the room. If join_as is audience, permissions are set to an empty array regardless of the value provided.
join_fromdatetimeOptional
The user can’t join the room before this time. Expects RFC 3339 datetime: 2022-01-01T23:59:60Z. Date only: 2022-01-01 will be converted to 2022-01-01T00:00:00Z
join_untildatetimeOptional
The user can’t join the room after this time. Expects RFC 3339 datetime: 2022-01-01T23:59:60Z. Date only: 2022-01-01 will be converted to 2022-01-01T00:00:00Z
remove_atdatetimeOptional
Remove user from the room at this time. Expects RFC 3339 datetime: 2022-01-01T23:59:60Z. Date only: 2022-01-01 will be converted to 2022-01-01T00:00:00Z
remove_after_seconds_elapsedintegerOptional<=200000
Remove user after they are in the room for N seconds.
join_audio_mutedbooleanOptionalDefaults to false
Whether the user joins the room with their audio muted.
join_video_mutedbooleanOptionalDefaults to false
Whether the user joins the room with their video muted.
auto_create_roombooleanOptionalDefaults to true
By default, if the user tries to use this token to join a room that doesn't exist, it will be created with default configuration. Set this to false to require the room to exist beforehand.
enable_room_previewsbooleanOptionalDefaults to false
Whether to generate a video with a preview of the content of the room. This parameter has effect only if this token auto-creates the room, thus it will be ignored if the room already exists.
room_display_namestringOptional<=200 characters
Display name used if a room is auto-created when the token joins. Maximum of 200 characters. Defaults to the value of room_name.
end_room_session_on_leavebooleanOptionalDefaults to false
Whether to end the room session when the member using this token leaves the room.
join_asenumOptionalDefaults to member
Whether the user should join as a member or as a non-interactive audience participant. Audience participants cannot send audio or video.
media_allowedenumOptionalDefaults to all
Indicates what media the user is allowed to receive.
room_metaobjectOptional
Set the room meta. Maximum of 2000 characters when serialized to JSON.
metaobjectOptional
Set the member meta. Maximum of 2000 characters when serialized to JSON.
sync_audio_videobooleanOptionalDefaults to false
Enable/disable jitter buffer audio-video sync.
Response
The request has succeeded.
tokenstring
A Room Token to be used by clients to connect to the Room.
Errors
400
Bad Request Error
401
Unauthorized Error
422
Unprocessable Entity Error
500
Internal Server Error
Create room
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Create a room.
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.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)Request
This endpoint expects an object.
namestringRequiredformat: "^[A-Za-z0-9_\-]+$"``<=100 characters
A named unique identifier for the room. Allowed characters: A-Za-z0-9_-. Maximum of 100 characters.
display_namestringOptional<=200 characters
Display name of the room. Maximum of 200 characters. Defaults to the value of name.
descriptionstringOptional<=3000 characters
Description of the room. Maximum of 3000 characters.
max_membersintegerOptional1-300Defaults to 20
The maximum number of members in the room at a time. Must be at least 1 to a maximum of 300.
qualityenumOptionalDefaults to 720p
The room's resolution.
join_fromdatetimeOptional
Room does not accept new participants before this time. Expects RFC 3339 datetime: 2022-01-01T23:59:60Z. Date only: 2022-01-01 will be converted to 2022-01-01T00:00:00Z.
join_untildatetimeOptional
Room stops accepting new participants at this time, but keeps running until all participants leave. Expects RFC 3339 datetime: 2022-01-01T23:59:60Z. Date only: 2022-01-01 will be converted to 2022-01-01T00:00:00Z.
remove_atdatetimeOptional
Remove users from the room at this time. Expects RFC 3339 datetime: 2022-01-01T23:59:60Z. Date only: 2022-01-01 will be converted to 2022-01-01T00:00:00Z.
remove_after_seconds_elapsedintegerOptional1-200000
Remove users after they are in the room for N seconds.
layoutenumOptionalDefaults to grid-responsive
The room's initial layout.
record_on_startbooleanOptionalDefaults to false
Specifies whether to start recording a Room Session when one is started for this Room.
enable_room_previewsbooleanOptionalDefaults to false
Whether a video with a preview of the content of the room is to be generated.
metaobjectOptional
User-defined metadata for the room. Must be a valid JSON object. Maximum of 2000 characters when serialized.
sync_audio_videobooleanOptional
Enable/disable jitter buffer audio-video sync.
Response
The request has succeeded.
idstringformat: "uuid"
A unique identifier for the room.
namestring
A named unique identifier for the room.
display_namestring or null
Display name of the room.
descriptionstring or null
Description of the room.
max_membersinteger
The maximum number of members in the room at a time.
qualityenum
The room's resolution.
fpsinteger
Frames per second parameter of room video quality.
join_fromdatetime or null
Room does not accept new participants before this time.
join_untildatetime or null
Room stops accepting new participants at this time.
remove_atdatetime or null
Remove users from the room at this time.
remove_after_seconds_elapsedinteger or null
Remove users after they are in the room for N seconds.
layoutenum
The room's initial layout.
record_on_startboolean
Specifies whether to start recording a Room Session when one is started for this Room.
tone_on_entry_and_exitboolean
Whether a tone is played when participants enter or exit the room.
room_join_video_offboolean
Whether the room's video is turned off when participants join.
user_join_video_offboolean
Whether a user's video is turned off when they join the room.
enable_room_previewsboolean or null
Whether a video with a preview of the content of the room is to be generated.
sync_audio_videoboolean or null
Enable/disable jitter buffer audio-video sync.
metaobject or null
User-defined metadata for the room.
prioritize_handraiseboolean
Whether hand raises are prioritized in the room layout.
created_atdatetime
Timestamp when the room was created.
updated_atdatetime
Timestamp when the room was last updated.
active_sessionobject
Active session information for the room.
Errors
400
Bad Request Error
401
Unauthorized Error
422
Unprocessable Entity Error
500
Internal Server Error
Delete room
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Delete a room.
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.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)Path parameters
idstringRequiredformat: "uuid"
Unique ID of the room.
Response
There is no content to send for this request, but the headers may be useful.
Errors
400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error
Get room
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Find a room by ID.
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.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)Path parameters
idstringRequiredformat: "uuid"
Unique ID of the room.
Query parameters
include_active_sessionbooleanOptional
Specifies whether or not to include information about the room’s active session (if any).
Response
The request has succeeded.
idstringformat: "uuid"
A unique identifier for the room.
namestring
A named unique identifier for the room.
display_namestring or null
Display name of the room.
descriptionstring or null
Description of the room.
max_membersinteger
The maximum number of members in the room at a time.
qualityenum
The room's resolution.
Allowed values:720p1080p
fpsinteger
Frames per second parameter of room video quality.
join_fromdatetime or null
Room does not accept new participants before this time.
join_untildatetime or null
Room stops accepting new participants at this time.
remove_atdatetime or null
Remove users from the room at this time.
remove_after_seconds_elapsedinteger or null
Remove users after they are in the room for N seconds.
layoutenum
The room's initial layout.
Show 13 enum values
record_on_startboolean
Specifies whether to start recording a Room Session when one is started for this Room.
tone_on_entry_and_exitboolean
Whether a tone is played when participants enter or exit the room.
room_join_video_offboolean
Whether the room's video is turned off when participants join.
user_join_video_offboolean
Whether a user's video is turned off when they join the room.
enable_room_previewsboolean or null
Whether a video with a preview of the content of the room is to be generated.
sync_audio_videoboolean or null
Enable/disable jitter buffer audio-video sync.
metaobject or null
User-defined metadata for the room.
prioritize_handraiseboolean
Whether hand raises are prioritized in the room layout.
created_atdatetime
Timestamp when the room was created.
updated_atdatetime
Timestamp when the room was last updated.
active_sessionobject
Active session information for the room.
Show 20 properties
Errors
400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error
Get room by name
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Find a room by name.
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.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)Path parameters
namestringRequired
Unique name of the room.
Query parameters
include_active_sessionbooleanOptional
Specifies whether or not to include information about the room’s active session (if any).
Response
The request has succeeded.
idstringformat: "uuid"
A unique identifier for the room.
namestring
A named unique identifier for the room.
display_namestring or null
Display name of the room.
descriptionstring or null
Description of the room.
max_membersinteger
The maximum number of members in the room at a time.
qualityenum
The room's resolution.
Allowed values:720p1080p
fpsinteger
Frames per second parameter of room video quality.
join_fromdatetime or null
Room does not accept new participants before this time.
join_untildatetime or null
Room stops accepting new participants at this time.
remove_atdatetime or null
Remove users from the room at this time.
remove_after_seconds_elapsedinteger or null
Remove users after they are in the room for N seconds.
layoutenum
The room's initial layout.
Show 13 enum values
record_on_startboolean
Specifies whether to start recording a Room Session when one is started for this Room.
tone_on_entry_and_exitboolean
Whether a tone is played when participants enter or exit the room.
room_join_video_offboolean
Whether the room's video is turned off when participants join.
user_join_video_offboolean
Whether a user's video is turned off when they join the room.
enable_room_previewsboolean or null
Whether a video with a preview of the content of the room is to be generated.
sync_audio_videoboolean or null
Enable/disable jitter buffer audio-video sync.
metaobject or null
User-defined metadata for the room.
prioritize_handraiseboolean
Whether hand raises are prioritized in the room layout.
created_atdatetime
Timestamp when the room was created.
updated_atdatetime
Timestamp when the room was last updated.
active_sessionobject
Active session information for the room.
Show 20 properties
Errors
400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error
List rooms
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
List rooms.
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.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)Query parameters
include_active_sessionbooleanOptional
Specifies whether or not to include information about the room’s active session (if any).
starts_afterstringOptional
Return rooms with a join_from date on or after this date. Expects RFC 3339 datetime or date string.
ends_beforestringOptional
Return rooms with a join_until date on or before this date. Expects RFC 3339 datetime or date string.
page_numberintegerOptional>=0Defaults to 0
Page number to return. Requires page_token for values greater than 0.
page_sizeintegerOptional1-1000Defaults to 50
Specify the number of results to return on a single page. The default page size is 50 and the maximum is 1000.
page_tokenstringOptional
Token for cursor-based pagination. Required when page_number is greater than 0.
Response
The request has succeeded.
linksobject
Pagination links.
Show 4 properties
datalist of objects
List of rooms.
Show 23 properties
Errors
400
Bad Request Error
401
Unauthorized Error
422
Unprocessable Entity Error
500
Internal Server Error
Update room
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Update a room.
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.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)Path parameters
idstringRequiredformat: "uuid"
Unique ID of the room.
Request
This endpoint expects an object.
display_namestringOptional<=200 characters
Display name of the room. Maximum of 200 characters. Defaults to the value of name.
descriptionstringOptional<=3000 characters
Description of the room. Maximum of 3000 characters.
max_membersintegerOptional1-300Defaults to 20
The maximum number of members in the room at a time. Must be at least 1 to a maximum of 300.
qualityenumOptionalDefaults to 720p
The room's resolution.
Allowed values:720p1080p
join_fromdatetimeOptional
Room does not accept new participants before this time. Expects RFC 3339 datetime: 2022-01-01T23:59:60Z. Date only: 2022-01-01 will be converted to 2022-01-01T00:00:00Z.
join_untildatetimeOptional
Room stops accepting new participants at this time, but keeps running until all participants leave. Expects RFC 3339 datetime: 2022-01-01T23:59:60Z. Date only: 2022-01-01 will be converted to 2022-01-01T00:00:00Z.
remove_atdatetimeOptional
Remove users from the room at this time. Expects RFC 3339 datetime: 2022-01-01T23:59:60Z. Date only: 2022-01-01 will be converted to 2022-01-01T00:00:00Z.
remove_after_seconds_elapsedintegerOptional1-200000
Remove users after they are in the room for N seconds.
layoutenumOptionalDefaults to grid-responsive
The room's initial layout.
Show 13 enum values
record_on_startbooleanOptionalDefaults to false
Specifies whether to start recording a Room Session when one is started for this Room.
enable_room_previewsbooleanOptionalDefaults to false
Whether a video with a preview of the content of the room is to be generated.
metaobjectOptional
User-defined metadata for the room. Must be a valid JSON object. Maximum of 2000 characters when serialized.
sync_audio_videobooleanOptional
Enable/disable jitter buffer audio-video sync.
Response
The request has succeeded.
idstringformat: "uuid"
A unique identifier for the room.
namestring
A named unique identifier for the room.
display_namestring or null
Display name of the room.
descriptionstring or null
Description of the room.
max_membersinteger
The maximum number of members in the room at a time.
qualityenum
The room's resolution.
Allowed values:720p1080p
fpsinteger
Frames per second parameter of room video quality.
join_fromdatetime or null
Room does not accept new participants before this time.
join_untildatetime or null
Room stops accepting new participants at this time.
remove_atdatetime or null
Remove users from the room at this time.
remove_after_seconds_elapsedinteger or null
Remove users after they are in the room for N seconds.
layoutenum
The room's initial layout.
Show 13 enum values
record_on_startboolean
Specifies whether to start recording a Room Session when one is started for this Room.
tone_on_entry_and_exitboolean
Whether a tone is played when participants enter or exit the room.
room_join_video_offboolean
Whether the room's video is turned off when participants join.
user_join_video_offboolean
Whether a user's video is turned off when they join the room.
enable_room_previewsboolean or null
Whether a video with a preview of the content of the room is to be generated.
sync_audio_videoboolean or null
Enable/disable jitter buffer audio-video sync.
metaobject or null
User-defined metadata for the room.
prioritize_handraiseboolean
Whether hand raises are prioritized in the room layout.
created_atdatetime
Timestamp when the room was created.
updated_atdatetime
Timestamp when the room was last updated.
active_sessionobject
Active session information for the room.
Show 20 properties
Errors
400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error
Create conference stream
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
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.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)Path parameters
idstringRequired
Unique id of a video conference
Request
This endpoint expects an object.
urlstringRequired
RTMP or RTMPS URL. This must be the address of a server accepting incoming RTMP/RTMPS streams.
Response
Stream response object.
idstringformat: "uuid"
Unique identifier for the stream.
urlstring or null
RTMP or RTMPS URL. This must be the address of a server accepting incoming RTMP/RTMPS streams.
stream_typestring or null
The type of stream.
widthinteger or null
The stream's width in pixels.
heightinteger or null
The stream's height in pixels.
fpsinteger or null
The stream's frames per second.
created_atdatetime
Timestamp when the stream was created.
updated_atdatetime
Timestamp when the stream was last updated.
Errors
401
Unauthorized Error
422
Unprocessable Entity Error
500
Internal Server Error
Create room stream
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
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.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)Path parameters
idstringRequiredformat: "uuid"
Unique ID of the video room.
Request
This endpoint expects an object.
urlstringRequired
RTMP or RTMPS URL. This must be the address of a server accepting incoming RTMP/RTMPS streams.
Response
Stream created response.
idstringformat: "uuid"
Unique identifier for the stream.
urlstring or null
RTMP or RTMPS URL. This must be the address of a server accepting incoming RTMP/RTMPS streams.
stream_typestring or null
The type of stream.
widthinteger or null
The stream's width in pixels.
heightinteger or null
The stream's height in pixels.
fpsinteger or null
The stream's frames per second.
created_atdatetime
Timestamp when the stream was created.
updated_atdatetime
Timestamp when the stream was last updated.
Errors
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error
Delete stream
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
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.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)Path parameters
idstringRequiredformat: "uuid"
Unique ID of the stream.
Response
There is no content to send for this request, but the headers may be useful.
Errors
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error
Get stream
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
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.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)Path parameters
idstringRequiredformat: "uuid"
Unique ID of the stream.
Response
Stream response object.
idstringformat: "uuid"
Unique identifier for the stream.
urlstring or null
RTMP or RTMPS URL. This must be the address of a server accepting incoming RTMP/RTMPS streams.
stream_typestring or null
The type of stream.
widthinteger or null
The stream's width in pixels.
heightinteger or null
The stream's height in pixels.
fpsinteger or null
The stream's frames per second.
created_atdatetime
Timestamp when the stream was created.
updated_atdatetime
Timestamp when the stream was last updated.
Errors
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error
List conference streams
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
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.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)Path parameters
idstringRequired
Unique id of a video conference
Response
The request has succeeded.
linksobject
Pagination links.
datalist of objects
List of streams.
Errors
401
Unauthorized Error
422
Unprocessable Entity Error
500
Internal Server Error
List room streams
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
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.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)Path parameters
idstringRequiredformat: "uuid"
Unique ID of the video room.
Response
The request has succeeded.
linksobject
Pagination links.
datalist of objects
List of streams.
Errors
401
Unauthorized Error
422
Unprocessable Entity Error
500
Internal Server Error
Update stream
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
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.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)Path parameters
idstringRequiredformat: "uuid"
Unique ID of the stream.
Request
This endpoint expects an object.
urlstringRequired
RTMP or RTMPS URL. This must be the address of a server accepting incoming RTMP/RTMPS streams.
Response
Stream response object.
idstringformat: "uuid"
Unique identifier for the stream.
urlstring or null
RTMP or RTMPS URL. This must be the address of a server accepting incoming RTMP/RTMPS streams.
stream_typestring or null
The type of stream.
widthinteger or null
The stream's width in pixels.
heightinteger or null
The stream's height in pixels.
fpsinteger or null
The stream's frames per second.
created_atdatetime
Timestamp when the stream was created.
updated_atdatetime
Timestamp when the stream was last updated.
Errors
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error
Create video conference
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Create a Video Conference.
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.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)Request
This endpoint expects an object.
display_namestringRequired<=200 characters
Display name of the video conference. Maximum of 200 characters.
namestringOptionalformat: "^[A-Za-z0-9_-]+$"``<=100 characters
A named unique identifier for the conference. Allowed characters: A-Za-z0-9_-. Maximum of 100 characters.
descriptionstringOptional<=3000 characters
Description of the conference. Maximum of 3000 characters.
join_fromdatetimeOptional
Conference does not accept new participants before this time. Expects RFC 3339 datetime: 2022-01-01T23:59:60Z. Date only: 2022-01-01 will be converted to 2022-01-01T00:00:00Z.
join_untildatetimeOptional
Conference stops accepting new participants at this time, but keeps running until all participants leave. Expects RFC 3339 datetime: 2022-01-01T23:59:60Z. Date only: 2022-01-01 will be converted to 2022-01-01T00:00:00Z.
qualityenumOptionalDefaults to 720p
The conference's resolution.
Allowed values:720p1080p
layoutenumOptionalDefaults to grid-responsive
The conference's initial layout.
Show 13 enum values
sizeenumOptionalDefaults to medium
The size of the video conference.
Allowed values:smallmediumlarge
record_on_startbooleanOptional
Whether to start recording when a conference session begins.
enable_room_previewsbooleanOptional
Whether a preview video of the conference content is generated.
enable_chatbooleanOptionalDefaults to true
Whether group chat is enabled for conference participants.
dark_primarystringOptionalformat: "^#[0-9a-fA-F]{6}$"Defaults to #044EF4
CTA buttons and selected items color (dark theme).
dark_backgroundstringOptionalformat: "^#[0-9a-fA-F]{6}$"Defaults to #FFFFFF
Main background color (dark theme).
dark_foregroundstringOptionalformat: "^#[0-9a-fA-F]{6}$"Defaults to #1D2127
Main foreground color (dark theme).
dark_successstringOptionalformat: "^#[0-9a-fA-F]{6}$"Defaults to #17BB58
Success indication color (dark theme).
dark_negativestringOptionalformat: "^#[0-9a-fA-F]{6}$"Defaults to #F42C50
Error indication color (dark theme).
light_primarystringOptionalformat: "^#[0-9a-fA-F]{6}$"Defaults to #044EF4
CTA buttons and selected items color (light theme).
light_backgroundstringOptionalformat: "^#[0-9a-fA-F]{6}$"Defaults to #FFFFFF
Main background color (light theme).
light_foregroundstringOptionalformat: "^#[0-9a-fA-F]{6}$"Defaults to #1D2127
Main foreground color (light theme).
light_successstringOptionalformat: "^#[0-9a-fA-F]{6}$"Defaults to #17BB58
Success indication color (light theme).
light_negativestringOptionalformat: "^#[0-9a-fA-F]{6}$"Defaults to #F42C50
Error indication color (light theme).
Response
Conference response wrapper.
idstringformat: "uuid"
Unique ID of the video conference.
namestring
A named unique identifier for the conference. Allowed characters: A-Za-z0-9_-.
display_namestring or null
Display name of the video conference. Maximum of 200 characters.
descriptionstring or null
Description of the conference. Maximum of 3000 characters.
join_fromdatetime or null
Conference does not accept new participants before this time.
join_untildatetime or null
Conference stops accepting new participants at this time, but keeps running until all participants leave.
qualityenum
The conference's resolution.
Allowed values:720p1080p
layoutenum
The conference's initial layout.
Show 13 enum values
sizeenum or null
The size of the video conference.
Allowed values:smallmediumlarge
record_on_startboolean
Whether to start recording when a conference session begins.
tone_on_entry_and_exitboolean
Whether a tone is played when a member enters or exits the conference.
user_join_video_offboolean
Whether participants join with video off by user setting.
room_join_video_offboolean
Whether participants join with video off by room setting.
enable_chatboolean
Whether group chat is enabled for conference participants.
enable_room_previewsboolean or null
Whether a preview video of the conference content is generated.
dark_primarystring or null
CTA buttons and selected items color (dark theme).
dark_backgroundstring or null
Main background color (dark theme).
dark_foregroundstring or null
Main foreground color (dark theme).
dark_successstring or null
Success indication color (dark theme).
dark_negativestring or null
Error indication color (dark theme).
light_primarystring or null
CTA buttons and selected items color (light theme).
light_backgroundstring or null
Main background color (light theme).
light_foregroundstring or null
Main foreground color (light theme).
light_successstring or null
Success indication color (light theme).
light_negativestring or null
Error indication color (light theme).
metaobject or null
User-defined metadata for the conference.
created_atdatetime
Timestamp when the conference was created.
updated_atdatetime
Timestamp when the conference was last updated.
active_sessionobject
Active session information. Only present when requested via the include_active_session query parameter.
Show 20 properties
Errors
400
Bad Request Error
401
Unauthorized Error
422
Unprocessable Entity Error
500
Internal Server Error
Delete video conference
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Delete a Video Conference.
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.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)Path parameters
idstringRequiredformat: "uuid"
Unique ID of the video conference.
Response
There is no content to send for this request, but the headers may be useful.
Errors
400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error
Get video conference
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Find a Video Conference by ID.
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.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)Path parameters
idstringRequiredformat: "uuid"
Unique ID of the video conference.
Query parameters
include_active_sessionbooleanOptional
Specifies whether to include information about the conference’s active session (if any).
Response
Conference response wrapper.
idstringformat: "uuid"
Unique ID of the video conference.
namestring
A named unique identifier for the conference. Allowed characters: A-Za-z0-9_-.
display_namestring or null
Display name of the video conference. Maximum of 200 characters.
descriptionstring or null
Description of the conference. Maximum of 3000 characters.
join_fromdatetime or null
Conference does not accept new participants before this time.
join_untildatetime or null
Conference stops accepting new participants at this time, but keeps running until all participants leave.
qualityenum
The conference's resolution.
Allowed values:720p1080p
layoutenum
The conference's initial layout.
Show 13 enum values
sizeenum or null
The size of the video conference.
Allowed values:smallmediumlarge
record_on_startboolean
Whether to start recording when a conference session begins.
tone_on_entry_and_exitboolean
Whether a tone is played when a member enters or exits the conference.
user_join_video_offboolean
Whether participants join with video off by user setting.
room_join_video_offboolean
Whether participants join with video off by room setting.
enable_chatboolean
Whether group chat is enabled for conference participants.
enable_room_previewsboolean or null
Whether a preview video of the conference content is generated.
dark_primarystring or null
CTA buttons and selected items color (dark theme).
dark_backgroundstring or null
Main background color (dark theme).
dark_foregroundstring or null
Main foreground color (dark theme).
dark_successstring or null
Success indication color (dark theme).
dark_negativestring or null
Error indication color (dark theme).
light_primarystring or null
CTA buttons and selected items color (light theme).
light_backgroundstring or null
Main background color (light theme).
light_foregroundstring or null
Main foreground color (light theme).
light_successstring or null
Success indication color (light theme).
light_negativestring or null
Error indication color (light theme).
metaobject or null
User-defined metadata for the conference.
created_atdatetime
Timestamp when the conference was created.
updated_atdatetime
Timestamp when the conference was last updated.
active_sessionobject
Active session information. Only present when requested via the include_active_session query parameter.
Show 20 properties
Errors
400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error
List video conferences
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
List Video Conferences.
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.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)Query parameters
starts_afterstringOptional
Return conferences with a join_from time on or after this timestamp. Accepts RFC 3339 datetime or Unix timestamp.
ends_beforestringOptional
Return conferences with a join_until time on or before this timestamp. Accepts RFC 3339 datetime or Unix timestamp.
include_active_sessionbooleanOptional
Specifies whether to include information about the conference’s active session (if any).
page_numberintegerOptional>=0Defaults to 0
Page number to return. Requires page_token for values greater than 0.
page_sizeintegerOptional1-1000Defaults to 50
Specify the number of results to return on a single page. The default page size is 50 and the maximum is 1000.
page_tokenstringOptional
Token for cursor-based pagination. Required when page_number is greater than 0.
Response
The request has succeeded.
linksobject
Pagination links.
Show 4 properties
datalist of objects
List of conferences.
Show 29 properties
Errors
400
Bad Request Error
401
Unauthorized Error
422
Unprocessable Entity Error
500
Internal Server Error
Update video conference
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Update a Video Conference.
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.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)Path parameters
idstringRequiredformat: "uuid"
Unique ID of the video conference.
Request
This endpoint expects an object.
display_namestringRequired<=200 characters
Display name of the video conference. Maximum of 200 characters.
descriptionstringOptional<=3000 characters
Description of the conference. Maximum of 3000 characters.
join_fromdatetimeOptional
Conference does not accept new participants before this time. Expects RFC 3339 datetime: 2022-01-01T23:59:60Z. Date only: 2022-01-01 will be converted to 2022-01-01T00:00:00Z.
join_untildatetimeOptional
Conference stops accepting new participants at this time, but keeps running until all participants leave. Expects RFC 3339 datetime: 2022-01-01T23:59:60Z. Date only: 2022-01-01 will be converted to 2022-01-01T00:00:00Z.
qualityenumOptionalDefaults to 720p
The conference's resolution.
Allowed values:720p1080p
layoutenumOptionalDefaults to grid-responsive
The conference's initial layout.
Show 13 enum values
sizeenumOptionalDefaults to medium
The size of the video conference.
Allowed values:smallmediumlarge
record_on_startbooleanOptional
Whether to start recording when a conference session begins.
tone_on_entry_and_exitbooleanOptional
Whether a tone is played when a member enters or exits the conference.
room_join_video_offbooleanOptional
Whether participants join with video off by room setting.
user_join_video_offbooleanOptional
Whether participants join with video off by user setting.
enable_room_previewsbooleanOptional
Whether a preview video of the conference content is generated.
enable_chatbooleanOptional
Whether group chat is enabled for conference participants.
dark_primarystringOptionalformat: "^#[0-9a-fA-F]{6}$"
CTA buttons and selected items color (dark theme).
dark_backgroundstringOptionalformat: "^#[0-9a-fA-F]{6}$"
Main background color (dark theme).
dark_foregroundstringOptionalformat: "^#[0-9a-fA-F]{6}$"
Main foreground color (dark theme).
dark_successstringOptionalformat: "^#[0-9a-fA-F]{6}$"
Success indication color (dark theme).
dark_negativestringOptionalformat: "^#[0-9a-fA-F]{6}$"
Error indication color (dark theme).
light_primarystringOptionalformat: "^#[0-9a-fA-F]{6}$"
CTA buttons and selected items color (light theme).
light_backgroundstringOptionalformat: "^#[0-9a-fA-F]{6}$"
Main background color (light theme).
light_foregroundstringOptionalformat: "^#[0-9a-fA-F]{6}$"
Main foreground color (light theme).
light_successstringOptionalformat: "^#[0-9a-fA-F]{6}$"
Success indication color (light theme).
light_negativestringOptionalformat: "^#[0-9a-fA-F]{6}$"
Error indication color (light theme).
Response
Conference response wrapper.
idstringformat: "uuid"
Unique ID of the video conference.
namestring
A named unique identifier for the conference. Allowed characters: A-Za-z0-9_-.
display_namestring or null
Display name of the video conference. Maximum of 200 characters.
descriptionstring or null
Description of the conference. Maximum of 3000 characters.
join_fromdatetime or null
Conference does not accept new participants before this time.
join_untildatetime or null
Conference stops accepting new participants at this time, but keeps running until all participants leave.
qualityenum
The conference's resolution.
Allowed values:720p1080p
layoutenum
The conference's initial layout.
Show 13 enum values
sizeenum or null
The size of the video conference.
Allowed values:smallmediumlarge
record_on_startboolean
Whether to start recording when a conference session begins.
tone_on_entry_and_exitboolean
Whether a tone is played when a member enters or exits the conference.
user_join_video_offboolean
Whether participants join with video off by user setting.
room_join_video_offboolean
Whether participants join with video off by room setting.
enable_chatboolean
Whether group chat is enabled for conference participants.
enable_room_previewsboolean or null
Whether a preview video of the conference content is generated.
dark_primarystring or null
CTA buttons and selected items color (dark theme).
dark_backgroundstring or null
Main background color (dark theme).
dark_foregroundstring or null
Main foreground color (dark theme).
dark_successstring or null
Success indication color (dark theme).
dark_negativestring or null
Error indication color (dark theme).
light_primarystring or null
CTA buttons and selected items color (light theme).
light_backgroundstring or null
Main background color (light theme).
light_foregroundstring or null
Main foreground color (light theme).
light_successstring or null
Success indication color (light theme).
light_negativestring or null
Error indication color (light theme).
metaobject or null
User-defined metadata for the conference.
created_atdatetime
Timestamp when the conference was created.
updated_atdatetime
Timestamp when the conference was last updated.
active_sessionobject
Active session information. Only present when requested via the include_active_session query parameter.
Show 20 properties
Errors
400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error