Conference v1.0
Operations supporting multi-party video call applications
You are viewing REST API documentation. This documentation is auto-generated from a swagger specification which itself is generated from annotations in the source code of the project. It is possible that this documentation includes bugs and that code samples are incomplete or wrong.
Authentication
OAuth 2.0 Authorization. Authenticate using client credentials
Flow: clientCredentials
OAuth 2.0 Authorization URL = https://auvious.video/security/oauth/authorize
OAuth 2.0 Token URL = https://auvious.video/security/oauth/token
OAuth 2.0 Scope
Scope Scope Description any this is the default
HTTP Authentication, scheme: bearer jwt bearer token access
Conferences
Conference Controller
Adds ice candidates for a published stream. Must be called after publishStream request.
POST https://auvious.video:443/rtc-api/conferences/addPublishStreamIceCandidates HTTP/1.1
Host: auvious.video:443
Content-Type: application/json
Request body
{
"conferenceId": "string",
"iceCandidates": [
{
"candidate": "string",
"sdpMLineIndex": 0,
"sdpMid": "string"
}
],
"streamId": {
"id": "string"
},
"userEndpointId": "string"
}
Parameters
Parameter | In | Type | Required | Description |
---|---|---|---|---|
body | body | ConferencePublishStreamIceCandidatesWebCommand | false | none |
Responses
Overview
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Created | None |
204 | No Content | No Content | None |
401 | Unauthorized | Unauthorized | None |
403 | Forbidden | Forbidden | None |
404 | Not Found | Not Found | None |
To perform this operation, you must be authenticated by means of one of the following methods: Client Credentials Flow ( Scopes: global ), Jwt ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global )
Code samples
- Shell
- Go
- Node
- Java
- Python
- Ruby
curl -X POST https://auvious.video:443/rtc-api/conferences/addPublishStreamIceCandidates \
-H 'Content-Type: application/json' \ -H 'Authorization: Bearer {access-token}'
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
var body []byte
// body = ...
req, err := http.NewRequest("POST", "https://auvious.video:443/rtc-api/conferences/addPublishStreamIceCandidates", bytes.NewBuffer(body))
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
const fetch = require('node-fetch');
const input = '{
"conferenceId": "string",
"iceCandidates": [
{
"candidate": "string",
"sdpMLineIndex": 0,
"sdpMid": "string"
}
],
"streamId": {
"id": "string"
},
"userEndpointId": "string"
}';
const headers = {
'Content-Type': 'application/json', 'Authorization': 'Bearer {access-token}'
}
fetch('https://auvious.video:443/rtc-api/conferences/addPublishStreamIceCandidates', {
method: 'POST',
body: input,
headers
})
.then(r => r.json())
.then((body) => {
console.log(body)
})
// This sample needs improvement.
URL obj = new URL("https://auvious.video:443/rtc-api/conferences/addPublishStreamIceCandidates");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream())
);
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
import requests
headers = {
'Content-Type': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post(
'https://auvious.video:443/rtc-api/conferences/addPublishStreamIceCandidates',
params={},
headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://auvious.video:443/rtc-api/conferences/addPublishStreamIceCandidates',
params: {}, headers: headers
p JSON.parse(result)
Adds ice candidates for a view stream request.
POST https://auvious.video:443/rtc-api/conferences/addViewStreamIceCandidates HTTP/1.1
Host: auvious.video:443
Content-Type: application/json
Request body
{
"conferenceId": "string",
"iceCandidates": [
{
"candidate": "string",
"sdpMLineIndex": 0,
"sdpMid": "string"
}
],
"streamId": {
"id": "string"
},
"userEndpointId": "string",
"viewerId": "string"
}
Parameters
Parameter | In | Type | Required | Description |
---|---|---|---|---|
body | body | ConferenceViewStreamIceCandidatesWebCommand | false | none |
Responses
Overview
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Created | None |
204 | No Content | No Content | None |
401 | Unauthorized | Unauthorized | None |
403 | Forbidden | Forbidden | None |
404 | Not Found | Not Found | None |
To perform this operation, you must be authenticated by means of one of the following methods: Client Credentials Flow ( Scopes: global ), Jwt ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global )
Code samples
- Shell
- Go
- Node
- Java
- Python
- Ruby
curl -X POST https://auvious.video:443/rtc-api/conferences/addViewStreamIceCandidates \
-H 'Content-Type: application/json' \ -H 'Authorization: Bearer {access-token}'
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
var body []byte
// body = ...
req, err := http.NewRequest("POST", "https://auvious.video:443/rtc-api/conferences/addViewStreamIceCandidates", bytes.NewBuffer(body))
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
const fetch = require('node-fetch');
const input = '{
"conferenceId": "string",
"iceCandidates": [
{
"candidate": "string",
"sdpMLineIndex": 0,
"sdpMid": "string"
}
],
"streamId": {
"id": "string"
},
"userEndpointId": "string",
"viewerId": "string"
}';
const headers = {
'Content-Type': 'application/json', 'Authorization': 'Bearer {access-token}'
}
fetch('https://auvious.video:443/rtc-api/conferences/addViewStreamIceCandidates', {
method: 'POST',
body: input,
headers
})
.then(r => r.json())
.then((body) => {
console.log(body)
})
// This sample needs improvement.
URL obj = new URL("https://auvious.video:443/rtc-api/conferences/addViewStreamIceCandidates");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream())
);
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
import requests
headers = {
'Content-Type': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post(
'https://auvious.video:443/rtc-api/conferences/addViewStreamIceCandidates',
params={},
headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://auvious.video:443/rtc-api/conferences/addViewStreamIceCandidates',
params: {}, headers: headers
p JSON.parse(result)
Creates a conference.
POST https://auvious.video:443/rtc-api/conferences/create HTTP/1.1
Host: auvious.video:443
Content-Type: application/json
Accept: application/json
Request body
{
"conferenceId": "string",
"creatorEndpoint": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"mode": "P2P",
"organizationId": "string"
}
Parameters
Parameter | In | Type | Required | Description |
---|---|---|---|---|
body | body | CreateConferenceWebCommand | false | none |
Responses
Overview
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | ConferenceSummary |
201 | Created | Created | None |
401 | Unauthorized | Unauthorized | None |
403 | Forbidden | Forbidden | None |
404 | Not Found | Not Found | None |
Examples
200 Response
{
"id": "string",
"mode": "P2P",
"version": 0
}
To perform this operation, you must be authenticated by means of one of the following methods: Client Credentials Flow ( Scopes: global ), Jwt ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global )
Code samples
- Shell
- Go
- Node
- Java
- Python
- Ruby
curl -X POST https://auvious.video:443/rtc-api/conferences/create \
-H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {access-token}'
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
var body []byte
// body = ...
req, err := http.NewRequest("POST", "https://auvious.video:443/rtc-api/conferences/create", bytes.NewBuffer(body))
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
const fetch = require('node-fetch');
const input = '{
"conferenceId": "string",
"creatorEndpoint": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"mode": "P2P",
"organizationId": "string"
}';
const headers = {
'Content-Type': 'application/json', 'Accept': 'application/json', 'Authorization': 'Bearer {access-token}'
}
fetch('https://auvious.video:443/rtc-api/conferences/create', {
method: 'POST',
body: input,
headers
})
.then(r => r.json())
.then((body) => {
console.log(body)
})
// This sample needs improvement.
URL obj = new URL("https://auvious.video:443/rtc-api/conferences/create");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream())
);
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post(
'https://auvious.video:443/rtc-api/conferences/create',
params={},
headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://auvious.video:443/rtc-api/conferences/create',
params: {}, headers: headers
p JSON.parse(result)
Ends a conference.
POST https://auvious.video:443/rtc-api/conferences/end HTTP/1.1
Host: auvious.video:443
Content-Type: application/json
Request body
{
"conferenceId": "string",
"reason": "string",
"userEndpointId": "string"
}
Parameters
Parameter | In | Type | Required | Description |
---|---|---|---|---|
body | body | EndConferenceWebCommand | false | none |
Responses
Overview
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Created | None |
204 | No Content | No Content | None |
401 | Unauthorized | Unauthorized | None |
403 | Forbidden | Forbidden | None |
404 | Not Found | Not Found | None |
To perform this operation, you must be authenticated by means of one of the following methods: Client Credentials Flow ( Scopes: global ), Jwt ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global )
Code samples
- Shell
- Go
- Node
- Java
- Python
- Ruby
curl -X POST https://auvious.video:443/rtc-api/conferences/end \
-H 'Content-Type: application/json' \ -H 'Authorization: Bearer {access-token}'
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
var body []byte
// body = ...
req, err := http.NewRequest("POST", "https://auvious.video:443/rtc-api/conferences/end", bytes.NewBuffer(body))
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
const fetch = require('node-fetch');
const input = '{
"conferenceId": "string",
"reason": "string",
"userEndpointId": "string"
}';
const headers = {
'Content-Type': 'application/json', 'Authorization': 'Bearer {access-token}'
}
fetch('https://auvious.video:443/rtc-api/conferences/end', {
method: 'POST',
body: input,
headers
})
.then(r => r.json())
.then((body) => {
console.log(body)
})
// This sample needs improvement.
URL obj = new URL("https://auvious.video:443/rtc-api/conferences/end");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream())
);
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
import requests
headers = {
'Content-Type': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post(
'https://auvious.video:443/rtc-api/conferences/end',
params={},
headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://auvious.video:443/rtc-api/conferences/end',
params: {}, headers: headers
p JSON.parse(result)
Joins a conference
POST https://auvious.video:443/rtc-api/conferences/join HTTP/1.1
Host: auvious.video:443
Content-Type: application/json
Accept: application/json
Request body
{
"conferenceId": "string",
"metadata": {},
"userEndpointId": "string"
}
Parameters
Parameter | In | Type | Required | Description |
---|---|---|---|---|
body | body | JoinConferenceWebCommand | false | none |
Responses
Overview
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | Inline |
201 | Created | Created | None |
401 | Unauthorized | Unauthorized | None |
403 | Forbidden | Forbidden | None |
404 | Not Found | Not Found | None |
Response Schema
Examples
200 Response
{}
To perform this operation, you must be authenticated by means of one of the following methods: Client Credentials Flow ( Scopes: global ), Jwt ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global )
Code samples
- Shell
- Go
- Node
- Java
- Python
- Ruby
curl -X POST https://auvious.video:443/rtc-api/conferences/join \
-H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {access-token}'
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
var body []byte
// body = ...
req, err := http.NewRequest("POST", "https://auvious.video:443/rtc-api/conferences/join", bytes.NewBuffer(body))
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
const fetch = require('node-fetch');
const input = '{
"conferenceId": "string",
"metadata": {},
"userEndpointId": "string"
}';
const headers = {
'Content-Type': 'application/json', 'Accept': 'application/json', 'Authorization': 'Bearer {access-token}'
}
fetch('https://auvious.video:443/rtc-api/conferences/join', {
method: 'POST',
body: input,
headers
})
.then(r => r.json())
.then((body) => {
console.log(body)
})
// This sample needs improvement.
URL obj = new URL("https://auvious.video:443/rtc-api/conferences/join");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream())
);
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post(
'https://auvious.video:443/rtc-api/conferences/join',
params={},
headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://auvious.video:443/rtc-api/conferences/join',
params: {}, headers: headers
p JSON.parse(result)
Leaves a conference.
POST https://auvious.video:443/rtc-api/conferences/leave HTTP/1.1
Host: auvious.video:443
Content-Type: application/json
Request body
{
"conferenceId": "string",
"reason": "string",
"userEndpointId": "string"
}
Parameters
Parameter | In | Type | Required | Description |
---|---|---|---|---|
body | body | LeaveConferenceWebCommand | false | none |
Responses
Overview
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Created | None |
204 | No Content | No Content | None |
401 | Unauthorized | Unauthorized | None |
403 | Forbidden | Forbidden | None |
404 | Not Found | Not Found | None |
To perform this operation, you must be authenticated by means of one of the following methods: Client Credentials Flow ( Scopes: global ), Jwt ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global )
Code samples
- Shell
- Go
- Node
- Java
- Python
- Ruby
curl -X POST https://auvious.video:443/rtc-api/conferences/leave \
-H 'Content-Type: application/json' \ -H 'Authorization: Bearer {access-token}'
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
var body []byte
// body = ...
req, err := http.NewRequest("POST", "https://auvious.video:443/rtc-api/conferences/leave", bytes.NewBuffer(body))
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
const fetch = require('node-fetch');
const input = '{
"conferenceId": "string",
"reason": "string",
"userEndpointId": "string"
}';
const headers = {
'Content-Type': 'application/json', 'Authorization': 'Bearer {access-token}'
}
fetch('https://auvious.video:443/rtc-api/conferences/leave', {
method: 'POST',
body: input,
headers
})
.then(r => r.json())
.then((body) => {
console.log(body)
})
// This sample needs improvement.
URL obj = new URL("https://auvious.video:443/rtc-api/conferences/leave");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream())
);
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
import requests
headers = {
'Content-Type': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post(
'https://auvious.video:443/rtc-api/conferences/leave',
params={},
headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://auvious.video:443/rtc-api/conferences/leave',
params: {}, headers: headers
p JSON.parse(result)
Publish a stream to the conference.
POST https://auvious.video:443/rtc-api/conferences/publishStream HTTP/1.1
Host: auvious.video:443
Content-Type: application/json
Accept: application/json
Request body
{
"conferenceId": "string",
"conferenceStreamType": "CAM",
"metadata": {},
"sdpOffer": "string",
"streamId": {
"id": "string"
},
"userEndpointId": "string",
"videoBitrate": 0
}
Parameters
Parameter | In | Type | Required | Description |
---|---|---|---|---|
body | body | ConferencePublishStreamWebCommand | false | none |
Responses
Overview
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | ConferencePublishResult |
201 | Created | Created | None |
401 | Unauthorized | Unauthorized | None |
403 | Forbidden | Forbidden | None |
404 | Not Found | Not Found | None |
Examples
200 Response
{
"sdpAnswer": "string",
"streamId": {
"id": "string"
}
}
To perform this operation, you must be authenticated by means of one of the following methods: Client Credentials Flow ( Scopes: global ), Jwt ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global )
Code samples
- Shell
- Go
- Node
- Java
- Python
- Ruby
curl -X POST https://auvious.video:443/rtc-api/conferences/publishStream \
-H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {access-token}'
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
var body []byte
// body = ...
req, err := http.NewRequest("POST", "https://auvious.video:443/rtc-api/conferences/publishStream", bytes.NewBuffer(body))
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
const fetch = require('node-fetch');
const input = '{
"conferenceId": "string",
"conferenceStreamType": "CAM",
"metadata": {},
"sdpOffer": "string",
"streamId": {
"id": "string"
},
"userEndpointId": "string",
"videoBitrate": 0
}';
const headers = {
'Content-Type': 'application/json', 'Accept': 'application/json', 'Authorization': 'Bearer {access-token}'
}
fetch('https://auvious.video:443/rtc-api/conferences/publishStream', {
method: 'POST',
body: input,
headers
})
.then(r => r.json())
.then((body) => {
console.log(body)
})
// This sample needs improvement.
URL obj = new URL("https://auvious.video:443/rtc-api/conferences/publishStream");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream())
);
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post(
'https://auvious.video:443/rtc-api/conferences/publishStream',
params={},
headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://auvious.video:443/rtc-api/conferences/publishStream',
params: {}, headers: headers
p JSON.parse(result)
Sends event to all user endpoints that are currently joined on conference defined by conferenceId
POST https://auvious.video:443/rtc-api/conferences/sendEvent HTTP/1.1
Host: auvious.video:443
Content-Type: application/json
Accept: application/json
Returns number of messages sent. Only users with 'SERVICE' role allowed
Request body
{
"conferenceId": "string",
"event": {},
"masks": [
"string"
],
"qos": "AT_LEAST_ONCE"
}
Parameters
Parameter | In | Type | Required | Description |
---|---|---|---|---|
body | body | SendEventToConferenceWebCommand | false | none |
Responses
Overview
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | SendEventResponse |
201 | Created | Created | None |
401 | Unauthorized | Unauthorized | None |
403 | Forbidden | Forbidden | None |
404 | Not Found | Not Found | None |
Examples
200 Response
{
"eventsSent": 0
}
To perform this operation, you must be authenticated by means of one of the following methods: Client Credentials Flow ( Scopes: global ), Jwt ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global )
Code samples
- Shell
- Go
- Node
- Java
- Python
- Ruby
curl -X POST https://auvious.video:443/rtc-api/conferences/sendEvent \
-H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {access-token}'
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
var body []byte
// body = ...
req, err := http.NewRequest("POST", "https://auvious.video:443/rtc-api/conferences/sendEvent", bytes.NewBuffer(body))
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
const fetch = require('node-fetch');
const input = '{
"conferenceId": "string",
"event": {},
"masks": [
"string"
],
"qos": "AT_LEAST_ONCE"
}';
const headers = {
'Content-Type': 'application/json', 'Accept': 'application/json', 'Authorization': 'Bearer {access-token}'
}
fetch('https://auvious.video:443/rtc-api/conferences/sendEvent', {
method: 'POST',
body: input,
headers
})
.then(r => r.json())
.then((body) => {
console.log(body)
})
// This sample needs improvement.
URL obj = new URL("https://auvious.video:443/rtc-api/conferences/sendEvent");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream())
);
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post(
'https://auvious.video:443/rtc-api/conferences/sendEvent',
params={},
headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://auvious.video:443/rtc-api/conferences/sendEvent',
params: {}, headers: headers
p JSON.parse(result)
Request to stop viewing a stream. Should be called when leaving, or when ConferenceStreamUnpublishedEvent is received
POST https://auvious.video:443/rtc-api/conferences/stopViewStream HTTP/1.1
Host: auvious.video:443
Content-Type: application/json
Request body
{
"conferenceId": "string",
"streamId": {
"id": "string"
},
"userEndpointId": "string",
"viewerId": "string"
}
Parameters
Parameter | In | Type | Required | Description |
---|---|---|---|---|
body | body | ConferenceStopViewStreamWebCommand | false | none |
Responses
Overview
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Created | None |
204 | No Content | No Content | None |
401 | Unauthorized | Unauthorized | None |
403 | Forbidden | Forbidden | None |
404 | Not Found | Not Found | None |
To perform this operation, you must be authenticated by means of one of the following methods: Client Credentials Flow ( Scopes: global ), Jwt ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global )
Code samples
- Shell
- Go
- Node
- Java
- Python
- Ruby
curl -X POST https://auvious.video:443/rtc-api/conferences/stopViewStream \
-H 'Content-Type: application/json' \ -H 'Authorization: Bearer {access-token}'
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
var body []byte
// body = ...
req, err := http.NewRequest("POST", "https://auvious.video:443/rtc-api/conferences/stopViewStream", bytes.NewBuffer(body))
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
const fetch = require('node-fetch');
const input = '{
"conferenceId": "string",
"streamId": {
"id": "string"
},
"userEndpointId": "string",
"viewerId": "string"
}';
const headers = {
'Content-Type': 'application/json', 'Authorization': 'Bearer {access-token}'
}
fetch('https://auvious.video:443/rtc-api/conferences/stopViewStream', {
method: 'POST',
body: input,
headers
})
.then(r => r.json())
.then((body) => {
console.log(body)
})
// This sample needs improvement.
URL obj = new URL("https://auvious.video:443/rtc-api/conferences/stopViewStream");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream())
);
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
import requests
headers = {
'Content-Type': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post(
'https://auvious.video:443/rtc-api/conferences/stopViewStream',
params={},
headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://auvious.video:443/rtc-api/conferences/stopViewStream',
params: {}, headers: headers
p JSON.parse(result)
Unpublish a stream from the conference.
POST https://auvious.video:443/rtc-api/conferences/unpublishStream HTTP/1.1
Host: auvious.video:443
Content-Type: application/json
Request body
{
"conferenceId": "string",
"streamId": {
"id": "string"
},
"userEndpointId": "string"
}
Parameters
Parameter | In | Type | Required | Description |
---|---|---|---|---|
body | body | ConferenceUnpublishStreamWebCommand | false | none |
Responses
Overview
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Created | None |
204 | No Content | No Content | None |
401 | Unauthorized | Unauthorized | None |
403 | Forbidden | Forbidden | None |
404 | Not Found | Not Found | None |
To perform this operation, you must be authenticated by means of one of the following methods: Client Credentials Flow ( Scopes: global ), Jwt ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global )
Code samples
- Shell
- Go
- Node
- Java
- Python
- Ruby
curl -X POST https://auvious.video:443/rtc-api/conferences/unpublishStream \
-H 'Content-Type: application/json' \ -H 'Authorization: Bearer {access-token}'
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
var body []byte
// body = ...
req, err := http.NewRequest("POST", "https://auvious.video:443/rtc-api/conferences/unpublishStream", bytes.NewBuffer(body))
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
const fetch = require('node-fetch');
const input = '{
"conferenceId": "string",
"streamId": {
"id": "string"
},
"userEndpointId": "string"
}';
const headers = {
'Content-Type': 'application/json', 'Authorization': 'Bearer {access-token}'
}
fetch('https://auvious.video:443/rtc-api/conferences/unpublishStream', {
method: 'POST',
body: input,
headers
})
.then(r => r.json())
.then((body) => {
console.log(body)
})
// This sample needs improvement.
URL obj = new URL("https://auvious.video:443/rtc-api/conferences/unpublishStream");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream())
);
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
import requests
headers = {
'Content-Type': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post(
'https://auvious.video:443/rtc-api/conferences/unpublishStream',
params={},
headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://auvious.video:443/rtc-api/conferences/unpublishStream',
params: {}, headers: headers
p JSON.parse(result)
Updates conference metadata
POST https://auvious.video:443/rtc-api/conferences/updateMetadata HTTP/1.1
Host: auvious.video:443
Content-Type: application/json
Request body
{
"conferenceId": "string",
"key": "string",
"operation": "REMOVE",
"userEndpointId": "string",
"value": "string"
}
Parameters
Parameter | In | Type | Required | Description |
---|---|---|---|---|
body | body | UpdateConferenceMetadataWebCommand | false | none |
Responses
Overview
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Created | None |
204 | No Content | No Content | None |
401 | Unauthorized | Unauthorized | None |
403 | Forbidden | Forbidden | None |
404 | Not Found | Not Found | None |
To perform this operation, you must be authenticated by means of one of the following methods: Client Credentials Flow ( Scopes: global ), Jwt ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global )
Code samples
- Shell
- Go
- Node
- Java
- Python
- Ruby
curl -X POST https://auvious.video:443/rtc-api/conferences/updateMetadata \
-H 'Content-Type: application/json' \ -H 'Authorization: Bearer {access-token}'
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
var body []byte
// body = ...
req, err := http.NewRequest("POST", "https://auvious.video:443/rtc-api/conferences/updateMetadata", bytes.NewBuffer(body))
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
const fetch = require('node-fetch');
const input = '{
"conferenceId": "string",
"key": "string",
"operation": "REMOVE",
"userEndpointId": "string",
"value": "string"
}';
const headers = {
'Content-Type': 'application/json', 'Authorization': 'Bearer {access-token}'
}
fetch('https://auvious.video:443/rtc-api/conferences/updateMetadata', {
method: 'POST',
body: input,
headers
})
.then(r => r.json())
.then((body) => {
console.log(body)
})
// This sample needs improvement.
URL obj = new URL("https://auvious.video:443/rtc-api/conferences/updateMetadata");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream())
);
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
import requests
headers = {
'Content-Type': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post(
'https://auvious.video:443/rtc-api/conferences/updateMetadata',
params={},
headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://auvious.video:443/rtc-api/conferences/updateMetadata',
params: {}, headers: headers
p JSON.parse(result)
Updates conference participant metadata
POST https://auvious.video:443/rtc-api/conferences/updateParticipantMetadata HTTP/1.1
Host: auvious.video:443
Content-Type: application/json
Accept: application/json
Request body
{
"conferenceId": "string",
"newMetadata": {},
"userEndpointId": "string"
}
Parameters
Parameter | In | Type | Required | Description |
---|---|---|---|---|
body | body | UpdateConferenceParticipantMetadataWebCommand | false | none |
Responses
Overview
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Created | None |
204 | No Content | No Content | None |
401 | Unauthorized | Unauthorized | None |
403 | Forbidden | Forbidden | None |
404 | Not Found | Not Found | None |
Response Schema
Examples
To perform this operation, you must be authenticated by means of one of the following methods: Client Credentials Flow ( Scopes: global ), Jwt ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global )
Code samples
- Shell
- Go
- Node
- Java
- Python
- Ruby
curl -X POST https://auvious.video:443/rtc-api/conferences/updateParticipantMetadata \
-H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {access-token}'
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
var body []byte
// body = ...
req, err := http.NewRequest("POST", "https://auvious.video:443/rtc-api/conferences/updateParticipantMetadata", bytes.NewBuffer(body))
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
const fetch = require('node-fetch');
const input = '{
"conferenceId": "string",
"newMetadata": {},
"userEndpointId": "string"
}';
const headers = {
'Content-Type': 'application/json', 'Accept': 'application/json', 'Authorization': 'Bearer {access-token}'
}
fetch('https://auvious.video:443/rtc-api/conferences/updateParticipantMetadata', {
method: 'POST',
body: input,
headers
})
.then(r => r.json())
.then((body) => {
console.log(body)
})
// This sample needs improvement.
URL obj = new URL("https://auvious.video:443/rtc-api/conferences/updateParticipantMetadata");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream())
);
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post(
'https://auvious.video:443/rtc-api/conferences/updateParticipantMetadata',
params={},
headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://auvious.video:443/rtc-api/conferences/updateParticipantMetadata',
params: {}, headers: headers
p JSON.parse(result)
Update the bitrate of a conference stream.
POST https://auvious.video:443/rtc-api/conferences/updatePublishedStreamBitrate HTTP/1.1
Host: auvious.video:443
Content-Type: application/json
Request body
{
"conferenceId": "string",
"streamId": {
"id": "string"
},
"userEndpointId": "string",
"videoBitrate": 0
}
Parameters
Parameter | In | Type | Required | Description |
---|---|---|---|---|
body | body | ConferenceUpdatePublishedStreamBitrateWebCommand | false | none |
Responses
Overview
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Created | None |
204 | No Content | No Content | None |
401 | Unauthorized | Unauthorized | None |
403 | Forbidden | Forbidden | None |
404 | Not Found | Not Found | None |
To perform this operation, you must be authenticated by means of one of the following methods: Client Credentials Flow ( Scopes: global ), Jwt ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global )
Code samples
- Shell
- Go
- Node
- Java
- Python
- Ruby
curl -X POST https://auvious.video:443/rtc-api/conferences/updatePublishedStreamBitrate \
-H 'Content-Type: application/json' \ -H 'Authorization: Bearer {access-token}'
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
var body []byte
// body = ...
req, err := http.NewRequest("POST", "https://auvious.video:443/rtc-api/conferences/updatePublishedStreamBitrate", bytes.NewBuffer(body))
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
const fetch = require('node-fetch');
const input = '{
"conferenceId": "string",
"streamId": {
"id": "string"
},
"userEndpointId": "string",
"videoBitrate": 0
}';
const headers = {
'Content-Type': 'application/json', 'Authorization': 'Bearer {access-token}'
}
fetch('https://auvious.video:443/rtc-api/conferences/updatePublishedStreamBitrate', {
method: 'POST',
body: input,
headers
})
.then(r => r.json())
.then((body) => {
console.log(body)
})
// This sample needs improvement.
URL obj = new URL("https://auvious.video:443/rtc-api/conferences/updatePublishedStreamBitrate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream())
);
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
import requests
headers = {
'Content-Type': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post(
'https://auvious.video:443/rtc-api/conferences/updatePublishedStreamBitrate',
params={},
headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://auvious.video:443/rtc-api/conferences/updatePublishedStreamBitrate',
params: {}, headers: headers
p JSON.parse(result)
Updates conference stream metadata
POST https://auvious.video:443/rtc-api/conferences/updateStreamMetadata HTTP/1.1
Host: auvious.video:443
Content-Type: application/json
Accept: application/json
Request body
{
"conferenceId": "string",
"newMetadata": {},
"streamId": {
"id": "string"
},
"userEndpointId": "string"
}
Parameters
Parameter | In | Type | Required | Description |
---|---|---|---|---|
body | body | UpdateConferenceStreamMetadataWebCommand | false | none |
Responses
Overview
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Created | None |
204 | No Content | No Content | None |
401 | Unauthorized | Unauthorized | None |
403 | Forbidden | Forbidden | None |
404 | Not Found | Not Found | None |
Response Schema
Examples
To perform this operation, you must be authenticated by means of one of the following methods: Client Credentials Flow ( Scopes: global ), Jwt ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global )
Code samples
- Shell
- Go
- Node
- Java
- Python
- Ruby
curl -X POST https://auvious.video:443/rtc-api/conferences/updateStreamMetadata \
-H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {access-token}'
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
var body []byte
// body = ...
req, err := http.NewRequest("POST", "https://auvious.video:443/rtc-api/conferences/updateStreamMetadata", bytes.NewBuffer(body))
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
const fetch = require('node-fetch');
const input = '{
"conferenceId": "string",
"newMetadata": {},
"streamId": {
"id": "string"
},
"userEndpointId": "string"
}';
const headers = {
'Content-Type': 'application/json', 'Accept': 'application/json', 'Authorization': 'Bearer {access-token}'
}
fetch('https://auvious.video:443/rtc-api/conferences/updateStreamMetadata', {
method: 'POST',
body: input,
headers
})
.then(r => r.json())
.then((body) => {
console.log(body)
})
// This sample needs improvement.
URL obj = new URL("https://auvious.video:443/rtc-api/conferences/updateStreamMetadata");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream())
);
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post(
'https://auvious.video:443/rtc-api/conferences/updateStreamMetadata',
params={},
headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://auvious.video:443/rtc-api/conferences/updateStreamMetadata',
params: {}, headers: headers
p JSON.parse(result)
View request, when a user receives ConferenceStreamPublishedEvent, the next logical thing to is to view the stream, and to view a stream one needs to start with this request.
POST https://auvious.video:443/rtc-api/conferences/viewStream HTTP/1.1
Host: auvious.video:443
Content-Type: application/json
Accept: application/json
Request body
{
"conferenceId": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"sdpOffer": "string",
"streamId": {
"id": "string"
},
"userEndpointId": "string",
"viewerId": "string"
}
Parameters
Parameter | In | Type | Required | Description |
---|---|---|---|---|
body | body | ConferenceViewStreamWebCommand | false | none |
Responses
Overview
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | ConferenceStreamViewResult |
201 | Created | Created | None |
401 | Unauthorized | Unauthorized | None |
403 | Forbidden | Forbidden | None |
404 | Not Found | Not Found | None |
Examples
200 Response
{
"sdpAnswer": "string",
"viewerId": "string"
}
To perform this operation, you must be authenticated by means of one of the following methods: Client Credentials Flow ( Scopes: global ), Jwt ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global )
Code samples
- Shell
- Go
- Node
- Java
- Python
- Ruby
curl -X POST https://auvious.video:443/rtc-api/conferences/viewStream \
-H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {access-token}'
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
var body []byte
// body = ...
req, err := http.NewRequest("POST", "https://auvious.video:443/rtc-api/conferences/viewStream", bytes.NewBuffer(body))
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
const fetch = require('node-fetch');
const input = '{
"conferenceId": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"sdpOffer": "string",
"streamId": {
"id": "string"
},
"userEndpointId": "string",
"viewerId": "string"
}';
const headers = {
'Content-Type': 'application/json', 'Accept': 'application/json', 'Authorization': 'Bearer {access-token}'
}
fetch('https://auvious.video:443/rtc-api/conferences/viewStream', {
method: 'POST',
body: input,
headers
})
.then(r => r.json())
.then((body) => {
console.log(body)
})
// This sample needs improvement.
URL obj = new URL("https://auvious.video:443/rtc-api/conferences/viewStream");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream())
);
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post(
'https://auvious.video:443/rtc-api/conferences/viewStream',
params={},
headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://auvious.video:443/rtc-api/conferences/viewStream',
params: {}, headers: headers
p JSON.parse(result)
Get conference aggregate.
GET https://auvious.video:443/rtc-api/conferences/{id} HTTP/1.1
Host: auvious.video:443
Accept: application/json
Parameters
Parameter | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | id |
Responses
Overview
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | Conference |
401 | Unauthorized | Unauthorized | None |
403 | Forbidden | Forbidden | None |
404 | Not Found | Not Found | None |
Examples
200 Response
{
"creator": "string",
"creatorEndpoint": "string",
"empty": true,
"id": "string",
"metadata": {
"property1": {
"lastModified": "2019-08-24T14:15:22Z",
"userEndpointId": "string",
"userId": "string",
"value": "string"
},
"property2": {
"lastModified": "2019-08-24T14:15:22Z",
"userEndpointId": "string",
"userId": "string",
"value": "string"
}
},
"mode": "P2P",
"organizationId": "string",
"participants": [
{
"id": "string",
"metadata": {},
"state": "HEALTHY",
"streams": [
{
"id": {
"id": "string"
},
"metadata": {},
"type": "CAM",
"videoBitrate": 0
}
],
"userId": "string"
}
],
"version": 0
}
To perform this operation, you must be authenticated by means of one of the following methods: Client Credentials Flow ( Scopes: global ), Jwt ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global )
Code samples
- Shell
- Go
- Node
- Java
- Python
- Ruby
curl -X GET https://auvious.video:443/rtc-api/conferences/{id} \
-H 'Accept: application/json' \ -H 'Authorization: Bearer {access-token}'
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
var body []byte
// body = ...
req, err := http.NewRequest("GET", "https://auvious.video:443/rtc-api/conferences/{id}", bytes.NewBuffer(body))
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
const fetch = require('node-fetch');
const headers = {
'Accept': 'application/json', 'Authorization': 'Bearer {access-token}'
}
fetch('https://auvious.video:443/rtc-api/conferences/{id}', {
method: 'GET',
headers
})
.then(r => r.json())
.then((body) => {
console.log(body)
})
// This sample needs improvement.
URL obj = new URL("https://auvious.video:443/rtc-api/conferences/{id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream())
);
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get(
'https://auvious.video:443/rtc-api/conferences/{id}',
params={},
headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://auvious.video:443/rtc-api/conferences/{id}',
params: {}, headers: headers
p JSON.parse(result)
Get a list of all events of a conference, optionally since version v(query param). Blocks for a few seconds if no event is available at the time
GET https://auvious.video:443/rtc-api/conferences/{id}/events?v=0 HTTP/1.1
Host: auvious.video:443
Accept: application/json
Parameters
Parameter | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | id |
v | query | integer(int64) | true | v |
Responses
Overview
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | Inline |
401 | Unauthorized | Unauthorized | None |
403 | Forbidden | Forbidden | None |
404 | Not Found | Not Found | None |
Response Schema
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [ConferenceEvent] | false | none | none |
» ConferenceEvent | ConferenceEvent | false | none | none |
»» conferenceId | string | false | none | the conference which this event belongs to |
»» conferenceVersion | integer(int64) | false | none | the conference version this event was produced- can be used for ordering and or deduplication. It contains the version of the conference when the event was generated or null for creation events |
»» id | string | false | none | event id, unique per event |
»» organizationId | string | false | none | the organizationId |
»» timestamp | string(date-time) | false | none | timestamp |
»» type | string | false | none | type |
Examples
200 Response
[
{
"conferenceId": "string",
"conferenceVersion": 0,
"id": "string",
"organizationId": "string",
"timestamp": "2019-08-24T14:15:22Z",
"type": "string"
}
]
To perform this operation, you must be authenticated by means of one of the following methods: Client Credentials Flow ( Scopes: global ), Jwt ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global )
Code samples
- Shell
- Go
- Node
- Java
- Python
- Ruby
curl -X GET https://auvious.video:443/rtc-api/conferences/{id}/events?v=0 \
-H 'Accept: application/json' \ -H 'Authorization: Bearer {access-token}'
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
var body []byte
// body = ...
req, err := http.NewRequest("GET", "https://auvious.video:443/rtc-api/conferences/{id}/events", bytes.NewBuffer(body))
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
const fetch = require('node-fetch');
const headers = {
'Accept': 'application/json', 'Authorization': 'Bearer {access-token}'
}
fetch('https://auvious.video:443/rtc-api/conferences/{id}/events?v=0', {
method: 'GET',
headers
})
.then(r => r.json())
.then((body) => {
console.log(body)
})
// This sample needs improvement.
URL obj = new URL("https://auvious.video:443/rtc-api/conferences/{id}/events?v=0");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream())
);
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get(
'https://auvious.video:443/rtc-api/conferences/{id}/events',
params={
'v': '0'},
headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://auvious.video:443/rtc-api/conferences/{id}/events',
params: {
'v' => 'integer(int64)'}, headers: headers
p JSON.parse(result)
Get a simple view of a conference, similar to full details but more convenient for some ui clients
GET https://auvious.video:443/rtc-api/conferences/{id}/simpleView HTTP/1.1
Host: auvious.video:443
Accept: application/json
Parameters
Parameter | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | id |
Responses
Overview
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | ConferenceSimpleView |
401 | Unauthorized | Unauthorized | None |
403 | Forbidden | Forbidden | None |
404 | Not Found | Not Found | None |
Examples
200 Response
{
"id": "string",
"metadata": {
"property1": {
"lastModified": "2019-08-24T14:15:22Z",
"userEndpointId": "string",
"userId": "string",
"value": "string"
},
"property2": {
"lastModified": "2019-08-24T14:15:22Z",
"userEndpointId": "string",
"userId": "string",
"value": "string"
}
},
"mode": "string",
"participants": [
{
"endpoints": [
{
"id": "string",
"metadata": {},
"state": "HEALTHY",
"streams": [
{
"id": "string",
"metadata": {},
"type": "string"
}
]
}
],
"id": "string"
}
],
"version": 0
}
To perform this operation, you must be authenticated by means of one of the following methods: Client Credentials Flow ( Scopes: global ), Jwt ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global )
Code samples
- Shell
- Go
- Node
- Java
- Python
- Ruby
curl -X GET https://auvious.video:443/rtc-api/conferences/{id}/simpleView \
-H 'Accept: application/json' \ -H 'Authorization: Bearer {access-token}'
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
}
var body []byte
// body = ...
req, err := http.NewRequest("GET", "https://auvious.video:443/rtc-api/conferences/{id}/simpleView", bytes.NewBuffer(body))
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
const fetch = require('node-fetch');
const headers = {
'Accept': 'application/json', 'Authorization': 'Bearer {access-token}'
}
fetch('https://auvious.video:443/rtc-api/conferences/{id}/simpleView', {
method: 'GET',
headers
})
.then(r => r.json())
.then((body) => {
console.log(body)
})
// This sample needs improvement.
URL obj = new URL("https://auvious.video:443/rtc-api/conferences/{id}/simpleView");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream())
);
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get(
'https://auvious.video:443/rtc-api/conferences/{id}/simpleView',
params={},
headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get 'https://auvious.video:443/rtc-api/conferences/{id}/simpleView',
params: {}, headers: headers
p JSON.parse(result)
Schemas
Conference
{
"creator": "string",
"creatorEndpoint": "string",
"empty": true,
"id": "string",
"metadata": {
"property1": {
"lastModified": "2019-08-24T14:15:22Z",
"userEndpointId": "string",
"userId": "string",
"value": "string"
},
"property2": {
"lastModified": "2019-08-24T14:15:22Z",
"userEndpointId": "string",
"userId": "string",
"value": "string"
}
},
"mode": "P2P",
"organizationId": "string",
"participants": [
{
"id": "string",
"metadata": {},
"state": "HEALTHY",
"streams": [
{
"id": {
"id": "string"
},
"metadata": {},
"type": "CAM",
"videoBitrate": 0
}
],
"userId": "string"
}
],
"version": 0
}
Conference
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
creator | string | false | none | none |
creatorEndpoint | string | false | none | none |
empty | boolean | false | none | none |
id | string | false | none | none |
metadata | object | false | none | none |
» additionalProperties | Metadata | false | none | none |
mode | string | false | none | none |
organizationId | string | false | none | none |
participants | [ConferenceParticipant] | false | none | none |
version | integer(int64) | false | none | none |
Enumerated Values
Property | Value |
---|---|
mode | P2P |
mode | ROUTER |
mode | UNKNOWN |
ConferenceEvent
{
"conferenceId": "string",
"conferenceVersion": 0,
"id": "string",
"organizationId": "string",
"timestamp": "2019-08-24T14:15:22Z",
"type": "string"
}
ConferenceEvent
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
conferenceId | string | false | none | the conference which this event belongs to |
conferenceVersion | integer(int64) | false | none | the conference version this event was produced- can be used for ordering and or deduplication. It contains the version of the conference when the event was generated or null for creation events |
id | string | false | none | event id, unique per event |
organizationId | string | false | none | the organizationId |
timestamp | string(date-time) | false | none | timestamp |
type | string | false | none | type |
ConferenceParticipant
{
"id": "string",
"metadata": {},
"state": "HEALTHY",
"streams": [
{
"id": {
"id": "string"
},
"metadata": {},
"type": "CAM",
"videoBitrate": 0
}
],
"userId": "string"
}
ConferenceParticipant
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | string | false | none | none |
metadata | object | false | none | none |
state | string | false | none | none |
streams | [ConferenceStream] | false | none | none |
userId | string | false | none | none |
Enumerated Values
Property | Value |
---|---|
state | HEALTHY |
state | SICK |
state | UNKNOWN |
ConferencePublishResult
{
"sdpAnswer": "string",
"streamId": {
"id": "string"
}
}
ConferencePublishResult
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
sdpAnswer | string | false | none | none |
streamId | StreamId | false | none | none |
ConferencePublishStreamIceCandidatesWebCommand
{
"conferenceId": "string",
"iceCandidates": [
{
"candidate": "string",
"sdpMLineIndex": 0,
"sdpMid": "string"
}
],
"streamId": {
"id": "string"
},
"userEndpointId": "string"
}
ConferencePublishStreamIceCandidatesWebCommand
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
conferenceId | string | false | none | Supply the conferenceId. Mandatory. |
iceCandidates | [IceCandidate] | false | none | Supply the ice candidates found so far. Mandatory. |
streamId | StreamId | false | none | Supply the published stream id. Mandatory. |
userEndpointId | string | false | none | Supply the user endpoint id. Mandatory. |
ConferencePublishStreamWebCommand
{
"conferenceId": "string",
"conferenceStreamType": "CAM",
"metadata": {},
"sdpOffer": "string",
"streamId": {
"id": "string"
},
"userEndpointId": "string",
"videoBitrate": 0
}
ConferencePublishStreamWebCommand
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
conferenceId | string | false | none | Supply the conferenceId. Mandatory. |
conferenceStreamType | string | false | none | Supply the stream type. One of MIC, CAM, SCREEN or MIC_AND_CAM. Mandatory. |
metadata | object | false | none | Stream metadata. Optional |
sdpOffer | string | false | none | Supply the sdpOffer. Mandatory. |
streamId | StreamId | false | none | Supply the streamId. Optional. |
userEndpointId | string | false | none | Supply the user endpoint id. Mandatory. |
videoBitrate | integer(int32) | false | none | Stream video bitrate. Optional |
Enumerated Values
Property | Value |
---|---|
conferenceStreamType | CAM |
conferenceStreamType | MIC |
conferenceStreamType | MIC_AND_CAM |
conferenceStreamType | SCREEN |
conferenceStreamType | UNKNOWN |
ConferenceSimpleView
{
"id": "string",
"metadata": {
"property1": {
"lastModified": "2019-08-24T14:15:22Z",
"userEndpointId": "string",
"userId": "string",
"value": "string"
},
"property2": {
"lastModified": "2019-08-24T14:15:22Z",
"userEndpointId": "string",
"userId": "string",
"value": "string"
}
},
"mode": "string",
"participants": [
{
"endpoints": [
{
"id": "string",
"metadata": {},
"state": "HEALTHY",
"streams": [
{
"id": "string",
"metadata": {},
"type": "string"
}
]
}
],
"id": "string"
}
],
"version": 0
}
ConferenceSimpleView
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | string | false | none | none |
metadata | object | false | none | none |
» additionalProperties | Metadata | false | none | none |
mode | string | false | none | none |
participants | [ConferenceSimpleViewParticipant] | false | none | none |
version | integer(int64) | false | none | none |
ConferenceSimpleViewParticipant
{
"endpoints": [
{
"id": "string",
"metadata": {},
"state": "HEALTHY",
"streams": [
{
"id": "string",
"metadata": {},
"type": "string"
}
]
}
],
"id": "string"
}
ConferenceSimpleViewParticipant
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
endpoints | [ConferenceSimpleViewParticipantEndpoint] | false | none | none |
id | string | false | none | none |
ConferenceSimpleViewParticipantEndpoint
{
"id": "string",
"metadata": {},
"state": "HEALTHY",
"streams": [
{
"id": "string",
"metadata": {},
"type": "string"
}
]
}
ConferenceSimpleViewParticipantEndpoint
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | string | false | none | none |
metadata | object | false | none | none |
state | string | false | none | none |
streams | [ConferenceSimpleViewParticipantEndpointStream] | false | none | none |
Enumerated Values
Property | Value |
---|---|
state | HEALTHY |
state | SICK |
state | UNKNOWN |
ConferenceSimpleViewParticipantEndpointStream
{
"id": "string",
"metadata": {},
"type": "string"
}
ConferenceSimpleViewParticipantEndpointStream
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | string | false | none | none |
metadata | object | false | none | none |
type | string | false | none | none |
ConferenceStopViewStreamWebCommand
{
"conferenceId": "string",
"streamId": {
"id": "string"
},
"userEndpointId": "string",
"viewerId": "string"
}
ConferenceStopViewStreamWebCommand
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
conferenceId | string | false | none | Supply the conferenceId. Mandatory. |
streamId | StreamId | false | none | Supply the stream id. Mandatory. |
userEndpointId | string | false | none | Supply the user endpoint id. Mandatory. |
viewerId | string | false | none | Supply the viewer id. Mandatory. |
ConferenceStream
{
"id": {
"id": "string"
},
"metadata": {},
"type": "CAM",
"videoBitrate": 0
}
ConferenceStream
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | StreamId | false | none | none |
metadata | object | false | none | none |
type | string | false | none | none |
videoBitrate | integer(int32) | false | none | none |
Enumerated Values
Property | Value |
---|---|
type | CAM |
type | MIC |
type | MIC_AND_CAM |
type | SCREEN |
type | UNKNOWN |
ConferenceStreamViewResult
{
"sdpAnswer": "string",
"viewerId": "string"
}
ConferenceStreamViewResult
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
sdpAnswer | string | false | none | none |
viewerId | string | false | none | none |
ConferenceSummary
{
"id": "string",
"mode": "P2P",
"version": 0
}
ConferenceSummary
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | string | false | none | none |
mode | string | false | none | none |
version | integer(int64) | false | none | none |
Enumerated Values
Property | Value |
---|---|
mode | P2P |
mode | ROUTER |
mode | UNKNOWN |
ConferenceUnpublishStreamWebCommand
{
"conferenceId": "string",
"streamId": {
"id": "string"
},
"userEndpointId": "string"
}
ConferenceUnpublishStreamWebCommand
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
conferenceId | string | false | none | Supply the conferenceId. Mandatory. |
streamId | StreamId | false | none | Supply the stream id to unpublish. Mandatory. |
userEndpointId | string | false | none | Supply the user endpoint id. Mandatory. |
ConferenceUpdatePublishedStreamBitrateWebCommand
{
"conferenceId": "string",
"streamId": {
"id": "string"
},
"userEndpointId": "string",
"videoBitrate": 0
}
ConferenceUpdatePublishedStreamBitrateWebCommand
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
conferenceId | string | false | none | Supply the conferenceId. Mandatory. |
streamId | StreamId | false | none | Supply the streamId. Optional. |
userEndpointId | string | false | none | Supply the user endpoint id. Mandatory. |
videoBitrate | integer(int32) | false | none | Stream video bitrate. Optional |
ConferenceViewStreamIceCandidatesWebCommand
{
"conferenceId": "string",
"iceCandidates": [
{
"candidate": "string",
"sdpMLineIndex": 0,
"sdpMid": "string"
}
],
"streamId": {
"id": "string"
},
"userEndpointId": "string",
"viewerId": "string"
}
ConferenceViewStreamIceCandidatesWebCommand
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
conferenceId | string | false | none | Supply the conferenceId. Mandatory. |
iceCandidates | [IceCandidate] | false | none | Supply the ice candidates found so far. Mandatory. |
streamId | StreamId | false | none | Supply the viewing stream id. Mandatory. |
userEndpointId | string | false | none | Supply the user endpoint id. Mandatory. |
viewerId | string | false | none | Supply the viewer id. Mandatory. |
ConferenceViewStreamWebCommand
{
"conferenceId": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"sdpOffer": "string",
"streamId": {
"id": "string"
},
"userEndpointId": "string",
"viewerId": "string"
}
ConferenceViewStreamWebCommand
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
conferenceId | string | false | none | Supply the conferenceId. Mandatory. |
metadata | object | false | none | Stream metadata. Optional. |
» additionalProperties | string | false | none | none |
sdpOffer | string | false | none | Supply the sdp offer. Mandatory. |
streamId | StreamId | false | none | Supply the stream id to view. Mandatory. |
userEndpointId | string | false | none | Supply the user endpoint id of the viewer. Mandatory. |
viewerId | string | false | none | Supply the viewerId. Optional. |
CreateConferenceWebCommand
{
"conferenceId": "string",
"creatorEndpoint": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"mode": "P2P",
"organizationId": "string"
}
CreateConferenceWebCommand
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
conferenceId | string | false | none | Supply the conferenceId. Take care so this value is unique, otherwise better leave this empty and let the server produce one. Optional. |
creatorEndpoint | string | false | none | Supply the creator user endpoint id. Optional. |
metadata | object | false | none | Supply conference metadata. Optional. |
» additionalProperties | string | false | none | none |
mode | string | false | none | Supply the conference mode. Currently only ROUTER is supported. Optional. |
organizationId | string | false | none | organization id, for internal use only |
Enumerated Values
Property | Value |
---|---|
mode | P2P |
mode | ROUTER |
mode | UNKNOWN |
EndConferenceWebCommand
{
"conferenceId": "string",
"reason": "string",
"userEndpointId": "string"
}
EndConferenceWebCommand
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
conferenceId | string | false | none | Supply the conferenceId. Mandatory. |
reason | string | false | none | Supply a reason for leaving. Optional. |
userEndpointId | string | false | none | Supply the user endpoint id. Mandatory. |
IceCandidate
{
"candidate": "string",
"sdpMLineIndex": 0,
"sdpMid": "string"
}
IceCandidate
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
candidate | string | false | none | none |
sdpMLineIndex | integer(int32) | false | none | none |
sdpMid | string | false | none | none |
Iterable«ConferenceSummary»
{}
Iterable«ConferenceSummary»
Properties
None
JoinConferenceWebCommand
{
"conferenceId": "string",
"metadata": {},
"userEndpointId": "string"
}
JoinConferenceWebCommand
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
conferenceId | string | false | none | Supply the conferenceId to join. Mandatory. |
metadata | object | false | none | Supply the metadata of the user. |
userEndpointId | string | false | none | Supply the userEndpointId of the user that wants to join. Mandatory. |
LeaveConferenceWebCommand
{
"conferenceId": "string",
"reason": "string",
"userEndpointId": "string"
}
LeaveConferenceWebCommand
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
conferenceId | string | false | none | Supply the conferenceId. Mandatory. |
reason | string | false | none | Supply a reason for leaving. Optional. |
userEndpointId | string | false | none | Supply the user endpoint id. Mandatory. |
Metadata
{
"lastModified": "2019-08-24T14:15:22Z",
"userEndpointId": "string",
"userId": "string",
"value": "string"
}
Metadata
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
lastModified | string(date-time) | false | none | none |
userEndpointId | string | false | none | none |
userId | string | false | none | none |
value | string | false | none | none |
SendEventResponse
{
"eventsSent": 0
}
SendEventResponse
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
eventsSent | integer(int32) | false | none | none |
SendEventToConferenceWebCommand
{
"conferenceId": "string",
"event": {},
"masks": [
"string"
],
"qos": "AT_LEAST_ONCE"
}
SendEventToConferenceWebCommand
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
conferenceId | string | true | none | conference id the members of which will receive the message |
event | object | true | none | event attributes, at least type and timestamp must be supplied with correct format. Format for type should begin with capital, end with Event, and use came case of at least a noun and a verb denoting what happened on what. Format for timestamp is ISO-8601 instant format e.g. '2011-12-03T10:15:30Z |
masks | [string] | false | none | masks to apply, each item denotes a json path (https://github.com/json-path/JsonPath) syntax which will be applied on the event when stored or logged. By default no masks are applied. The masked fields must be of type string, and it will be replaced by a string of same length but with strings. |
qos | string | true | none | define qos(optional), default is best effort |
Enumerated Values
Property | Value |
---|---|
qos | AT_LEAST_ONCE |
qos | BEST_EFFORT |
StreamId
{
"id": "string"
}
StreamId
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | string | false | none | none |
UpdateConferenceMetadataWebCommand
{
"conferenceId": "string",
"key": "string",
"operation": "REMOVE",
"userEndpointId": "string",
"value": "string"
}
UpdateConferenceMetadataWebCommand
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
conferenceId | string | false | none | Supply the conferenceId. Mandatory. |
key | string | false | none | Supply the key. Mandatory |
operation | string | false | none | Supply the operation, SET or REMOVE. Mandatory. |
userEndpointId | string | false | none | Supply the user endpoint id. Mandatory. |
value | string | false | none | Supply the value, if the operation is SET. Ignored if operation is REMOVE |
Enumerated Values
Property | Value |
---|---|
operation | REMOVE |
operation | SET |
operation | UNKNOWN |
UpdateConferenceParticipantMetadataWebCommand
{
"conferenceId": "string",
"newMetadata": {},
"userEndpointId": "string"
}
UpdateConferenceParticipantMetadataWebCommand
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
conferenceId | string | false | none | Supply the conferenceId. Mandatory. |
newMetadata | object | false | none | Supply the metadata of the user. |
userEndpointId | string | false | none | Supply the user endpoint id. Mandatory. |
UpdateConferenceStreamMetadataWebCommand
{
"conferenceId": "string",
"newMetadata": {},
"streamId": {
"id": "string"
},
"userEndpointId": "string"
}
UpdateConferenceStreamMetadataWebCommand
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
conferenceId | string | false | none | Supply the conferenceId. Mandatory. |
newMetadata | object | false | none | Supply the metadata of the stream. |
streamId | StreamId | false | none | Supply the streamId. Optional. |
userEndpointId | string | false | none | Supply the user endpoint id. Mandatory. |