Auvious RTC API v1.9.26

Auvious RTC API is the core set of services providing the realtime communication capabilities of the Auvious Platform.

info

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

• HTTP Authentication, scheme: bearer
• OAuth 2.0 Authorization.

  • Flow: clientCredentials

  • OAuth 2.0 Token URL = /security/oauth/token

  • OAuth 2.0 Scope

    Scope	Scope Description

Conferences

Adds pre-authorized participant user IDs to a conference. Requires ROLE_SERVICE or a principal from the same organization as the target conference.

PUT https://auvious.video/rtc-api/conferences/{id}/allowed-participants HTTP/1.1
Host: auvious.video
Content-Type: application/json
Accept: */*

Request body

{
  "userEndpointId": "string",
  "participants": [
    "string"
  ]
}

Parameters

Parameter	In	Type	Required	Description
id	path	string	true	none
body	body	AddAllowedParticipantsWebCommand	true	none

Responses

Overview

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Inline
403	Forbidden	Authenticated principal cannot mutate this conference	None
404	Not Found	Conference not found	None

Response Schema

Status Code 400

Name	Type	Required	Restrictions	Description
» additionalProperties	string	false	none	none

Examples

400 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

Shell

curl -X PUT https://auvious.video/rtc-api/conferences/{id}/allowed-participants \
  -H 'Content-Type: application/json' \  -H 'Accept: */*' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("PUT", "https://auvious.video/rtc-api/conferences/{id}/allowed-participants", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');
const input = '{
  "userEndpointId": "string",
  "participants": [
    "string"
  ]
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': '*/*',  'Authorization': 'Bearer {access-token}'
}

fetch('https://auvious.video/rtc-api/conferences/{id}/allowed-participants', {
  method: 'PUT',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("https://auvious.video/rtc-api/conferences/{id}/allowed-participants");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");

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());

Python

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put(
  'https://auvious.video/rtc-api/conferences/{id}/allowed-participants',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put 'https://auvious.video/rtc-api/conferences/{id}/allowed-participants',
  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/rtc-api/conferences/viewStream HTTP/1.1
Host: auvious.video
Content-Type: application/json
Accept: application/json

Request body

{
  "conferenceId": "string",
  "userEndpointId": "string",
  "streamId": "string",
  "sdpOffer": "string",
  "viewerId": "string",
  "metadata": {
    "property1": "string",
    "property2": "string"
  }
}

Parameters

Parameter	In	Type	Required	Description
body	body	ConferenceViewStreamWebCommand	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	ConferenceStreamViewResult
400	Bad Request	Bad Request	Inline

Response Schema

Status Code 400

Name	Type	Required	Restrictions	Description
» additionalProperties	string	false	none	none

Examples

200 Response

{
  "viewerId": "string",
  "sdpAnswer": "string"
}

400 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

Shell

curl -X POST https://auvious.video/rtc-api/conferences/viewStream \
  -H 'Content-Type: application/json' \  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

Go

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/rtc-api/conferences/viewStream", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');
const input = '{
  "conferenceId": "string",
  "userEndpointId": "string",
  "streamId": "string",
  "sdpOffer": "string",
  "viewerId": "string",
  "metadata": {
    "property1": "string",
    "property2": "string"
  }
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('https://auvious.video/rtc-api/conferences/viewStream', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("https://auvious.video/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());

Python

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'https://auvious.video/rtc-api/conferences/viewStream',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://auvious.video/rtc-api/conferences/viewStream',
  params: {}, headers: headers

p JSON.parse(result)

Updates conference stream metadata

POST https://auvious.video/rtc-api/conferences/updateStreamMetadata HTTP/1.1
Host: auvious.video
Content-Type: application/json
Accept: */*

Request body

{
  "conferenceId": "string",
  "userEndpointId": "string",
  "streamId": "string",
  "newMetadata": {
    "property1": {},
    "property2": {}
  }
}

Parameters

Parameter	In	Type	Required	Description
body	body	UpdateConferenceStreamMetadataWebCommand	true	none

Responses

Overview

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Inline

Response Schema

Status Code 400

Name	Type	Required	Restrictions	Description
» additionalProperties	string	false	none	none

Examples

400 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

Shell

curl -X POST https://auvious.video/rtc-api/conferences/updateStreamMetadata \
  -H 'Content-Type: application/json' \  -H 'Accept: */*' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "https://auvious.video/rtc-api/conferences/updateStreamMetadata", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');
const input = '{
  "conferenceId": "string",
  "userEndpointId": "string",
  "streamId": "string",
  "newMetadata": {
    "property1": {},
    "property2": {}
  }
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': '*/*',  'Authorization': 'Bearer {access-token}'
}

fetch('https://auvious.video/rtc-api/conferences/updateStreamMetadata', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("https://auvious.video/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());

Python

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'https://auvious.video/rtc-api/conferences/updateStreamMetadata',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://auvious.video/rtc-api/conferences/updateStreamMetadata',
  params: {}, headers: headers

p JSON.parse(result)

Update the bitrate of a conference stream.

POST https://auvious.video/rtc-api/conferences/updatePublishedStreamBitrate HTTP/1.1
Host: auvious.video
Content-Type: application/json
Accept: */*

Request body

{
  "conferenceId": "string",
  "userEndpointId": "string",
  "streamId": "string",
  "videoBitrate": 30000
}

Parameters

Parameter	In	Type	Required	Description
body	body	ConferenceUpdatePublishedStreamBitrateWebCommand	true	none

Responses

Overview

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Inline
404	Not Found	Not Found	None

Response Schema

Status Code 400

Name	Type	Required	Restrictions	Description
» additionalProperties	string	false	none	none

Examples

400 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

Shell

curl -X POST https://auvious.video/rtc-api/conferences/updatePublishedStreamBitrate \
  -H 'Content-Type: application/json' \  -H 'Accept: */*' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "https://auvious.video/rtc-api/conferences/updatePublishedStreamBitrate", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');
const input = '{
  "conferenceId": "string",
  "userEndpointId": "string",
  "streamId": "string",
  "videoBitrate": 30000
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': '*/*',  'Authorization': 'Bearer {access-token}'
}

fetch('https://auvious.video/rtc-api/conferences/updatePublishedStreamBitrate', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("https://auvious.video/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());

Python

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'https://auvious.video/rtc-api/conferences/updatePublishedStreamBitrate',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://auvious.video/rtc-api/conferences/updatePublishedStreamBitrate',
  params: {}, headers: headers

p JSON.parse(result)

Updates conference participant metadata

POST https://auvious.video/rtc-api/conferences/updateParticipantMetadata HTTP/1.1
Host: auvious.video
Content-Type: application/json
Accept: */*

Request body

{
  "conferenceId": "string",
  "userEndpointId": "string",
  "newMetadata": {
    "property1": {},
    "property2": {}
  }
}

Parameters

Parameter	In	Type	Required	Description
body	body	UpdateConferenceParticipantMetadataWebCommand	true	none

Responses

Overview

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Inline

Response Schema

Status Code 400

Name	Type	Required	Restrictions	Description
» additionalProperties	string	false	none	none

Examples

400 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

Shell

curl -X POST https://auvious.video/rtc-api/conferences/updateParticipantMetadata \
  -H 'Content-Type: application/json' \  -H 'Accept: */*' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "https://auvious.video/rtc-api/conferences/updateParticipantMetadata", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');
const input = '{
  "conferenceId": "string",
  "userEndpointId": "string",
  "newMetadata": {
    "property1": {},
    "property2": {}
  }
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': '*/*',  'Authorization': 'Bearer {access-token}'
}

fetch('https://auvious.video/rtc-api/conferences/updateParticipantMetadata', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("https://auvious.video/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());

Python

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'https://auvious.video/rtc-api/conferences/updateParticipantMetadata',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://auvious.video/rtc-api/conferences/updateParticipantMetadata',
  params: {}, headers: headers

p JSON.parse(result)

Updates conference metadata

POST https://auvious.video/rtc-api/conferences/updateMetadata HTTP/1.1
Host: auvious.video
Content-Type: application/json
Accept: */*

Request body

{
  "conferenceId": "string",
  "userEndpointId": "string",
  "operation": "SET",
  "key": "string",
  "value": "string"
}

Parameters

Parameter	In	Type	Required	Description
body	body	UpdateConferenceMetadataWebCommand	true	none

Responses

Overview

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Inline

Response Schema

Status Code 400

Name	Type	Required	Restrictions	Description
» additionalProperties	string	false	none	none

Examples

400 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

Shell

curl -X POST https://auvious.video/rtc-api/conferences/updateMetadata \
  -H 'Content-Type: application/json' \  -H 'Accept: */*' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "https://auvious.video/rtc-api/conferences/updateMetadata", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');
const input = '{
  "conferenceId": "string",
  "userEndpointId": "string",
  "operation": "SET",
  "key": "string",
  "value": "string"
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': '*/*',  'Authorization': 'Bearer {access-token}'
}

fetch('https://auvious.video/rtc-api/conferences/updateMetadata', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("https://auvious.video/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());

Python

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'https://auvious.video/rtc-api/conferences/updateMetadata',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://auvious.video/rtc-api/conferences/updateMetadata',
  params: {}, headers: headers

p JSON.parse(result)

Unpublish a stream from the conference.

POST https://auvious.video/rtc-api/conferences/unpublishStream HTTP/1.1
Host: auvious.video
Content-Type: application/json
Accept: */*

Request body

{
  "conferenceId": "string",
  "userEndpointId": "string",
  "streamId": "string"
}

Parameters

Parameter	In	Type	Required	Description
body	body	ConferenceUnpublishStreamWebCommand	true	none

Responses

Overview

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Inline

Response Schema

Status Code 400

Name	Type	Required	Restrictions	Description
» additionalProperties	string	false	none	none

Examples

400 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

Shell

curl -X POST https://auvious.video/rtc-api/conferences/unpublishStream \
  -H 'Content-Type: application/json' \  -H 'Accept: */*' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "https://auvious.video/rtc-api/conferences/unpublishStream", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');
const input = '{
  "conferenceId": "string",
  "userEndpointId": "string",
  "streamId": "string"
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': '*/*',  'Authorization': 'Bearer {access-token}'
}

fetch('https://auvious.video/rtc-api/conferences/unpublishStream', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("https://auvious.video/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());

Python

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'https://auvious.video/rtc-api/conferences/unpublishStream',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://auvious.video/rtc-api/conferences/unpublishStream',
  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/rtc-api/conferences/stopViewStream HTTP/1.1
Host: auvious.video
Content-Type: application/json
Accept: */*

Request body

{
  "conferenceId": "string",
  "userEndpointId": "string",
  "streamId": "string",
  "viewerId": "string"
}

Parameters

Parameter	In	Type	Required	Description
body	body	ConferenceStopViewStreamWebCommand	true	none

Responses

Overview

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Inline

Response Schema

Status Code 400

Name	Type	Required	Restrictions	Description
» additionalProperties	string	false	none	none

Examples

400 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

Shell

curl -X POST https://auvious.video/rtc-api/conferences/stopViewStream \
  -H 'Content-Type: application/json' \  -H 'Accept: */*' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "https://auvious.video/rtc-api/conferences/stopViewStream", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');
const input = '{
  "conferenceId": "string",
  "userEndpointId": "string",
  "streamId": "string",
  "viewerId": "string"
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': '*/*',  'Authorization': 'Bearer {access-token}'
}

fetch('https://auvious.video/rtc-api/conferences/stopViewStream', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("https://auvious.video/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());

Python

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'https://auvious.video/rtc-api/conferences/stopViewStream',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://auvious.video/rtc-api/conferences/stopViewStream',
  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/rtc-api/conferences/sendEvent HTTP/1.1
Host: auvious.video
Content-Type: application/json
Accept: */*

Returns number of messages sent. Only users with 'SERVICE' role allowed

Request body

{
  "conferenceId": "string",
  "qos": "BEST_EFFORT",
  "event": {
    "property1": {},
    "property2": {}
  },
  "masks": [
    "string"
  ]
}

Parameters

Parameter	In	Type	Required	Description
body	body	SendEventToConferenceWebCommand	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	SendEventResponse
400	Bad Request	Bad Request	Inline

Response Schema

Status Code 400

Name	Type	Required	Restrictions	Description
» additionalProperties	string	false	none	none

Examples

200 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

Shell

curl -X POST https://auvious.video/rtc-api/conferences/sendEvent \
  -H 'Content-Type: application/json' \  -H 'Accept: */*' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "https://auvious.video/rtc-api/conferences/sendEvent", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');
const input = '{
  "conferenceId": "string",
  "qos": "BEST_EFFORT",
  "event": {
    "property1": {},
    "property2": {}
  },
  "masks": [
    "string"
  ]
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': '*/*',  'Authorization': 'Bearer {access-token}'
}

fetch('https://auvious.video/rtc-api/conferences/sendEvent', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("https://auvious.video/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());

Python

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'https://auvious.video/rtc-api/conferences/sendEvent',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://auvious.video/rtc-api/conferences/sendEvent',
  params: {}, headers: headers

p JSON.parse(result)

Publish a stream to the conference.

POST https://auvious.video/rtc-api/conferences/publishStream HTTP/1.1
Host: auvious.video
Content-Type: application/json
Accept: application/json

Request body

{
  "conferenceId": "string",
  "userEndpointId": "string",
  "streamId": "string",
  "conferenceStreamType": "MIC",
  "sdpOffer": "string",
  "metadata": {
    "property1": {},
    "property2": {}
  },
  "videoBitrate": 30000
}

Parameters

Parameter	In	Type	Required	Description
body	body	ConferencePublishStreamWebCommand	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	ConferencePublishResult
400	Bad Request	Bad Request	Inline

Response Schema

Status Code 400

Name	Type	Required	Restrictions	Description
» additionalProperties	string	false	none	none

Examples

200 Response

{
  "streamId": "string",
  "sdpAnswer": "string"
}

400 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

Shell

curl -X POST https://auvious.video/rtc-api/conferences/publishStream \
  -H 'Content-Type: application/json' \  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

Go

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/rtc-api/conferences/publishStream", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');
const input = '{
  "conferenceId": "string",
  "userEndpointId": "string",
  "streamId": "string",
  "conferenceStreamType": "MIC",
  "sdpOffer": "string",
  "metadata": {
    "property1": {},
    "property2": {}
  },
  "videoBitrate": 30000
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('https://auvious.video/rtc-api/conferences/publishStream', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("https://auvious.video/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());

Python

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'https://auvious.video/rtc-api/conferences/publishStream',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://auvious.video/rtc-api/conferences/publishStream',
  params: {}, headers: headers

p JSON.parse(result)

Leaves a conference.

POST https://auvious.video/rtc-api/conferences/leave HTTP/1.1
Host: auvious.video
Content-Type: application/json
Accept: */*

Request body

{
  "conferenceId": "string",
  "userEndpointId": "string",
  "reason": "string"
}

Parameters

Parameter	In	Type	Required	Description
body	body	LeaveConferenceWebCommand	true	none

Responses

Overview

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Inline

Response Schema

Status Code 400

Name	Type	Required	Restrictions	Description
» additionalProperties	string	false	none	none

Examples

400 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

Shell

curl -X POST https://auvious.video/rtc-api/conferences/leave \
  -H 'Content-Type: application/json' \  -H 'Accept: */*' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "https://auvious.video/rtc-api/conferences/leave", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');
const input = '{
  "conferenceId": "string",
  "userEndpointId": "string",
  "reason": "string"
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': '*/*',  'Authorization': 'Bearer {access-token}'
}

fetch('https://auvious.video/rtc-api/conferences/leave', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("https://auvious.video/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());

Python

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'https://auvious.video/rtc-api/conferences/leave',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://auvious.video/rtc-api/conferences/leave',
  params: {}, headers: headers

p JSON.parse(result)

Joins a conference

POST https://auvious.video/rtc-api/conferences/join HTTP/1.1
Host: auvious.video
Content-Type: application/json
Accept: application/json

Request body

{
  "conferenceId": "string",
  "userEndpointId": "string",
  "metadata": {
    "property1": {},
    "property2": {}
  }
}

Parameters

Parameter	In	Type	Required	Description
body	body	JoinConferenceWebCommand	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	ConferenceSummary
400	Bad Request	Bad Request	AnotherErrorResponse
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline
422	Unprocessable Entity	Conference Already Joined from same user and endpoint	Inline

Response Schema

Examples

200 Response

{
  "id": "string",
  "version": 0,
  "mode": "P2P"
}

caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

Shell

curl -X POST https://auvious.video/rtc-api/conferences/join \
  -H 'Content-Type: application/json' \  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

Go

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/rtc-api/conferences/join", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');
const input = '{
  "conferenceId": "string",
  "userEndpointId": "string",
  "metadata": {
    "property1": {},
    "property2": {}
  }
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('https://auvious.video/rtc-api/conferences/join', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("https://auvious.video/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());

Python

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'https://auvious.video/rtc-api/conferences/join',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://auvious.video/rtc-api/conferences/join',
  params: {}, headers: headers

p JSON.parse(result)

Sets the interaction id which this conference is related to.

POST https://auvious.video/rtc-api/conferences/interaction HTTP/1.1
Host: auvious.video
Content-Type: application/json
Accept: */*

Request body

{
  "conferenceId": "string",
  "interactionId": "string",
  "userEndpointId": "string"
}

Parameters

Parameter	In	Type	Required	Description
body	body	SetInteractionIdWebCommand	true	none

Responses

Overview

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Inline

Response Schema

Status Code 400

Name	Type	Required	Restrictions	Description
» additionalProperties	string	false	none	none

Examples

400 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

Shell

curl -X POST https://auvious.video/rtc-api/conferences/interaction \
  -H 'Content-Type: application/json' \  -H 'Accept: */*' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "https://auvious.video/rtc-api/conferences/interaction", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');
const input = '{
  "conferenceId": "string",
  "interactionId": "string",
  "userEndpointId": "string"
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': '*/*',  'Authorization': 'Bearer {access-token}'
}

fetch('https://auvious.video/rtc-api/conferences/interaction', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("https://auvious.video/rtc-api/conferences/interaction");

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());

Python

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'https://auvious.video/rtc-api/conferences/interaction',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://auvious.video/rtc-api/conferences/interaction',
  params: {}, headers: headers

p JSON.parse(result)

Ends a conference.

POST https://auvious.video/rtc-api/conferences/end HTTP/1.1
Host: auvious.video
Content-Type: application/json
Accept: */*

Request body

{
  "conferenceId": "string",
  "userEndpointId": "string",
  "reason": "string"
}

Parameters

Parameter	In	Type	Required	Description
body	body	EndConferenceWebCommand	true	none

Responses

Overview

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Inline

Response Schema

Status Code 400

Name	Type	Required	Restrictions	Description
» additionalProperties	string	false	none	none

Examples

400 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

Shell

curl -X POST https://auvious.video/rtc-api/conferences/end \
  -H 'Content-Type: application/json' \  -H 'Accept: */*' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "https://auvious.video/rtc-api/conferences/end", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');
const input = '{
  "conferenceId": "string",
  "userEndpointId": "string",
  "reason": "string"
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': '*/*',  'Authorization': 'Bearer {access-token}'
}

fetch('https://auvious.video/rtc-api/conferences/end', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("https://auvious.video/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());

Python

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'https://auvious.video/rtc-api/conferences/end',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://auvious.video/rtc-api/conferences/end',
  params: {}, headers: headers

p JSON.parse(result)

Creates a conference.

POST https://auvious.video/rtc-api/conferences/create HTTP/1.1
Host: auvious.video
Content-Type: application/json
Accept: application/json

Request body

{
  "conferenceId": "string",
  "mode": "P2P",
  "organizationId": "string",
  "creatorEndpoint": "string",
  "interactionId": "string",
  "metadata": {
    "property1": "string",
    "property2": "string"
  },
  "allowedParticipants": [
    "string"
  ],
  "securityScheme": "CUSTOMER_ALLOWLIST_OR_TICKET"
}

Parameters

Parameter	In	Type	Required	Description
body	body	CreateConferenceWebCommand	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	ConferenceSummary
400	Bad Request	Bad Request	Inline

Response Schema

Status Code 400

Name	Type	Required	Restrictions	Description
» additionalProperties	string	false	none	none

Examples

200 Response

{
  "id": "string",
  "version": 0,
  "mode": "P2P"
}

400 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

Shell

curl -X POST https://auvious.video/rtc-api/conferences/create \
  -H 'Content-Type: application/json' \  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

Go

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/rtc-api/conferences/create", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');
const input = '{
  "conferenceId": "string",
  "mode": "P2P",
  "organizationId": "string",
  "creatorEndpoint": "string",
  "interactionId": "string",
  "metadata": {
    "property1": "string",
    "property2": "string"
  },
  "allowedParticipants": [
    "string"
  ],
  "securityScheme": "CUSTOMER_ALLOWLIST_OR_TICKET"
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('https://auvious.video/rtc-api/conferences/create', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("https://auvious.video/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());

Python

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'https://auvious.video/rtc-api/conferences/create',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://auvious.video/rtc-api/conferences/create',
  params: {}, headers: headers

p JSON.parse(result)

Adds ice candidates for a view stream request.

POST https://auvious.video/rtc-api/conferences/addViewStreamIceCandidates HTTP/1.1
Host: auvious.video
Content-Type: application/json
Accept: */*

Request body

{
  "conferenceId": "string",
  "userEndpointId": "string",
  "streamId": "string",
  "viewerId": "string",
  "iceCandidates": [
    {
      "candidate": "string",
      "sdpMid": "string",
      "sdpMLineIndex": 0
    }
  ]
}

Parameters

Parameter	In	Type	Required	Description
body	body	ConferenceViewStreamIceCandidatesWebCommand	true	none

Responses

Overview

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Inline

Response Schema

Status Code 400

Name	Type	Required	Restrictions	Description
» additionalProperties	string	false	none	none

Examples

400 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

Shell

curl -X POST https://auvious.video/rtc-api/conferences/addViewStreamIceCandidates \
  -H 'Content-Type: application/json' \  -H 'Accept: */*' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "https://auvious.video/rtc-api/conferences/addViewStreamIceCandidates", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');
const input = '{
  "conferenceId": "string",
  "userEndpointId": "string",
  "streamId": "string",
  "viewerId": "string",
  "iceCandidates": [
    {
      "candidate": "string",
      "sdpMid": "string",
      "sdpMLineIndex": 0
    }
  ]
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': '*/*',  'Authorization': 'Bearer {access-token}'
}

fetch('https://auvious.video/rtc-api/conferences/addViewStreamIceCandidates', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("https://auvious.video/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());

Python

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'https://auvious.video/rtc-api/conferences/addViewStreamIceCandidates',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://auvious.video/rtc-api/conferences/addViewStreamIceCandidates',
  params: {}, headers: headers

p JSON.parse(result)

Adds ice candidates for a published stream. Must be called after publishStream request.

POST https://auvious.video/rtc-api/conferences/addPublishStreamIceCandidates HTTP/1.1
Host: auvious.video
Content-Type: application/json
Accept: */*

Request body

{
  "conferenceId": "string",
  "userEndpointId": "string",
  "streamId": "string",
  "iceCandidates": [
    {
      "candidate": "string",
      "sdpMid": "string",
      "sdpMLineIndex": 0
    }
  ]
}

Parameters

Parameter	In	Type	Required	Description
body	body	ConferencePublishStreamIceCandidatesWebCommand	true	none

Responses

Overview

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Inline

Response Schema

Status Code 400

Name	Type	Required	Restrictions	Description
» additionalProperties	string	false	none	none

Examples

400 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

Shell

curl -X POST https://auvious.video/rtc-api/conferences/addPublishStreamIceCandidates \
  -H 'Content-Type: application/json' \  -H 'Accept: */*' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "https://auvious.video/rtc-api/conferences/addPublishStreamIceCandidates", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');
const input = '{
  "conferenceId": "string",
  "userEndpointId": "string",
  "streamId": "string",
  "iceCandidates": [
    {
      "candidate": "string",
      "sdpMid": "string",
      "sdpMLineIndex": 0
    }
  ]
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': '*/*',  'Authorization': 'Bearer {access-token}'
}

fetch('https://auvious.video/rtc-api/conferences/addPublishStreamIceCandidates', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("https://auvious.video/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());

Python

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'https://auvious.video/rtc-api/conferences/addPublishStreamIceCandidates',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://auvious.video/rtc-api/conferences/addPublishStreamIceCandidates',
  params: {}, headers: headers

p JSON.parse(result)

Get conference aggregate.

GET https://auvious.video/rtc-api/conferences/{id} HTTP/1.1
Host: auvious.video
Accept: application/json

Parameters

Parameter	In	Type	Required	Description
id	path	string	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	Conference
400	Bad Request	Bad Request	Inline

Response Schema

Status Code 400

Name	Type	Required	Restrictions	Description
» additionalProperties	string	false	none	none

Examples

200 Response

{
  "id": "string",
  "mode": "P2P",
  "organizationId": "string",
  "interactionId": "string",
  "creator": "string",
  "creatorEndpoint": "string",
  "participants": [
    {
      "id": "string",
      "userId": "string",
      "state": "HEALTHY",
      "streams": [
        {
          "id": "string",
          "type": "MIC",
          "metadata": {
            "property1": {},
            "property2": {}
          },
          "videoBitrate": 0
        }
      ],
      "metadata": {
        "property1": {},
        "property2": {}
      }
    }
  ],
  "allowedParticipants": [
    "string"
  ],
  "securityScheme": "CUSTOMER_ALLOWLIST_OR_TICKET",
  "metadata": {
    "property1": {
      "value": "string",
      "userId": "string",
      "userEndpointId": "string",
      "lastModified": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "value": "string",
      "userId": "string",
      "userEndpointId": "string",
      "lastModified": "2019-08-24T14:15:22Z"
    }
  },
  "version": 0,
  "empty": true
}

400 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

Shell

curl -X GET https://auvious.video/rtc-api/conferences/{id} \
  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

Go

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/rtc-api/conferences/{id}", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');

const headers = {
  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('https://auvious.video/rtc-api/conferences/{id}', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("https://auvious.video/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());

Python

import requests

headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get(
  'https://auvious.video/rtc-api/conferences/{id}',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://auvious.video/rtc-api/conferences/{id}',
  params: {}, 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/rtc-api/conferences/{id}/simpleView HTTP/1.1
Host: auvious.video
Accept: application/json

Parameters

Parameter	In	Type	Required	Description
id	path	string	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	ConferenceSimpleView
400	Bad Request	Bad Request	Inline

Response Schema

Status Code 400

Name	Type	Required	Restrictions	Description
» additionalProperties	string	false	none	none

Examples

200 Response

{
  "id": "string",
  "mode": "string",
  "metadata": {
    "property1": {
      "value": "string",
      "userId": "string",
      "userEndpointId": "string",
      "lastModified": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "value": "string",
      "userId": "string",
      "userEndpointId": "string",
      "lastModified": "2019-08-24T14:15:22Z"
    }
  },
  "participants": [
    {
      "id": "string",
      "endpoints": [
        {
          "id": "string",
          "state": "HEALTHY",
          "streams": [
            {
              "id": "string",
              "type": "string",
              "metadata": {
                "property1": {},
                "property2": {}
              }
            }
          ],
          "metadata": {
            "property1": {},
            "property2": {}
          }
        }
      ]
    }
  ],
  "version": 0
}

400 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

Shell

curl -X GET https://auvious.video/rtc-api/conferences/{id}/simpleView \
  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

Go

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/rtc-api/conferences/{id}/simpleView", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');

const headers = {
  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('https://auvious.video/rtc-api/conferences/{id}/simpleView', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("https://auvious.video/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());

Python

import requests

headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get(
  'https://auvious.video/rtc-api/conferences/{id}/simpleView',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://auvious.video/rtc-api/conferences/{id}/simpleView',
  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/rtc-api/conferences/{id}/events?v=0 HTTP/1.1
Host: auvious.video
Accept: application/json

Parameters

Parameter	In	Type	Required	Description
id	path	string	true	none
v	query	integer(int64)	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad Request	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[ConferenceEvent]	false	none	none
» id	string	false	none	event unique id
» type	string	false	none	event type
» timestamp	string(date-time)	false	none	event time, format is "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"
» conferenceId	string	false	none	the conference which this event belongs to
» organizationId	string	false	none	the organizationId
» 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

Status Code 400

Name	Type	Required	Restrictions	Description
» additionalProperties	string	false	none	none

Examples

200 Response

[
  {
    "id": "string",
    "type": "string",
    "timestamp": "2019-08-24T14:15:22Z",
    "conferenceId": "string",
    "organizationId": "string",
    "conferenceVersion": 0
  }
]

400 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

Shell

curl -X GET https://auvious.video/rtc-api/conferences/{id}/events?v=0 \
  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

Go

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/rtc-api/conferences/{id}/events", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');

const headers = {
  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('https://auvious.video/rtc-api/conferences/{id}/events?v=0', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("https://auvious.video/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());

Python

import requests

headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get(
  'https://auvious.video/rtc-api/conferences/{id}/events',
  params={
    'v': '0'},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://auvious.video/rtc-api/conferences/{id}/events',
  params: {
    'v' => 'integer(int64)'}, headers: headers

p JSON.parse(result)

Gets a list of active conferences of the user organization

GET https://auvious.video/rtc-api/conferences/active HTTP/1.1
Host: auvious.video
Accept: application/json

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad Request	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[Conference]	false	none	none
» id	string	false	none	none
» mode	string	false	none	none
» organizationId	string	false	none	none
» interactionId	string	false	none	none
» creator	string	false	none	none
» creatorEndpoint	string	false	none	none
» participants	[ConferenceParticipant]	false	none	none
»» id	string	false	none	none
»» userId	string	false	none	none
»» state	string	false	none	none
»» streams	[ConferenceStream]	false	none	none
»»» id	string	false	none	none
»»» type	string	false	none	none
»»» metadata	object	false	none	none
»»»» additionalProperties	object	false	none	none
»»» videoBitrate	integer(int32)	false	none	none
»» metadata	object	false	none	none
»»» additionalProperties	object	false	none	none
» allowedParticipants	[string]	false	none	none
» securityScheme	string	false	none	none
» metadata	object	false	none	none
»» additionalProperties	Metadata	false	none	none
»»» value	string	false	none	none
»»» userId	string	false	none	none
»»» userEndpointId	string	false	none	none
»»» lastModified	string(date-time)	false	none	none
» version	integer(int64)	false	none	none
» empty	boolean	false	none	none

Enumerated Values

Property	Value
mode	P2P
mode	ROUTER
mode	UNKNOWN
state	HEALTHY
state	SICK
state	UNKNOWN
type	MIC
type	CAM
type	SCREEN
type	MIC_AND_CAM
type	UNKNOWN
securityScheme	CUSTOMER_ALLOWLIST_OR_TICKET

Status Code 400

Name	Type	Required	Restrictions	Description
» additionalProperties	string	false	none	none

Examples

200 Response

[
  {
    "id": "string",
    "mode": "P2P",
    "organizationId": "string",
    "interactionId": "string",
    "creator": "string",
    "creatorEndpoint": "string",
    "participants": [
      {
        "id": "string",
        "userId": "string",
        "state": "HEALTHY",
        "streams": [
          {
            "id": "string",
            "type": "MIC",
            "metadata": {
              "property1": {},
              "property2": {}
            },
            "videoBitrate": 0
          }
        ],
        "metadata": {
          "property1": {},
          "property2": {}
        }
      }
    ],
    "allowedParticipants": [
      "string"
    ],
    "securityScheme": "CUSTOMER_ALLOWLIST_OR_TICKET",
    "metadata": {
      "property1": {
        "value": "string",
        "userId": "string",
        "userEndpointId": "string",
        "lastModified": "2019-08-24T14:15:22Z"
      },
      "property2": {
        "value": "string",
        "userId": "string",
        "userEndpointId": "string",
        "lastModified": "2019-08-24T14:15:22Z"
      }
    },
    "version": 0,
    "empty": true
  }
]

400 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

Shell

curl -X GET https://auvious.video/rtc-api/conferences/active \
  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

Go

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/rtc-api/conferences/active", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Node

const fetch = require('node-fetch');

const headers = {
  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('https://auvious.video/rtc-api/conferences/active', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

// This sample needs improvement.
URL obj = new URL("https://auvious.video/rtc-api/conferences/active");

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());

Python

import requests

headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get(
  'https://auvious.video/rtc-api/conferences/active',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://auvious.video/rtc-api/conferences/active',
  params: {}, headers: headers

p JSON.parse(result)

Schemas

AddAllowedParticipantsWebCommand

{
  "userEndpointId": "string",
  "participants": [
    "string"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
userEndpointId	string	false	none	Optional requester endpoint ID to persist on the emitted event.
participants	[string]	true	none	User IDs to authorize for joining the conference.

ConferenceViewStreamWebCommand

{
  "conferenceId": "string",
  "userEndpointId": "string",
  "streamId": "string",
  "sdpOffer": "string",
  "viewerId": "string",
  "metadata": {
    "property1": "string",
    "property2": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
conferenceId	string	true	none	Supply the conferenceId. Mandatory.
userEndpointId	string	true	none	Supply the user endpoint id of the viewer. Mandatory.
streamId	string	true	none	Supply the stream id to view. Mandatory.
sdpOffer	string	true	none	Supply the sdp offer. Mandatory.
viewerId	string	false	none	Supply the viewerId. Optional.
metadata	object	false	none	Stream metadata. Optional.
» additionalProperties	string	false	none	Stream metadata. Optional.

ConferenceStreamViewResult

{
  "viewerId": "string",
  "sdpAnswer": "string"
}

Properties

Name	Type	Required	Restrictions	Description
viewerId	string	false	none	none
sdpAnswer	string	false	none	none

UpdateConferenceStreamMetadataWebCommand

{
  "conferenceId": "string",
  "userEndpointId": "string",
  "streamId": "string",
  "newMetadata": {
    "property1": {},
    "property2": {}
  }
}

Properties

Name	Type	Required	Restrictions	Description
conferenceId	string	true	none	Supply the conferenceId. Mandatory.
userEndpointId	string	true	none	Supply the user endpoint id. Mandatory.
streamId	string	true	none	Supply the streamId. Optional.
newMetadata	object	false	none	Supply the metadata of the stream.
» additionalProperties	object	false	none	Supply the metadata of the stream.

ConferenceUpdatePublishedStreamBitrateWebCommand

{
  "conferenceId": "string",
  "userEndpointId": "string",
  "streamId": "string",
  "videoBitrate": 30000
}

Properties

Name	Type	Required	Restrictions	Description
conferenceId	string	true	none	Supply the conferenceId. Mandatory.
userEndpointId	string	true	none	Supply the user endpoint id. Mandatory.
streamId	string	false	none	Supply the streamId. Optional.
videoBitrate	integer(int32)	true	none	Stream video bitrate. Optional

UpdateConferenceParticipantMetadataWebCommand

{
  "conferenceId": "string",
  "userEndpointId": "string",
  "newMetadata": {
    "property1": {},
    "property2": {}
  }
}

Properties

Name	Type	Required	Restrictions	Description
conferenceId	string	true	none	Supply the conferenceId. Mandatory.
userEndpointId	string	true	none	Supply the user endpoint id. Mandatory.
newMetadata	object	true	none	Supply the metadata of the user.
» additionalProperties	object	false	none	Supply the metadata of the user.

UpdateConferenceMetadataWebCommand

{
  "conferenceId": "string",
  "userEndpointId": "string",
  "operation": "SET",
  "key": "string",
  "value": "string"
}

Properties

Name	Type	Required	Restrictions	Description
conferenceId	string	true	none	Supply the conferenceId. Mandatory.
userEndpointId	string	true	none	Supply the user endpoint id. Mandatory.
operation	string	true	none	Supply the operation, SET or REMOVE. Mandatory.
key	string	true	none	Supply the key. Mandatory
value	string	false	none	Supply the value, if the operation is SET. Ignored if operation is REMOVE

Enumerated Values

Property	Value
operation	SET
operation	REMOVE
operation	UNKNOWN

ConferenceUnpublishStreamWebCommand

{
  "conferenceId": "string",
  "userEndpointId": "string",
  "streamId": "string"
}

Properties

Name	Type	Required	Restrictions	Description
conferenceId	string	true	none	Supply the conferenceId. Mandatory.
userEndpointId	string	true	none	Supply the user endpoint id. Mandatory.
streamId	string	true	none	Supply the stream id to unpublish. Mandatory.

ConferenceStopViewStreamWebCommand

{
  "conferenceId": "string",
  "userEndpointId": "string",
  "streamId": "string",
  "viewerId": "string"
}

Properties

Name	Type	Required	Restrictions	Description
conferenceId	string	true	none	Supply the conferenceId. Mandatory.
userEndpointId	string	true	none	Supply the user endpoint id. Mandatory.
streamId	string	true	none	Supply the stream id. Mandatory.
viewerId	string	true	none	Supply the viewer id. Mandatory.

SendEventToConferenceWebCommand

{
  "conferenceId": "string",
  "qos": "BEST_EFFORT",
  "event": {
    "property1": {},
    "property2": {}
  },
  "masks": [
    "string"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
conferenceId	string	true	none	conference id the members of which will receive the message
qos	string	true	none	define qos(optional), default is best effort
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
» additionalProperties	object	false	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.

Enumerated Values

Property	Value
qos	BEST_EFFORT
qos	AT_LEAST_ONCE

SendEventResponse

{
  "eventsSent": 0
}

Properties

Name	Type	Required	Restrictions	Description
eventsSent	integer(int32)	false	none	none

ConferencePublishStreamWebCommand

{
  "conferenceId": "string",
  "userEndpointId": "string",
  "streamId": "string",
  "conferenceStreamType": "MIC",
  "sdpOffer": "string",
  "metadata": {
    "property1": {},
    "property2": {}
  },
  "videoBitrate": 30000
}

Properties

Name	Type	Required	Restrictions	Description
conferenceId	string	true	none	Supply the conferenceId. Mandatory.
userEndpointId	string	true	none	Supply the user endpoint id. Mandatory.
streamId	string	false	none	Supply the streamId. Optional.
conferenceStreamType	string	true	none	Supply the stream type. One of MIC, CAM, SCREEN or MIC_AND_CAM. Mandatory.
sdpOffer	string	false	none	Supply the sdpOffer. Mandatory.
metadata	object	false	none	Stream metadata. Optional
» additionalProperties	object	false	none	Stream metadata. Optional
videoBitrate	integer(int32)	false	none	Stream video bitrate. Optional

Enumerated Values

Property	Value
conferenceStreamType	MIC
conferenceStreamType	CAM
conferenceStreamType	SCREEN
conferenceStreamType	MIC_AND_CAM
conferenceStreamType	UNKNOWN

ConferencePublishResult

{
  "streamId": "string",
  "sdpAnswer": "string"
}

Properties

Name	Type	Required	Restrictions	Description
streamId	string	false	none	none
sdpAnswer	string	false	none	none

LeaveConferenceWebCommand

{
  "conferenceId": "string",
  "userEndpointId": "string",
  "reason": "string"
}

Properties

Name	Type	Required	Restrictions	Description
conferenceId	string	true	none	Supply the conferenceId. Mandatory.
userEndpointId	string	true	none	Supply the user endpoint id. Mandatory.
reason	string	false	none	Supply a reason for leaving. Optional.

JoinConferenceWebCommand

{
  "conferenceId": "string",
  "userEndpointId": "string",
  "metadata": {
    "property1": {},
    "property2": {}
  }
}

Properties

Name	Type	Required	Restrictions	Description
conferenceId	string	true	none	Supply the conferenceId to join. Mandatory.
userEndpointId	string	true	none	Supply the userEndpointId of the user that wants to join. Mandatory.
metadata	object	false	none	Supply the metadata of the user.
» additionalProperties	object	false	none	Supply the metadata of the user.

ConferenceSummary

{
  "id": "string",
  "version": 0,
  "mode": "P2P"
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
version	integer(int64)	false	none	none
mode	string	false	none	none

Enumerated Values

Property	Value
mode	P2P
mode	ROUTER
mode	UNKNOWN

AnotherErrorResponse

{
  "error": "string",
  "error_description": "string"
}

Properties

Name	Type	Required	Restrictions	Description
error	string	false	none	none
error_description	string	false	none	none

SetInteractionIdWebCommand

{
  "conferenceId": "string",
  "interactionId": "string",
  "userEndpointId": "string"
}

Properties

Name	Type	Required	Restrictions	Description
conferenceId	string	true	none	none
interactionId	string	true	none	none
userEndpointId	string	false	none	none

EndConferenceWebCommand

{
  "conferenceId": "string",
  "userEndpointId": "string",
  "reason": "string"
}

Properties

Name	Type	Required	Restrictions	Description
conferenceId	string	true	none	Supply the conferenceId. Mandatory.
userEndpointId	string	true	none	Supply the user endpoint id. Mandatory.
reason	string	false	none	Supply a reason for leaving. Optional.

CreateConferenceWebCommand

{
  "conferenceId": "string",
  "mode": "P2P",
  "organizationId": "string",
  "creatorEndpoint": "string",
  "interactionId": "string",
  "metadata": {
    "property1": "string",
    "property2": "string"
  },
  "allowedParticipants": [
    "string"
  ],
  "securityScheme": "CUSTOMER_ALLOWLIST_OR_TICKET"
}

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.
mode	string	false	none	Supply the conference mode. Currently only ROUTER is supported. Optional.
organizationId	string	false	none	organization id, for internal use only
creatorEndpoint	string	false	none	Supply the creator user endpoint id. Optional.
interactionId	string	false	none	Interaction id related to this conference
metadata	object	false	none	Supply conference metadata. Optional.
» additionalProperties	string	false	none	Supply conference metadata. Optional.
allowedParticipants	[string]	false	none	User IDs pre-authorized to join this conference. Optional.
securityScheme	string	false	none	Security scheme to apply to this conference. Optional. For CUSTOMER_ALLOWLIST_OR_TICKET, customers may join either with a matching conference_id JWT claim or by being listed in allowedParticipants.

Enumerated Values

Property	Value
mode	P2P
mode	ROUTER
mode	UNKNOWN
securityScheme	CUSTOMER_ALLOWLIST_OR_TICKET

ConferenceViewStreamIceCandidatesWebCommand

{
  "conferenceId": "string",
  "userEndpointId": "string",
  "streamId": "string",
  "viewerId": "string",
  "iceCandidates": [
    {
      "candidate": "string",
      "sdpMid": "string",
      "sdpMLineIndex": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
conferenceId	string	true	none	Supply the conferenceId. Mandatory.
userEndpointId	string	true	none	Supply the user endpoint id. Mandatory.
streamId	string	true	none	Supply the viewing stream id. Mandatory.
viewerId	string	true	none	Supply the viewer id. Mandatory.
iceCandidates	[IceCandidate]	true	none	Supply the ice candidates found so far. Mandatory.

IceCandidate

{
  "candidate": "string",
  "sdpMid": "string",
  "sdpMLineIndex": 0
}

Supply the ice candidates found so far. Mandatory.

Properties

Name	Type	Required	Restrictions	Description
candidate	string	false	none	none
sdpMid	string	false	none	none
sdpMLineIndex	integer(int32)	false	none	none

ConferencePublishStreamIceCandidatesWebCommand

{
  "conferenceId": "string",
  "userEndpointId": "string",
  "streamId": "string",
  "iceCandidates": [
    {
      "candidate": "string",
      "sdpMid": "string",
      "sdpMLineIndex": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
conferenceId	string	true	none	Supply the conferenceId. Mandatory.
userEndpointId	string	true	none	Supply the user endpoint id. Mandatory.
streamId	string	true	none	Supply the published stream id. Mandatory.
iceCandidates	[IceCandidate]	true	none	Supply the ice candidates found so far. Mandatory.

Conference

{
  "id": "string",
  "mode": "P2P",
  "organizationId": "string",
  "interactionId": "string",
  "creator": "string",
  "creatorEndpoint": "string",
  "participants": [
    {
      "id": "string",
      "userId": "string",
      "state": "HEALTHY",
      "streams": [
        {
          "id": "string",
          "type": "MIC",
          "metadata": {
            "property1": {},
            "property2": {}
          },
          "videoBitrate": 0
        }
      ],
      "metadata": {
        "property1": {},
        "property2": {}
      }
    }
  ],
  "allowedParticipants": [
    "string"
  ],
  "securityScheme": "CUSTOMER_ALLOWLIST_OR_TICKET",
  "metadata": {
    "property1": {
      "value": "string",
      "userId": "string",
      "userEndpointId": "string",
      "lastModified": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "value": "string",
      "userId": "string",
      "userEndpointId": "string",
      "lastModified": "2019-08-24T14:15:22Z"
    }
  },
  "version": 0,
  "empty": true
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
mode	string	false	none	none
organizationId	string	false	none	none
interactionId	string	false	none	none
creator	string	false	none	none
creatorEndpoint	string	false	none	none
participants	[ConferenceParticipant]	false	none	none
allowedParticipants	[string]	false	none	none
securityScheme	string	false	none	none
metadata	object	false	none	none
» additionalProperties	Metadata	false	none	none
version	integer(int64)	false	none	none
empty	boolean	false	none	none

Enumerated Values

Property	Value
mode	P2P
mode	ROUTER
mode	UNKNOWN
securityScheme	CUSTOMER_ALLOWLIST_OR_TICKET

ConferenceParticipant

{
  "id": "string",
  "userId": "string",
  "state": "HEALTHY",
  "streams": [
    {
      "id": "string",
      "type": "MIC",
      "metadata": {
        "property1": {},
        "property2": {}
      },
      "videoBitrate": 0
    }
  ],
  "metadata": {
    "property1": {},
    "property2": {}
  }
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
userId	string	false	none	none
state	string	false	none	none
streams	[ConferenceStream]	false	none	none
metadata	object	false	none	none
» additionalProperties	object	false	none	none

Enumerated Values

Property	Value
state	HEALTHY
state	SICK
state	UNKNOWN

ConferenceStream

{
  "id": "string",
  "type": "MIC",
  "metadata": {
    "property1": {},
    "property2": {}
  },
  "videoBitrate": 0
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
type	string	false	none	none
metadata	object	false	none	none
» additionalProperties	object	false	none	none
videoBitrate	integer(int32)	false	none	none

Enumerated Values

Property	Value
type	MIC
type	CAM
type	SCREEN
type	MIC_AND_CAM
type	UNKNOWN

Metadata

{
  "value": "string",
  "userId": "string",
  "userEndpointId": "string",
  "lastModified": "2019-08-24T14:15:22Z"
}

Properties

Name	Type	Required	Restrictions	Description
value	string	false	none	none
userId	string	false	none	none
userEndpointId	string	false	none	none
lastModified	string(date-time)	false	none	none

ConferenceSimpleView

{
  "id": "string",
  "mode": "string",
  "metadata": {
    "property1": {
      "value": "string",
      "userId": "string",
      "userEndpointId": "string",
      "lastModified": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "value": "string",
      "userId": "string",
      "userEndpointId": "string",
      "lastModified": "2019-08-24T14:15:22Z"
    }
  },
  "participants": [
    {
      "id": "string",
      "endpoints": [
        {
          "id": "string",
          "state": "HEALTHY",
          "streams": [
            {
              "id": "string",
              "type": "string",
              "metadata": {
                "property1": {},
                "property2": {}
              }
            }
          ],
          "metadata": {
            "property1": {},
            "property2": {}
          }
        }
      ]
    }
  ],
  "version": 0
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
mode	string	false	none	none
metadata	object	false	none	none
» additionalProperties	Metadata	false	none	none
participants	[ConferenceSimpleViewParticipant]	false	none	none
version	integer(int64)	false	none	none

ConferenceSimpleViewParticipant

{
  "id": "string",
  "endpoints": [
    {
      "id": "string",
      "state": "HEALTHY",
      "streams": [
        {
          "id": "string",
          "type": "string",
          "metadata": {
            "property1": {},
            "property2": {}
          }
        }
      ],
      "metadata": {
        "property1": {},
        "property2": {}
      }
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
endpoints	[ConferenceSimpleViewParticipantEndpoint]	false	none	none

ConferenceSimpleViewParticipantEndpoint

{
  "id": "string",
  "state": "HEALTHY",
  "streams": [
    {
      "id": "string",
      "type": "string",
      "metadata": {
        "property1": {},
        "property2": {}
      }
    }
  ],
  "metadata": {
    "property1": {},
    "property2": {}
  }
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
state	string	false	none	none
streams	[ConferenceSimpleViewParticipantEndpointStream]	false	none	none
metadata	object	false	none	none
» additionalProperties	object	false	none	none

Enumerated Values

Property	Value
state	HEALTHY
state	SICK
state	UNKNOWN

ConferenceSimpleViewParticipantEndpointStream

{
  "id": "string",
  "type": "string",
  "metadata": {
    "property1": {},
    "property2": {}
  }
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
type	string	false	none	none
metadata	object	false	none	none
» additionalProperties	object	false	none	none

ConferenceEvent

{
  "id": "string",
  "type": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "conferenceId": "string",
  "organizationId": "string",
  "conferenceVersion": 0
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	event unique id
type	string	false	none	event type
timestamp	string(date-time)	false	none	event time, format is "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"
conferenceId	string	false	none	the conference which this event belongs to
organizationId	string	false	none	the organizationId
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