Auvious RTC API v1.9.7

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 = https://auvious.video/security/oauth/token

  • OAuth 2.0 Scope

    Scope	Scope Description

IceSupport

Obtains iceServers for use by WebRTC peers

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

Responses

Overview

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

Response Schema

Status Code 400

Name	Type	Required	Restrictions	Description
» additionalProperties	string	false	none	none

Examples

200 Response

{
  "stun": "string",
  "turn": "string",
  "turnUsername": "string",
  "turnPassword": "string",
  "ttl": 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/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/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/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/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/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/rtc-api/iceServers/v2',
  params: {}, headers: headers

p JSON.parse(result)

Schemas

IceServer

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

Properties

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

IceServersResult

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

Properties

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

IceServersResultV2

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

Properties

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