Auvious RTC API v1.9.31

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

Snapshots

Set the AI analysis of a snapshot

PUT https://auvious.video/rtc-api/snapshots/{snapshotId}/analysis HTTP/1.1
Host: auvious.video
Content-Type: application/json
Accept: */*

Sets the AI analysis (e.g. a text description) of a snapshot. AGENT or SERVICE only; customers are refused. Agents are limited to their organization's snapshots. SERVICE callers must supply organizationId, which must match the snapshot's organization. The state is forward-only: PENDING -> COMPLETED | FAILED; a COMPLETED or FAILED analysis is never moved back to PENDING (409), while COMPLETED/FAILED -> COMPLETED/FAILED (a re-analysis) is allowed. The analysis is replaced as a whole. No event is published.

Request body

{
  "organizationId": "string",
  "state": "PENDING",
  "result": "string",
  "taskId": "string",
  "error": "string"
}

Parameters

Parameter	In	Type	Required	Description
snapshotId	path	string	true	none
body	body	SnapshotUpdateAnalysisWebCommand	true	none

Responses

Overview

Status	Meaning	Description	Schema
204	No Content	Analysis updated	None
400	Bad Request	Invalid payload, or missing organizationId for a SERVICE caller	Inline
403	Forbidden	Caller is neither AGENT nor SERVICE	None
404	Not Found	Snapshot not found in the caller's organization	None
409	Conflict	Terminal analysis cannot move back to PENDING, or a concurrent update conflict persisted	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/snapshots/{snapshotId}/analysis \
  -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/snapshots/{snapshotId}/analysis", bytes.NewBuffer(body))
    req.Header = headers

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

Node

const fetch = require('node-fetch');
const input = '{
  "organizationId": "string",
  "state": "PENDING",
  "result": "string",
  "taskId": "string",
  "error": "string"
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': '*/*',  'Authorization': 'Bearer {access-token}'
}

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

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/snapshots/{snapshotId}/analysis',
  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/snapshots/{snapshotId}/analysis',
  params: {}, headers: headers

p JSON.parse(result)

Upload a snapshot

POST https://auvious.video/rtc-api/snapshots/upload HTTP/1.1
Host: auvious.video
Content-Type: multipart/form-data
Accept: */*

Request body

relatedSnapshotId: string
applicationId: string
targetUserId: string
targetUserEndpointId: string
interactionId: string
userEndpointId: string
snapshotType: string
snapshotSuffix: string
snapshotMimeType: string
image: string

Parameters

Parameter	In	Type	Required	Description
body	body	object	true	none
» relatedSnapshotId	body	string	false	none
» applicationId	body	string	true	none
» targetUserId	body	string	true	none
» targetUserEndpointId	body	string	true	none
» interactionId	body	string	true	none
» userEndpointId	body	string	true	none
» snapshotType	body	string	true	none
» snapshotSuffix	body	string	true	none
» snapshotMimeType	body	string	true	none
» image	body	string(binary)	true	none

Responses

Overview

Status	Meaning	Description	Schema
204	No Content	No Content	SnapshotUploadResult
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

204 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/snapshots/upload \
  -H 'Content-Type: multipart/form-data' \  -H 'Accept: */*' \  -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{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

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

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

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

Node

const fetch = require('node-fetch');
const input = '{
  "relatedSnapshotId": "string",
  "applicationId": "string",
  "targetUserId": "string",
  "targetUserEndpointId": "string",
  "interactionId": "string",
  "userEndpointId": "string",
  "snapshotType": "string",
  "snapshotSuffix": "string",
  "snapshotMimeType": "string",
  "image": "string"
}';
const headers = {
  'Content-Type': 'multipart/form-data',  'Accept': '*/*',  'Authorization': 'Bearer {access-token}'
}

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

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': '*/*',
  'Authorization': 'Bearer {access-token}'
}

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

print r.json()

Ruby

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

Create a signed url for a snapshot

POST https://auvious.video/rtc-api/snapshots/signedUrl HTTP/1.1
Host: auvious.video
Content-Type: application/json
Accept: application/json
Referer: string

Request body

{
  "snapshotId": "string",
  "createInternalSignedUrl": true
}

Parameters

Parameter	In	Type	Required	Description
Referer	header	string	true	none
body	body	CreateSnapshotSignedURLWebCommand	true	none

Responses

Overview

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

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

Shell

curl -X POST https://auvious.video/rtc-api/snapshots/signedUrl \
  -H 'Content-Type: application/json' \  -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{ 
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Referer": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

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

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

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

Node

const fetch = require('node-fetch');
const input = '{
  "snapshotId": "string",
  "createInternalSignedUrl": true
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': 'application/json',  'Referer': 'string',  'Authorization': 'Bearer {access-token}'
}

fetch('https://auvious.video/rtc-api/snapshots/signedUrl', {
  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/snapshots/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 = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Referer': 'string',
  'Authorization': 'Bearer {access-token}'
}

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

print r.json()

Ruby

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

Creates a new snapshot request

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

Request body

{
  "applicationId": "string",
  "userEndpointId": "string",
  "targetUserId": "string",
  "targetUserEndpointId": "string",
  "sessionType": "UNKNOWN",
  "sessionId": "string",
  "interactionId": "string",
  "snapshotType": "string"
}

Parameters

Parameter	In	Type	Required	Description
body	body	SnapshotRequestWebCommand	true	none

Responses

Overview

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

200 Response

{
  "snapshotId": "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/snapshots/request \
  -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/snapshots/request", bytes.NewBuffer(body))
    req.Header = headers

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

Node

const fetch = require('node-fetch');
const input = '{
  "applicationId": "string",
  "userEndpointId": "string",
  "targetUserId": "string",
  "targetUserEndpointId": "string",
  "sessionType": "UNKNOWN",
  "sessionId": "string",
  "interactionId": "string",
  "snapshotType": "string"
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

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

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/snapshots/request',
  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/snapshots/request',
  params: {}, headers: headers

p JSON.parse(result)

Discard a snapshot

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

An AGENT may discard the snapshots of its organization; a USER only its own snapshots (subject or requester) of its organization.

Request body

{
  "snapshotId": "string",
  "userEndpointId": "string"
}

Parameters

Parameter	In	Type	Required	Description
body	body	SnapshotDiscardWebCommand	true	none

Responses

Overview

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Inline
404	Not Found	Snapshot 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/snapshots/discard \
  -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/snapshots/discard", bytes.NewBuffer(body))
    req.Header = headers

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

Node

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

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

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/snapshots/discard',
  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/snapshots/discard',
  params: {}, headers: headers

p JSON.parse(result)

Creates a new camera request

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

Request body

{
  "userEndpointId": "string",
  "targetUserId": "string",
  "targetUserEndpointId": "string",
  "sessionType": "UNKNOWN",
  "sessionId": "string",
  "cameraRequestType": "CAMERA_SWITCH"
}

Parameters

Parameter	In	Type	Required	Description
body	body	SnapshotCameraRequestWebCommand	true	none

Responses

Overview

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

200 Response

"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/snapshots/cameraRequest \
  -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/snapshots/cameraRequest", bytes.NewBuffer(body))
    req.Header = headers

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

Node

const fetch = require('node-fetch');
const input = '{
  "userEndpointId": "string",
  "targetUserId": "string",
  "targetUserEndpointId": "string",
  "sessionType": "UNKNOWN",
  "sessionId": "string",
  "cameraRequestType": "CAMERA_SWITCH"
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

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

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/snapshots/cameraRequest',
  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/snapshots/cameraRequest',
  params: {}, headers: headers

p JSON.parse(result)

Responds to a camera request

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

Request body

{
  "snapshotCameraRequestId": "string",
  "userEndpointId": "string",
  "succeeded": true,
  "additionalInformation": "string"
}

Parameters

Parameter	In	Type	Required	Description
body	body	SnapshotCameraRequestRespondWebCommand	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/snapshots/cameraRequestRespond \
  -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/snapshots/cameraRequestRespond", bytes.NewBuffer(body))
    req.Header = headers

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

Node

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

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

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/snapshots/cameraRequestRespond',
  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/snapshots/cameraRequestRespond',
  params: {}, headers: headers

p JSON.parse(result)

Approve a snapshot

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

An AGENT may approve the snapshots of its organization; a USER only its own snapshots (subject or requester) of its organization.

Request body

{
  "snapshotId": "string",
  "userEndpointId": "string",
  "snapshotType": "string"
}

Parameters

Parameter	In	Type	Required	Description
body	body	SnapshotApproveWebCommand	true	none

Responses

Overview

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Inline
404	Not Found	Snapshot 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/snapshots/approve \
  -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/snapshots/approve", bytes.NewBuffer(body))
    req.Header = headers

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

Node

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

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

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/snapshots/approve',
  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/snapshots/approve',
  params: {}, headers: headers

p JSON.parse(result)

Acquire a snapshot

POST https://auvious.video/rtc-api/snapshots/acquire HTTP/1.1
Host: auvious.video
Content-Type: multipart/form-data
Accept: */*

Request body

snapshotId: string
userEndpointId: string
snapshotType: string
snapshotSuffix: string
snapshotMimeType: string
image: string

Parameters

Parameter	In	Type	Required	Description
body	body	object	true	none
» snapshotId	body	string	true	none
» userEndpointId	body	string	true	none
» snapshotType	body	string	true	none
» snapshotSuffix	body	string	true	none
» snapshotMimeType	body	string	true	none
» image	body	string(binary)	true	none

Responses

Overview

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Inline
404	Not Found	Snapshot 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/snapshots/acquire \
  -H 'Content-Type: multipart/form-data' \  -H 'Accept: */*' \  -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{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

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

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

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

Node

const fetch = require('node-fetch');
const input = '{
  "snapshotId": "string",
  "userEndpointId": "string",
  "snapshotType": "string",
  "snapshotSuffix": "string",
  "snapshotMimeType": "string",
  "image": "string"
}';
const headers = {
  'Content-Type': 'multipart/form-data',  'Accept': '*/*',  'Authorization': 'Bearer {access-token}'
}

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

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': '*/*',
  'Authorization': 'Bearer {access-token}'
}

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

print r.json()

Ruby

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

retrieve snapshots

GET https://auvious.video/rtc-api/snapshots?interactionId=string HTTP/1.1
Host: auvious.video
Accept: */*

The analysis of each snapshot is returned only to AGENT or SERVICE callers; it is null for other callers (ROLE_USER may be an end customer).

Parameters

Parameter	In	Type	Required	Description
interactionId	query	string	true	none

Responses

Overview

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

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 GET https://auvious.video/rtc-api/snapshots?interactionId=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/rtc-api/snapshots", 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/rtc-api/snapshots?interactionId=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/rtc-api/snapshots?interactionId=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/rtc-api/snapshots',
  params={
    'interactionId': 'string'},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://auvious.video/rtc-api/snapshots',
  params: {
    'interactionId' => 'string'}, headers: headers

p JSON.parse(result)

retrieve specific snapshot

GET https://auvious.video/rtc-api/snapshots/{snapshotId} HTTP/1.1
Host: auvious.video
Accept: */*

Parameters

Parameter	In	Type	Required	Description
snapshotId	path	string	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	Snapshot
400	Bad Request	Bad Request	Inline
404	Not Found	Snapshot not found in the caller's organization	None

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 GET https://auvious.video/rtc-api/snapshots/{snapshotId} \
  -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/rtc-api/snapshots/{snapshotId}", 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/rtc-api/snapshots/{snapshotId}', {
  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/snapshots/{snapshotId}");

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/rtc-api/snapshots/{snapshotId}',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

get a builtin signed url

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

Parameters

Parameter	In	Type	Required	Description
snapshotId	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
404	Not Found	Not Found	None

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 GET https://auvious.video/rtc-api/snapshots/signed/{snapshotId}/{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/rtc-api/snapshots/signed/{snapshotId}/{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/rtc-api/snapshots/signed/{snapshotId}/{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/rtc-api/snapshots/signed/{snapshotId}/{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/rtc-api/snapshots/signed/{snapshotId}/{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/rtc-api/snapshots/signed/{snapshotId}/{expiration}',
  params: {
    'signature' => 'string'}, headers: headers

p JSON.parse(result)

Schemas

SnapshotUpdateAnalysisWebCommand

{
  "organizationId": "string",
  "state": "PENDING",
  "result": "string",
  "taskId": "string",
  "error": "string"
}

Sets the AI analysis of a snapshot

Properties

Name	Type	Required	Restrictions	Description
organizationId	string	false	none	organization id of the snapshot; required for SERVICE callers (ignored for agents, whose organization comes from the token)
state	string	true	none	analysis state, one of PENDING
result	string¦null	false	none	the analysis (recognition) text, at most 32 KiB in UTF-8
taskId	string¦null	false	none	the ai task id
error	string¦null	false	none	short failure reason

Enumerated Values

Property	Value
state	PENDING
state	COMPLETED
state	FAILED

SnapshotUploadResult

{
  "snapshotId": "string"
}

Properties

Name	Type	Required	Restrictions	Description
snapshotId	string	false	none	none

CreateSnapshotSignedURLWebCommand

{
  "snapshotId": "string",
  "createInternalSignedUrl": true
}

Properties

Name	Type	Required	Restrictions	Description
snapshotId	string	true	none	none
createInternalSignedUrl	boolean	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

SnapshotRequestWebCommand

{
  "applicationId": "string",
  "userEndpointId": "string",
  "targetUserId": "string",
  "targetUserEndpointId": "string",
  "sessionType": "UNKNOWN",
  "sessionId": "string",
  "interactionId": "string",
  "snapshotType": "string"
}

Properties

Name	Type	Required	Restrictions	Description
applicationId	string	true	none	the application to use
userEndpointId	string	true	none	the requester's userEndpointId
targetUserId	string	true	none	the request's target userId
targetUserEndpointId	string	true	none	the request's target userEndpointId
sessionType	string	false	none	session type, one of CONFERENCE
sessionId	string	false	none	session id, e.g. conference id for conference
interactionId	string	false	none	interaction id, e.g. if provided snapshot will be stored under interactions/{interaction-id} folder in storage
snapshotType	string	false	none	the snapshot's type

Enumerated Values

Property	Value
sessionType	UNKNOWN
sessionType	CALL
sessionType	CONFERENCE

SnapshotRequestResult

{
  "snapshotId": "string"
}

Properties

Name	Type	Required	Restrictions	Description
snapshotId	string	false	none	none

SnapshotDiscardWebCommand

{
  "snapshotId": "string",
  "userEndpointId": "string"
}

Properties

Name	Type	Required	Restrictions	Description
snapshotId	string	true	none	the snapshot id
userEndpointId	string	true	none	the discarder's userEndpointId

SnapshotCameraRequestWebCommand

{
  "userEndpointId": "string",
  "targetUserId": "string",
  "targetUserEndpointId": "string",
  "sessionType": "UNKNOWN",
  "sessionId": "string",
  "cameraRequestType": "CAMERA_SWITCH"
}

Properties

Name	Type	Required	Restrictions	Description
userEndpointId	string	true	none	the requester's userEndpointId
targetUserId	string	true	none	the request's target userId
targetUserEndpointId	string	true	none	the request's target userEndpointId
sessionType	string	false	none	session type, one of CONFERENCE
sessionId	string	false	none	session id, e.g. conference id for conference
cameraRequestType	string	true	none	the request type, feel free to enter what suits you

Enumerated Values

Property	Value
sessionType	UNKNOWN
sessionType	CALL
sessionType	CONFERENCE
cameraRequestType	CAMERA_SWITCH
cameraRequestType	FLASH_ON
cameraRequestType	FLASH_OFF

SnapshotCameraRequestRespondWebCommand

{
  "snapshotCameraRequestId": "string",
  "userEndpointId": "string",
  "succeeded": true,
  "additionalInformation": "string"
}

Properties

Name	Type	Required	Restrictions	Description
snapshotCameraRequestId	string	true	none	the request id
userEndpointId	string	true	none	the responder's userEndpointId
succeeded	boolean	true	none	indicates if the request succeeded
additionalInformation	string	false	none	additional information about the request success or failure

SnapshotApproveWebCommand

{
  "snapshotId": "string",
  "userEndpointId": "string",
  "snapshotType": "string"
}

Properties

Name	Type	Required	Restrictions	Description
snapshotId	string	true	none	the snapshot id
userEndpointId	string	true	none	the requester's userEndpointId
snapshotType	string	false	none	the snapshot type (override request snapshot type)

Snapshot

{
  "id": "string",
  "relatedSnapshotId": "string",
  "organizationId": "string",
  "applicationId": "string",
  "requesterUserId": "string",
  "requesterUserEndpointId": "string",
  "userId": "string",
  "userEndpointId": "string",
  "sessionType": "UNKNOWN",
  "sessionId": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "interactionId": "string",
  "type": "string",
  "path": "string",
  "state": "UPLOADED",
  "requestProcessingResult": {
    "snapshotId": "string"
  },
  "approvalProcessingResult": {
    "succeeded": true,
    "additionalInformation": "string"
  },
  "suffix": "string",
  "mimeType": "string",
  "analysis": {
    "state": "PENDING",
    "result": "string",
    "taskId": "string",
    "error": "string",
    "updatedAt": "2019-08-24T14:15:22Z",
    "updatedBy": "string"
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "version": 0,
  "approved": true
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
relatedSnapshotId	string	false	none	none
organizationId	string	false	none	none
applicationId	string	false	none	none
requesterUserId	string	false	none	none
requesterUserEndpointId	string	false	none	none
userId	string	false	none	none
userEndpointId	string	false	none	none
sessionType	string	false	none	none
sessionId	string	false	none	none
timestamp	string(date-time)	false	none	none
interactionId	string	false	none	none
type	string	false	none	none
path	string	false	none	none
state	string	false	none	none
requestProcessingResult	SnapshotRequestResult	false	none	none
approvalProcessingResult	SnapshotApprovalProcessingResult	false	none	none
suffix	string	false	none	none
mimeType	string	false	none	none
analysis	SnapshotAnalysis	false	none	AI analysis of the snapshot; absent if the snapshot was never analysed
createdAt	string(date-time)	false	none	none
version	integer(int64)	false	none	none
approved	boolean	false	none	none

Enumerated Values

Property	Value
sessionType	UNKNOWN
sessionType	CALL
sessionType	CONFERENCE
state	UPLOADED
state	APPROVED
state	DISCARDED

SnapshotAnalysis

{
  "state": "PENDING",
  "result": "string",
  "taskId": "string",
  "error": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}

AI analysis of the snapshot; absent if the snapshot was never analysed

Properties

Name	Type	Required	Restrictions	Description
state	string	false	none	analysis state, one of PENDING
result	string¦null	false	none	the analysis (recognition) text, if any
taskId	string¦null	false	none	the ai task id, if any
error	string¦null	false	none	short failure reason, if any
updatedAt	string(date-time)	false	none	when the analysis was last updated
updatedBy	string	false	none	the user (agent, or service client) that last updated the analysis

Enumerated Values

Property	Value
state	PENDING
state	COMPLETED
state	FAILED

SnapshotApprovalProcessingResult

{
  "succeeded": true,
  "additionalInformation": "string"
}

Properties

Name	Type	Required	Restrictions	Description
succeeded	boolean	false	none	none
additionalInformation	string	false	none	none