Auvious RTC API v1.9.20

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 = http://auvious.video/security/oauth/token
- OAuth 2.0 Scope
  Scope Scope Description

File Transfers

Find file transfers

GET http://auvious.video/rtc-api/filetransfers HTTP/1.1
Host: auvious.video
Accept: application/json

Parameters

Parameter	In	Type	Required	Description
interactionId	query	string	false	find by interactionId, mutually exclusive with conferenceId
conferenceId	query	string	false	find by conferenceId, mutually exclusive with interactionId
all	query	boolean	false	if provided and true, all file transfers will be received, not just the ones sent or received by user calling which is the default behavior

Responses

Overview

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

Response Schema

Status Code 400

Name	Type	Required	Restrictions	Description
» additionalProperties	string	false	none	none

Examples

200 Response

{}

400 Response

caution

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

Code samples

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

package main

import (
    "bytes"
    "net/http"
)

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

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

    req, err := http.NewRequest("GET", "http://auvious.video/rtc-api/filetransfers", bytes.NewBuffer(body))
    req.Header = headers

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

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

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

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

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

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

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

import requests

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

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

print r.json()

require 'rest-client'
require 'json'

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

result = RestClient.get 'http://auvious.video/rtc-api/filetransfers',
  params: {}, headers: headers

p JSON.parse(result)

Transfer a file

POST http://auvious.video/rtc-api/filetransfers?targetType=user HTTP/1.1
Host: auvious.video
Content-Type: multipart/form-data
Accept: */*
X-Auvious-TransactionId: string

Request body

userEndpointId: string
applicationId: string
interactionId: string
conferenceId: string
targetId: string
file: string

Parameters

Parameter	In	Type	Required	Description
X-Auvious-TransactionId	header	string	false	used for detecting retries of the same request
targetType	query	string	true	target type e.g. USER, affects which users will receive the FileTransferEvent message
body	body	object	true	none
» userEndpointId	body	string	false	which userEndpoint id to link to
» applicationId	body	string	true	which application id to use, must match user organization
» interactionId	body	string	false	which integration id to link this transfer to, optional
» conferenceId	body	string	false	which conference id to link this transfer to, optional
» targetId	body	string	true	target id e.g. a user id, will be used to send the FileTransferEvent to all user endpoints of user
» file	body	string(binary)	true	the actual file

Enumerated Values

Parameter	Value
targetType	user

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	FileTransferResult
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

curl -X POST http://auvious.video/rtc-api/filetransfers?targetType=user \
  -H 'Content-Type: multipart/form-data' \  -H 'Accept: */*' \  -H 'X-Auvious-TransactionId: string' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"multipart/form-data"},
        "Accept": []string{"*/*"},
        "X-Auvious-TransactionId": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

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

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

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

const fetch = require('node-fetch');
const input = '{
  "userEndpointId": "string",
  "applicationId": "string",
  "interactionId": "string",
  "conferenceId": "string",
  "targetId": "string",
  "file": "string"
}';
const headers = {
  'Content-Type': 'multipart/form-data',  'Accept': '*/*',  'X-Auvious-TransactionId': 'string',  'Authorization': 'Bearer {access-token}'
}

fetch('http://auvious.video/rtc-api/filetransfers?targetType=user', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://auvious.video/rtc-api/filetransfers?targetType=user");

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

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

import requests

headers = {
  'Content-Type': 'multipart/form-data',
  'Accept': '*/*',
  'X-Auvious-TransactionId': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'http://auvious.video/rtc-api/filetransfers',
  params={
    'targetType': 'user'},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'multipart/form-data',
  'Accept' => '*/*',
  'X-Auvious-TransactionId' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'http://auvious.video/rtc-api/filetransfers',
  params: {
    'targetType' => 'string'}, headers: headers

p JSON.parse(result)

create a signed url

POST http://auvious.video/rtc-api/filetransfers/{fileTransferId}/signedUrl HTTP/1.1
Host: auvious.video
Accept: application/json
Referer: string

Parameters

Parameter	In	Type	Required	Description
fileTransferId	path	string	true	none
Referer	header	string	true	none

Responses

Overview

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

Response Schema

Status Code 400

Name	Type	Required	Restrictions	Description
» additionalProperties	string	false	none	none

Examples

200 Response

{
  "url": "https://cdn.example.com/path/to/file?signature=abc123",
  "validFor": "PT5M",
  "validUntil": "2025-03-27T12:00:00Z"
}

400 Response

caution

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

Code samples

curl -X POST http://auvious.video/rtc-api/filetransfers/{fileTransferId}/signedUrl \
  -H 'Accept: application/json' \  -H 'Referer: string' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

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

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

    req, err := http.NewRequest("POST", "http://auvious.video/rtc-api/filetransfers/{fileTransferId}/signedUrl", bytes.NewBuffer(body))
    req.Header = headers

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

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

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

fetch('http://auvious.video/rtc-api/filetransfers/{fileTransferId}/signedUrl', {
  method: 'POST',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://auvious.video/rtc-api/filetransfers/{fileTransferId}/signedUrl");

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

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

import requests

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

r = requests.post(
  'http://auvious.video/rtc-api/filetransfers/{fileTransferId}/signedUrl',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

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

result = RestClient.post 'http://auvious.video/rtc-api/filetransfers/{fileTransferId}/signedUrl',
  params: {}, headers: headers

p JSON.parse(result)

get a builtin signed url

GET http://auvious.video/rtc-api/filetransfers/signed/{fileTransferId}/{expiration}?signature=string HTTP/1.1
Host: auvious.video
Accept: */*

Parameters

Parameter	In	Type	Required	Description
fileTransferId	path	string	true	none
expiration	path	integer(int64)	true	none
signature	query	string	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	string
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

curl -X GET http://auvious.video/rtc-api/filetransfers/signed/{fileTransferId}/{expiration}?signature=string \
  -H 'Accept: */*' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

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

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

    req, err := http.NewRequest("GET", "http://auvious.video/rtc-api/filetransfers/signed/{fileTransferId}/{expiration}", bytes.NewBuffer(body))
    req.Header = headers

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

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

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

fetch('http://auvious.video/rtc-api/filetransfers/signed/{fileTransferId}/{expiration}?signature=string', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://auvious.video/rtc-api/filetransfers/signed/{fileTransferId}/{expiration}?signature=string");

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

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

import requests

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

r = requests.get(
  'http://auvious.video/rtc-api/filetransfers/signed/{fileTransferId}/{expiration}',
  params={
    'signature': 'string'},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

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

result = RestClient.get 'http://auvious.video/rtc-api/filetransfers/signed/{fileTransferId}/{expiration}',
  params: {
    'signature' => 'string'}, headers: headers

p JSON.parse(result)

Schemas

FileTransferResult

{
  "fileTransferId": "string"
}

Properties

Name	Type	Required	Restrictions	Description
fileTransferId	string	false	none	none

SignedUrl

{
  "url": "https://cdn.example.com/path/to/file?signature=abc123",
  "validFor": "PT5M",
  "validUntil": "2025-03-27T12:00:00Z"
}

Properties

Name	Type	Required	Restrictions	Description
url	string(uri)	false	none	none
validFor	string(duration)	false	none	Use this ISO-8601 duration for countdowns to avoid clock drift
validUntil	string(date-time)	false	none	Timestamp when the signed link actually expires

Authentication​

File Transfers​

Find file transfers​

Parameters​

Responses​

Overview​

Response Schema​

Examples​

Code samples​

Transfer a file​

Request body​

Parameters​

Enumerated Values​

Responses​

Overview​

Response Schema​

Examples​

Code samples​

create a signed url​

Parameters​

Responses​

Overview​

Response Schema​

Examples​

Code samples​

get a builtin signed url​

Parameters​

Responses​

Overview​

Response Schema​

Examples​

Code samples​

Schemas​

FileTransferResult​

Properties​

SignedUrl​

Properties​

Authentication

File Transfers

Find file transfers

Parameters

Responses

Overview

Response Schema

Examples

Code samples

Transfer a file

Request body

Parameters

Enumerated Values

Responses

Overview

Response Schema

Examples

Code samples

create a signed url

Parameters

Responses

Overview

Response Schema

Examples

Code samples

get a builtin signed url

Parameters

Responses

Overview

Response Schema

Examples

Code samples

Schemas

FileTransferResult

Properties

SignedUrl

Properties