FileTransfer v1.0

Operations supporting file transfers between user (endpoints), using application (setup by the customer) storage as an intermediary station. Also files are stored there in order to be retrieved later e.g. when reviewing the interaction/session.

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

File Transfers

File Transfer Controller

Find file transfers

GET https://auvious.video:443/rtc-api/filetransfers HTTP/1.1
Host: auvious.video:443
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	Iterable«FileTransferInfo»
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	None
404	Not Found	Not Found	None

Examples

200 Response

{}

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/filetransfers \
  -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/filetransfers", 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/filetransfers', {
  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/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());

Python

import requests

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

r = requests.get(
  'https://auvious.video:443/rtc-api/filetransfers',
  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/filetransfers',
  params: {}, headers: headers

p JSON.parse(result)

Transfer a file

POST https://auvious.video:443/rtc-api/filetransfers HTTP/1.1
Host: auvious.video:443
Content-Type: multipart/form-data
Accept: */*
X-Auvious-TransactionId: string

Request body

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

Parameters

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

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	FileTransferResult
201	Created	Created	None
204	No Content	No Content	None
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	None
404	Not Found	Not Found	None

Examples

200 Response

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 POST https://auvious.video:443/rtc-api/filetransfers \
  -H 'Content-Type: multipart/form-data' \  -H 'Accept: */*' \  -H 'X-Auvious-TransactionId: string' \  -H 'Authorization: Bearer {access-token}'

Go

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", "https://auvious.video:443/rtc-api/filetransfers", bytes.NewBuffer(body))
    req.Header = headers

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

Node

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

fetch('https://auvious.video:443/rtc-api/filetransfers', {
  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:443/rtc-api/filetransfers");

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': 'multipart/form-data',
  'Accept': '*/*',
  'X-Auvious-TransactionId': 'string',
  'Authorization': 'Bearer {access-token}'
}

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

print r.json()

Ruby

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

get a builtin signed url

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

Parameters

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

Responses

Overview

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

Examples

200 Response

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/filetransfers/signed/{fileTransferId}/{expiration}?signature=string \
  -H 'Accept: */*' \  -H 'Authorization: Bearer {access-token}'

Go

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", "https://auvious.video:443/rtc-api/filetransfers/signed/{fileTransferId}/{expiration}", bytes.NewBuffer(body))
    req.Header = headers

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

Node

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

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

fetch('https://auvious.video:443/rtc-api/filetransfers/signed/{fileTransferId}/{expiration}?signature=string', {
  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/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());

Python

import requests

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

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

print r.json()

Ruby

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

create a signed url

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

Parameters

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

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	SignedUrl
201	Created	Created	None
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	None
404	Not Found	Not Found	None

Examples

200 Response

{
  "url": "string",
  "validUntil": "2019-08-24T14:15:22Z"
}

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 POST https://auvious.video:443/rtc-api/filetransfers/{fileTransferId}/signedUrl \
  -H 'Accept: application/json' \  -H 'Referer: string' \  -H 'Authorization: Bearer {access-token}'

Go

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", "https://auvious.video:443/rtc-api/filetransfers/{fileTransferId}/signedUrl", 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',  'Referer': 'string',  'Authorization': 'Bearer {access-token}'
}

fetch('https://auvious.video:443/rtc-api/filetransfers/{fileTransferId}/signedUrl', {
  method: 'POST',
  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/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());

Python

import requests

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

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

print r.json()

Ruby

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

Schemas

ConferenceId

{
  "id": "string"
}

ConferenceId

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none

FileTransferInfo

{
  "conferenceId": {
    "id": "string"
  },
  "fileTransferId": "string",
  "filename": "string",
  "interactionId": "string",
  "mimeType": "string",
  "sentAt": "2019-08-24T14:15:22Z",
  "targetId": "string",
  "targetType": "CONFERENCE",
  "userEndpointId": "string",
  "userId": "string"
}

FileTransferInfo

Properties

Name	Type	Required	Restrictions	Description
conferenceId	ConferenceId	false	none	none
fileTransferId	string	false	none	none
filename	string	false	none	none
interactionId	string	false	none	none
mimeType	string	false	none	none
sentAt	string(date-time)	false	none	none
targetId	string	false	none	none
targetType	string	false	none	none
userEndpointId	string	false	none	none
userId	string	false	none	none

Enumerated Values

Property	Value
targetType	CONFERENCE
targetType	UNKNOWN
targetType	USER
targetType	USER_ENDPOINT

FileTransferResult

{
  "fileTransferId": "string"
}

FileTransferResult

Properties

Name	Type	Required	Restrictions	Description
fileTransferId	string	false	none	none

InputStream

{}

InputStream

Properties

None

Iterable«FileTransferInfo»

{}

Iterable«FileTransferInfo»

Properties

None

Resource

{
  "description": "string",
  "file": "string",
  "filename": "string",
  "inputStream": {},
  "open": true,
  "readable": true,
  "uri": "http://example.com",
  "url": "string"
}

Resource

Properties

Name	Type	Required	Restrictions	Description
description	string	false	none	none
file	string(binary)	false	none	none
filename	string	false	none	none
inputStream	InputStream	false	none	none
open	boolean	false	none	none
readable	boolean	false	none	none
uri	string(uri)	false	none	none
url	string(url)	false	none	none

SignedUrl

{
  "url": "string",
  "validUntil": "2019-08-24T14:15:22Z"
}

SignedUrl

Properties

Name	Type	Required	Restrictions	Description
url	string(url)	false	none	none
validUntil	string(date-time)	false	none	none