Snapshot v1.0

Operations supporting taking snapshots using the camera of the remote party.

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

Snapshots

Snapshot Controller

retrieve snapshots

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

Parameters

Parameter	In	Type	Required	Description
interactionId	query	string	true	interactionId

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	Iterable«Snapshot»
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/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:443/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:443/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:443/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:443/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:443/rtc-api/snapshots',
  params: {
    'interactionId' => 'string'}, headers: headers

p JSON.parse(result)

Acquire a snapshot

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

Request body

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

Parameters

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

Responses

Overview

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

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/snapshots/acquire \
  -H 'Content-Type: multipart/form-data' \  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

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

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

    req, err := http.NewRequest("POST", "https://auvious.video:443/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 = '{
  "image": "string",
  "snapshotId": "string",
  "snapshotMimeType": "string",
  "snapshotSuffix": "string",
  "snapshotType": "string",
  "userEndpointId": "string"
}';
const headers = {
  'Content-Type': 'multipart/form-data',  'Authorization': 'Bearer {access-token}'
}

fetch('https://auvious.video:443/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:443/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',
  'Authorization': 'Bearer {access-token}'
}

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

print r.json()

Ruby

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

Approve a snapshot

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

Request body

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

Parameters

Parameter	In	Type	Required	Description
body	body	SnapshotApproveWebCommand	false	none

Responses

Overview

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

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/snapshots/approve \
  -H 'Content-Type: 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"},
        "Authorization": []string{"Bearer {access-token}"},
    }

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

    req, err := http.NewRequest("POST", "https://auvious.video:443/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",
  "snapshotType": "string",
  "userEndpointId": "string"
}';
const headers = {
  'Content-Type': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('https://auvious.video:443/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:443/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',
  'Authorization': 'Bearer {access-token}'
}

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

print r.json()

Ruby

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

Creates a new camera request

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

Request body

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

Parameters

Parameter	In	Type	Required	Description
body	body	SnapshotCameraRequestWebCommand	false	none

Responses

Overview

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

Examples

200 Response

"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 POST https://auvious.video:443/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:443/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 = '{
  "cameraRequestType": "CAMERA_SWITCH",
  "sessionId": "string",
  "sessionType": "CALL",
  "targetUserEndpointId": "string",
  "targetUserId": "string",
  "userEndpointId": "string"
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('https://auvious.video:443/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:443/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:443/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:443/rtc-api/snapshots/cameraRequest',
  params: {}, headers: headers

p JSON.parse(result)

Responds to a camera request

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

Request body

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

Parameters

Parameter	In	Type	Required	Description
body	body	SnapshotCameraRequestRespondWebCommand	false	none

Responses

Overview

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

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/snapshots/cameraRequestRespond \
  -H 'Content-Type: 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"},
        "Authorization": []string{"Bearer {access-token}"},
    }

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

    req, err := http.NewRequest("POST", "https://auvious.video:443/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 = '{
  "additionalInformation": "string",
  "snapshotCameraRequestId": "string",
  "succeeded": false,
  "userEndpointId": "string"
}';
const headers = {
  'Content-Type': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('https://auvious.video:443/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:443/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',
  'Authorization': 'Bearer {access-token}'
}

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

print r.json()

Ruby

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

Discard a snapshot

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

Request body

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

Parameters

Parameter	In	Type	Required	Description
body	body	SnapshotDiscardWebCommand	false	none

Responses

Overview

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

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/snapshots/discard \
  -H 'Content-Type: 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"},
        "Authorization": []string{"Bearer {access-token}"},
    }

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

    req, err := http.NewRequest("POST", "https://auvious.video:443/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',  'Authorization': 'Bearer {access-token}'
}

fetch('https://auvious.video:443/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:443/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',
  'Authorization': 'Bearer {access-token}'
}

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

print r.json()

Ruby

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

Creates a new snapshot request

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

Request body

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

Parameters

Parameter	In	Type	Required	Description
body	body	SnapshotRequestWebCommand	false	none

Responses

Overview

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

Examples

200 Response

{
  "snapshotId": "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 POST https://auvious.video:443/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:443/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": {
    "id": "string"
  },
  "interactionId": "string",
  "sessionId": "string",
  "sessionType": "CALL",
  "snapshotType": "string",
  "targetUserEndpointId": "string",
  "targetUserId": "string",
  "userEndpointId": "string"
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('https://auvious.video:443/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:443/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:443/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:443/rtc-api/snapshots/request',
  params: {}, headers: headers

p JSON.parse(result)

get a builtin signed url

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

Parameters

Parameter	In	Type	Required	Description
snapshotId	path	string	true	snapshotId
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/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:443/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:443/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:443/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:443/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:443/rtc-api/snapshots/signed/{snapshotId}/{expiration}',
  params: {
    'signature' => 'string'}, headers: headers

p JSON.parse(result)

Create a signed url for a snapshot

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

Request body

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

Parameters

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

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/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:443/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 = '{
  "createInternalSignedUrl": true,
  "snapshotId": "string"
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': 'application/json',  'Referer': 'string',  'Authorization': 'Bearer {access-token}'
}

fetch('https://auvious.video:443/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:443/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:443/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:443/rtc-api/snapshots/signedUrl',
  params: {}, headers: headers

p JSON.parse(result)

Upload a snapshot

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

Request body

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

Parameters

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

Responses

Overview

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

Examples

204 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/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:443/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 = '{
  "applicationId": "string",
  "image": "string",
  "interactionId": "string",
  "relatedSnapshotId": "string",
  "snapshotMimeType": "string",
  "snapshotSuffix": "string",
  "snapshotType": "string",
  "targetUserEndpointId": "string",
  "targetUserId": "string",
  "userEndpointId": "string"
}';
const headers = {
  'Content-Type': 'multipart/form-data',  'Accept': '*/*',  'Authorization': 'Bearer {access-token}'
}

fetch('https://auvious.video:443/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:443/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:443/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:443/rtc-api/snapshots/upload',
  params: {}, headers: headers

p JSON.parse(result)

retrieve specific snapshot

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

Parameters

Parameter	In	Type	Required	Description
snapshotId	path	string	true	snapshotId

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	Snapshot
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/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:443/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:443/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:443/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:443/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:443/rtc-api/snapshots/{snapshotId}',
  params: {}, headers: headers

p JSON.parse(result)

Schemas

ApplicationId

{
  "id": "string"
}

ApplicationId

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none

CreateSnapshotSignedURLWebCommand

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

CreateSnapshotSignedURLWebCommand

Properties

Name	Type	Required	Restrictions	Description
createInternalSignedUrl	boolean	false	none	none
snapshotId	string	true	none	none

InputStream

{}

InputStream

Properties

None

Iterable«Snapshot»

{}

Iterable«Snapshot»

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

Snapshot

{
  "applicationId": {
    "id": "string"
  },
  "approvalProcessingResult": {
    "additionalInformation": "string",
    "succeeded": true
  },
  "approved": true,
  "createdAt": "2019-08-24T14:15:22Z",
  "id": "string",
  "interactionId": "string",
  "mimeType": "string",
  "organizationId": "string",
  "path": "string",
  "relatedSnapshotId": "string",
  "requestProcessingResult": {
    "error": "string",
    "snapshotAcquired": true
  },
  "requesterUserEndpointId": "string",
  "requesterUserId": "string",
  "sessionId": "string",
  "sessionType": "CALL",
  "state": "APPROVED",
  "suffix": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "type": "string",
  "userEndpointId": "string",
  "userId": "string",
  "version": 0
}

Snapshot

Properties

Name	Type	Required	Restrictions	Description
applicationId	ApplicationId	false	none	none
approvalProcessingResult	SnapshotApprovalProcessingResult	false	none	none
approved	boolean	false	none	none
createdAt	string(date-time)	false	none	none
id	string	false	none	none
interactionId	string	false	none	none
mimeType	string	false	none	none
organizationId	string	false	none	none
path	string	false	none	none
relatedSnapshotId	string	false	none	none
requestProcessingResult	SnapshotRequestResult	false	none	none
requesterUserEndpointId	string	false	none	none
requesterUserId	string	false	none	none
sessionId	string	false	none	none
sessionType	string	false	none	none
state	string	false	none	none
suffix	string	false	none	none
timestamp	string(date-time)	false	none	none
type	string	false	none	none
userEndpointId	string	false	none	none
userId	string	false	none	none
version	integer(int64)	false	none	none

Enumerated Values

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

SnapshotApprovalProcessingResult

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

SnapshotApprovalProcessingResult

Properties

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

SnapshotApproveWebCommand

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

SnapshotApproveWebCommand

Properties

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

SnapshotCameraRequestRespondWebCommand

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

SnapshotCameraRequestRespondWebCommand

Properties

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

SnapshotCameraRequestWebCommand

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

SnapshotCameraRequestWebCommand

Properties

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

Enumerated Values

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

SnapshotDiscardWebCommand

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

SnapshotDiscardWebCommand

Properties

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

SnapshotRequestResult

{
  "error": "string",
  "snapshotAcquired": true
}

SnapshotRequestResult

Properties

Name	Type	Required	Restrictions	Description
error	string	false	none	none
snapshotAcquired	boolean	false	none	none

SnapshotRequestResult0

{
  "snapshotId": "string"
}

SnapshotRequestResult0

Properties

Name	Type	Required	Restrictions	Description
snapshotId	string	false	none	none

SnapshotRequestWebCommand

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

SnapshotRequestWebCommand

Properties

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

Enumerated Values

Property	Value
sessionType	CALL
sessionType	CONFERENCE
sessionType	UNKNOWN

SnapshotUploadResult

{
  "snapshotId": "string"
}

SnapshotUploadResult

Properties

Name	Type	Required	Restrictions	Description
snapshotId	string	false	none	none