Appearance
Video
FreshGet conference token
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
Get room recording
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
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
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
For a complete index of all SignalWire documentation pages, fetch https://signalwire.com/docs/llms.txt
# Delete room
DELETE https://%7BYour_Space_Name%7D.signalwire.com/api/video/rooms/
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](/docs/platform/your-signalwire-api-space).
Reference: https://signalwire.com/docs/apis/rest/video/rooms/delete-room
## OpenAPI Specification
```yaml openapi: 3.1.0 info: title: signalwire-rest version: 1.0.0 paths: /api/video/rooms/{id}: delete: operationId: delete-room summary: Delete room 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](/docs/platform/your-signalwire-api-space). tags: - subpackage_rooms parameters: - name: id in: path required: true schema: type: string format: uuid - name: Authorization in: header 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)
``` required: true schema: type: string responses: '200': '400': content: application/json: schema: $ref: '#/components/schemas/Types.StatusCodes.StatusCode400' '401': content: application/json: schema: $ref: '#/components/schemas/Types.StatusCodes.StatusCode401' '404': content: application/json: schema: $ref: '#/components/schemas/Types.StatusCodes.StatusCode404' '500': content: application/json: schema: $ref: '#/components/schemas/Types.StatusCodes.StatusCode500' servers: - url: https://%7BYour_Space_Name%7D.signalwire.com components: schemas: TypesStatusCodesStatusCode400Error: type: string enum: - Bad Request title: TypesStatusCodesStatusCode400Error Types.StatusCodes.StatusCode400: type: object properties: error: $ref: '#/components/schemas/TypesStatusCodesStatusCode400Error' required: - error title: Types.StatusCodes.StatusCode400 TypesStatusCodesStatusCode401Error: type: string enum: - Unauthorized title: TypesStatusCodesStatusCode401Error Types.StatusCodes.StatusCode401: type: object properties: error: $ref: '#/components/schemas/TypesStatusCodesStatusCode401Error' required: - error title: Types.StatusCodes.StatusCode401 TypesStatusCodesStatusCode404Error: type: string enum: - Not Found title: TypesStatusCodesStatusCode404Error Types.StatusCodes.StatusCode404: type: object properties: error: $ref: '#/components/schemas/TypesStatusCodesStatusCode404Error' required: - error title: Types.StatusCodes.StatusCode404 TypesStatusCodesStatusCode500Error: type: string enum: - Internal Server Error title: TypesStatusCodesStatusCode500Error Types.StatusCodes.StatusCode500: type: object properties: error: $ref: '#/components/schemas/TypesStatusCodesStatusCode500Error' required: - error title: Types.StatusCodes.StatusCode500 securitySchemes: SignalWireBasicAuth: type: http scheme: basic 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)
```
```
## SDK Code Examples
```python import requests
url = "https://{your_space_name}.signalwire.com/api/video/rooms/id"
response = requests.delete(url, auth=("", ""))
print(response.json()) ```
```javascript const url = 'https://{your_space_name}.signalwire.com/api/video/rooms/id'; const credentials = btoa("😊;
const options = {method: 'DELETE', headers: {Authorization: `Basic ${credentials}`}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ```
```go package main
import ( "fmt" "net/http" "io" )
func main() {
url := "https://{your_space_name}.signalwire.com/api/video/rooms/id"
req, _ := http.NewRequest("DELETE", url, nil)
req.SetBasicAuth("", "")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close() body, _ := io.ReadAll(res.Body)
fmt.Println(res) fmt.Println(string(body))
} ```
```ruby require 'uri' require 'net/http'
url = URI("https://{your_space_name}.signalwire.com/api/video/rooms/id")
http = Net::HTTP.new(url.host, url.port) http.use_ssl = true
request = Net::HTTP::Delete.new(url) request.basic_auth("", "")
response = http.request(request) puts response.read_body ```
```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest;
HttpResponse response = Unirest.delete("https://{your_space_name}.signalwire.com/api/video/rooms/id") .basicAuth("", "") .asString(); ```
```php request('DELETE', 'https://{your_space_name}.signalwire.com/api/video/rooms/id', [
'headers' => [
],
'auth' => ['', ''],
]);
echo $response->getBody(); ```
```csharp using RestSharp; using RestSharp.Authenticators;
var client = new RestClient("https://{your_space_name}.signalwire.com/api/video/rooms/id"); client.Authenticator = new HttpBasicAuthenticator("", ""); var request = new RestRequest(Method.DELETE);
IRestResponse response = client.Execute(request); ```
```swift import Foundation
let credentials = Data(":".utf8).base64EncodedString()
let headers = ["Authorization": "Basic \(credentials)"]
let request = NSMutableURLRequest(url: NSURL(string: "https://{your_space_name}.signalwire.com/api/video/rooms/id")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "DELETE" request.allHTTPHeaderFields = headers
let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } })
dataTask.resume() ```
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