Ice Servers v1.0

Operations supporting ice servers necessary for establishing video calls and conferences

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

• 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

IceSupport

Ice Servers Controller

Obtains iceServers for use by WebRTC peers

GET https://auvious.video:443/rtc-api/iceServers/v2 HTTP/1.1
Host: auvious.video:443
Accept: application/json

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	IceServersResultV2
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	None
404	Not Found	Not Found	None

Examples

200 Response

{
  "stun": "string",
  "ttl": 0,
  "turn": "string",
  "turnPassword": "string",
  "turnUsername": "string"
}

caution

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

curl -X GET https://auvious.video:443/rtc-api/iceServers/v2 \
  -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:443/rtc-api/iceServers/v2", 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:443/rtc-api/iceServers/v2', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

Java

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

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:443/rtc-api/iceServers/v2',
  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:443/rtc-api/iceServers/v2',
  params: {}, headers: headers

p JSON.parse(result)

Schemas

IceServer

{
  "credential": "string",
  "urls": [
    "string"
  ],
  "username": "string"
}

IceServer

Properties

Name	Type	Required	Restrictions	Description
credential	string	false	none	none
urls	[string]	false	none	none
username	string	false	none	none

IceServersResult

{
  "iceServers": [
    {
      "credential": "string",
      "urls": [
        "string"
      ],
      "username": "string"
    }
  ],
  "ttl": 0
}

IceServersResult

Properties

Name	Type	Required	Restrictions	Description
iceServers	[IceServer]	false	none	none
ttl	integer(int32)	false	none	none

IceServersResultV2

{
  "stun": "string",
  "ttl": 0,
  "turn": "string",
  "turnPassword": "string",
  "turnUsername": "string"
}

IceServersResultV2

Properties

Name	Type	Required	Restrictions	Description
stun	string	false	none	none
ttl	integer(int32)	false	none	none
turn	string	false	none	none
turnPassword	string	false	none	none
turnUsername	string	false	none	none