Auvious Recorder API v1.0
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
- API Key (apiKey)
- Parameter Name: Authorization, in: header.
Media Composition
Composition Controller
Get recording information for a given conversationId.
GET /auvious.video/rtc-recorder/api/compositions/{conversationId} HTTP/1.1
Accept: application/json
Parameters
Parameter | In | Type | Required | Description |
---|---|---|---|---|
conversationId | path | string | true | conversationId |
Responses
Overview
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | RecordingDataMessage |
401 | Unauthorized | Unauthorized | None |
403 | Forbidden | Forbidden | None |
404 | Not Found | Not Found | None |
Examples
200 Response
{
"audio": true,
"chatTranscript": {
"created": "2019-08-24T14:15:22Z",
"id": "string",
"location": "string"
},
"conferenceId": "string",
"conversationId": "string",
"error": {
"code": "string",
"message": "string",
"occurred": "string"
},
"instanceId": "string",
"organizationId": "string",
"recorderId": "string",
"recovered": "string",
"started": "string",
"state": "ABORTED",
"stopped": "string",
"storageProfile": {
"applicationId": "string",
"provider": "AMAZON_S3",
"url": "string"
},
"streams": [
{
"id": "string",
"state": "FAILED",
"tracks": [
{
"id": "string",
"started": "string",
"stopped": "string",
"storage": {
"localStorage": {
"created": "string",
"deleted": "string",
"error": {
"code": "string",
"message": "string",
"occurred": "string"
},
"location": "string"
},
"objectStorage": {
"error": {
"code": "string",
"message": "string",
"occurred": "string"
},
"location": "string",
"size": "string",
"uploaded": "string"
}
},
"type": "AUDIO",
"url": "string"
}
],
"type": "CAM",
"userId": "string"
}
],
"video": true
}
To perform this operation, you must be authenticated by means of one of the following methods: apiKey ( Scopes: global )
Code samples
- Shell
- Go
- Node
- Java
- Python
- Ruby
curl -X GET /auvious.video/rtc-recorder/api/compositions/{conversationId} \
-H 'Accept: application/json' \ -H 'Authorization: API_KEY'
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"API_KEY"},
}
var body []byte
// body = ...
req, err := http.NewRequest("GET", "/auvious.video/rtc-recorder/api/compositions/{conversationId}", bytes.NewBuffer(body))
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
const fetch = require('node-fetch');
const headers = {
'Accept': 'application/json', 'Authorization': 'API_KEY'
}
fetch('/auvious.video/rtc-recorder/api/compositions/{conversationId}', {
method: 'GET',
headers
})
.then(r => r.json())
.then((body) => {
console.log(body)
})
// This sample needs improvement.
URL obj = new URL("/auvious.video/rtc-recorder/api/compositions/{conversationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream())
);
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get(
'/auvious.video/rtc-recorder/api/compositions/{conversationId}',
params={},
headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/auvious.video/rtc-recorder/api/compositions/{conversationId}',
params: {}, headers: headers
p JSON.parse(result)
Media Recording
Recorder Controller
getCobrowseSessionResourceAsAttachment
GET /auvious.video/rtc-recorder/api/recordings/attachment/cobrowse/{conversationId}/{recorderId}/{instanceId}/{sessionId}/{fileName}?Date=string&Expires=string&Signature=string HTTP/1.1
Accept: */*
Range: string
Parameters
Parameter | In | Type | Required | Description |
---|---|---|---|---|
conversationId | path | string | true | conversationId |
Date | query | string | true | Date |
Expires | query | string | true | Expires |
fileName | path | string | true | fileName |
instanceId | path | string | true | instanceId |
Range | header | string | false | Range |
recorderId | path | string | true | recorderId |
sessionId | path | string | true | sessionId |
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
To perform this operation, you must be authenticated by means of one of the following methods: apiKey ( Scopes: global )
Code samples
- Shell
- Go
- Node
- Java
- Python
- Ruby
curl -X GET /auvious.video/rtc-recorder/api/recordings/attachment/cobrowse/{conversationId}/{recorderId}/{instanceId}/{sessionId}/{fileName}?Date=string&Expires=string&Signature=string \
-H 'Accept: */*' \ -H 'Range: string' \ -H 'Authorization: API_KEY'
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"*/*"},
"Range": []string{"string"},
"Authorization": []string{"API_KEY"},
}
var body []byte
// body = ...
req, err := http.NewRequest("GET", "/auvious.video/rtc-recorder/api/recordings/attachment/cobrowse/{conversationId}/{recorderId}/{instanceId}/{sessionId}/{fileName}", bytes.NewBuffer(body))
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
const fetch = require('node-fetch');
const headers = {
'Accept': '*/*', 'Range': 'string', 'Authorization': 'API_KEY'
}
fetch('/auvious.video/rtc-recorder/api/recordings/attachment/cobrowse/{conversationId}/{recorderId}/{instanceId}/{sessionId}/{fileName}?Date=string&Expires=string&Signature=string', {
method: 'GET',
headers
})
.then(r => r.json())
.then((body) => {
console.log(body)
})
// This sample needs improvement.
URL obj = new URL("/auvious.video/rtc-recorder/api/recordings/attachment/cobrowse/{conversationId}/{recorderId}/{instanceId}/{sessionId}/{fileName}?Date=string&Expires=string&Signature=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream())
);
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
import requests
headers = {
'Accept': '*/*',
'Range': 'string',
'Authorization': 'API_KEY'
}
r = requests.get(
'/auvious.video/rtc-recorder/api/recordings/attachment/cobrowse/{conversationId}/{recorderId}/{instanceId}/{sessionId}/{fileName}',
params={
'Date': 'string',
'Expires': 'string',
'Signature': 'string'},
headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => '*/*',
'Range' => 'string',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/auvious.video/rtc-recorder/api/recordings/attachment/cobrowse/{conversationId}/{recorderId}/{instanceId}/{sessionId}/{fileName}',
params: {
'Date' => 'string',
'Expires' => 'string',
'Signature' => 'string'}, headers: headers
p JSON.parse(result)
Upload a conversation chat transcript to an existing recorder instance.
POST /auvious.video/rtc-recorder/api/recordings/chat/transcript/add HTTP/1.1
Content-Type: application/json
Accept: */*
Request body
{
"chatTranscriptList": [
{
"id": "string",
"timestamp": "string",
"transcript": "string",
"userDisplayName": "string",
"userId": "string"
}
],
"conversationId": "string",
"instanceId": "string",
"recorderId": "string"
}
Parameters
Parameter | In | Type | Required | Description |
---|---|---|---|---|
body | body | AddChatTranscriptCmd | true | cmd |
Responses
Overview
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | Inline |
201 | Created | Created | None |
401 | Unauthorized | Unauthorized | None |
403 | Forbidden | Forbidden | None |
404 | Not Found | Not Found | None |
Response Schema
Examples
200 Response
To perform this operation, you must be authenticated by means of one of the following methods: apiKey ( Scopes: global )
Code samples
- Shell
- Go
- Node
- Java
- Python
- Ruby
curl -X POST /auvious.video/rtc-recorder/api/recordings/chat/transcript/add \
-H 'Content-Type: application/json' \ -H 'Accept: */*' \ -H 'Authorization: API_KEY'
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"*/*"},
"Authorization": []string{"API_KEY"},
}
var body []byte
// body = ...
req, err := http.NewRequest("POST", "/auvious.video/rtc-recorder/api/recordings/chat/transcript/add", bytes.NewBuffer(body))
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
const fetch = require('node-fetch');
const input = '{
"chatTranscriptList": [
{
"id": "string",
"timestamp": "string",
"transcript": "string",
"userDisplayName": "string",
"userId": "string"
}
],
"conversationId": "string",
"instanceId": "string",
"recorderId": "string"
}';
const headers = {
'Content-Type': 'application/json', 'Accept': '*/*', 'Authorization': 'API_KEY'
}
fetch('/auvious.video/rtc-recorder/api/recordings/chat/transcript/add', {
method: 'POST',
body: input,
headers
})
.then(r => r.json())
.then((body) => {
console.log(body)
})
// This sample needs improvement.
URL obj = new URL("/auvious.video/rtc-recorder/api/recordings/chat/transcript/add");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream())
);
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
import requests
headers = {
'Content-Type': 'application/json',
'Accept': '*/*',
'Authorization': 'API_KEY'
}
r = requests.post(
'/auvious.video/rtc-recorder/api/recordings/chat/transcript/add',
params={},
headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => '*/*',
'Authorization' => 'API_KEY'
}
result = RestClient.post '/auvious.video/rtc-recorder/api/recordings/chat/transcript/add',
params: {}, headers: headers
p JSON.parse(result)
Send a cobrowse session event to an existing recorder instance.
POST /auvious.video/rtc-recorder/api/recordings/cobrowse/event HTTP/1.1
Content-Type: application/json
Accept: */*
Request body
{
"conversationId": "string",
"event": {
"payload": "string",
"sequenceId": 0,
"sessionId": "string",
"timestamp": 0
},
"instanceId": "string",
"recorderId": "string"
}
Parameters
Parameter | In | Type | Required | Description |
---|---|---|---|---|
body | body | AddCobrowseEventCmd | true | cmd |
Responses
Overview
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | Inline |
201 | Created | Created | None |
401 | Unauthorized | Unauthorized | None |
403 | Forbidden | Forbidden | None |
404 | Not Found | Not Found | None |
Response Schema
Examples
200 Response
To perform this operation, you must be authenticated by means of one of the following methods: apiKey ( Scopes: global )
Code samples
- Shell
- Go
- Node
- Java
- Python
- Ruby
curl -X POST /auvious.video/rtc-recorder/api/recordings/cobrowse/event \
-H 'Content-Type: application/json' \ -H 'Accept: */*' \ -H 'Authorization: API_KEY'
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"*/*"},
"Authorization": []string{"API_KEY"},
}
var body []byte
// body = ...
req, err := http.NewRequest("POST", "/auvious.video/rtc-recorder/api/recordings/cobrowse/event", bytes.NewBuffer(body))
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
const fetch = require('node-fetch');
const input = '{
"conversationId": "string",
"event": {
"payload": "string",
"sequenceId": 0,
"sessionId": "string",
"timestamp": 0
},
"instanceId": "string",
"recorderId": "string"
}';
const headers = {
'Content-Type': 'application/json', 'Accept': '*/*', 'Authorization': 'API_KEY'
}
fetch('/auvious.video/rtc-recorder/api/recordings/cobrowse/event', {
method: 'POST',
body: input,
headers
})
.then(r => r.json())
.then((body) => {
console.log(body)
})
// This sample needs improvement.
URL obj = new URL("/auvious.video/rtc-recorder/api/recordings/cobrowse/event");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream())
);
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
import requests
headers = {
'Content-Type': 'application/json',
'Accept': '*/*',
'Authorization': 'API_KEY'
}
r = requests.post(
'/auvious.video/rtc-recorder/api/recordings/cobrowse/event',
params={},
headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => '*/*',
'Authorization' => 'API_KEY'
}
result = RestClient.post '/auvious.video/rtc-recorder/api/recordings/cobrowse/event',
params: {}, headers: headers
p JSON.parse(result)
Start a new recorder instance.
POST /auvious.video/rtc-recorder/api/recordings/start HTTP/1.1
Content-Type: application/json
Accept: */*
Request body
{
"applicationId": "string",
"audio": true,
"conferenceId": "string",
"conversationId": "string",
"video": true
}
Parameters
Parameter | In | Type | Required | Description |
---|---|---|---|---|
body | body | StartRecording | true | cmd |
Responses
Overview
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | RecordingDataEvent |
201 | Created | Created | None |
401 | Unauthorized | Unauthorized | None |
403 | Forbidden | Forbidden | None |
404 | Not Found | Not Found | None |
Examples
200 Response
To perform this operation, you must be authenticated by means of one of the following methods: apiKey ( Scopes: global )
Code samples
- Shell
- Go
- Node
- Java
- Python
- Ruby
curl -X POST /auvious.video/rtc-recorder/api/recordings/start \
-H 'Content-Type: application/json' \ -H 'Accept: */*' \ -H 'Authorization: API_KEY'
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"*/*"},
"Authorization": []string{"API_KEY"},
}
var body []byte
// body = ...
req, err := http.NewRequest("POST", "/auvious.video/rtc-recorder/api/recordings/start", bytes.NewBuffer(body))
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
const fetch = require('node-fetch');
const input = '{
"applicationId": "string",
"audio": true,
"conferenceId": "string",
"conversationId": "string",
"video": true
}';
const headers = {
'Content-Type': 'application/json', 'Accept': '*/*', 'Authorization': 'API_KEY'
}
fetch('/auvious.video/rtc-recorder/api/recordings/start', {
method: 'POST',
body: input,
headers
})
.then(r => r.json())
.then((body) => {
console.log(body)
})
// This sample needs improvement.
URL obj = new URL("/auvious.video/rtc-recorder/api/recordings/start");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream())
);
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
import requests
headers = {
'Content-Type': 'application/json',
'Accept': '*/*',
'Authorization': 'API_KEY'
}
r = requests.post(
'/auvious.video/rtc-recorder/api/recordings/start',
params={},
headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => '*/*',
'Authorization' => 'API_KEY'
}
result = RestClient.post '/auvious.video/rtc-recorder/api/recordings/start',
params: {}, headers: headers
p JSON.parse(result)
Get a list of recordings for a given conversationId.
GET /auvious.video/rtc-recorder/api/recordings/{conversationId} HTTP/1.1
Accept: application/json
Parameters
Parameter | In | Type | Required | Description |
---|---|---|---|---|
conversationId | path | string | true | conversationId |
Responses
Overview
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | ConversationMessage |
401 | Unauthorized | Unauthorized | None |
403 | Forbidden | Forbidden | None |
404 | Not Found | Not Found | None |
Examples
200 Response
{
"applicationId": "string",
"chatTranscript": {
"created": "2019-08-24T14:15:22Z",
"id": "string",
"location": "string"
},
"conversationId": "string",
"duration": "string",
"provider": "AMAZON_S3",
"recordings": [
{
"audio": true,
"conferenceId": "string",
"recorderId": "string",
"recovered": "string",
"started": "string",
"stopped": "string",
"streams": [
{
"started": "string",
"stopped": "string",
"streamId": "string",
"tracks": [
{
"started": "string",
"stopped": "string",
"storage": {
"location": "string",
"size": "string",
"uploaded": "string"
},
"type": "AUDIO"
}
],
"type": "CAM",
"userId": "string"
}
],
"video": true
}
]
}
To perform this operation, you must be authenticated by means of one of the following methods: apiKey ( Scopes: global )
Code samples
- Shell
- Go
- Node
- Java
- Python
- Ruby
curl -X GET /auvious.video/rtc-recorder/api/recordings/{conversationId} \
-H 'Accept: application/json' \ -H 'Authorization: API_KEY'
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"API_KEY"},
}
var body []byte
// body = ...
req, err := http.NewRequest("GET", "/auvious.video/rtc-recorder/api/recordings/{conversationId}", bytes.NewBuffer(body))
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
const fetch = require('node-fetch');
const headers = {
'Accept': 'application/json', 'Authorization': 'API_KEY'
}
fetch('/auvious.video/rtc-recorder/api/recordings/{conversationId}', {
method: 'GET',
headers
})
.then(r => r.json())
.then((body) => {
console.log(body)
})
// This sample needs improvement.
URL obj = new URL("/auvious.video/rtc-recorder/api/recordings/{conversationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream())
);
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get(
'/auvious.video/rtc-recorder/api/recordings/{conversationId}',
params={},
headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/auvious.video/rtc-recorder/api/recordings/{conversationId}',
params: {}, headers: headers
p JSON.parse(result)
Get an active recording by conversationId
GET /auvious.video/rtc-recorder/api/recordings/{conversationId}/active HTTP/1.1
Accept: application/json
Parameters
Parameter | In | Type | Required | Description |
---|---|---|---|---|
conversationId | path | string | true | conversationId |
Responses
Overview
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | RecordingDataEvent |
401 | Unauthorized | Unauthorized | None |
403 | Forbidden | Forbidden | None |
404 | Not Found | Not Found | None |
Examples
200 Response
{
"conversationId": "string",
"error": {
"code": "string",
"message": "string",
"occurred": "string"
},
"instanceId": "string",
"recorderId": "string",
"state": "ABORTED"
}
To perform this operation, you must be authenticated by means of one of the following methods: apiKey ( Scopes: global )
Code samples
- Shell
- Go
- Node
- Java
- Python
- Ruby
curl -X GET /auvious.video/rtc-recorder/api/recordings/{conversationId}/active \
-H 'Accept: application/json' \ -H 'Authorization: API_KEY'
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"API_KEY"},
}
var body []byte
// body = ...
req, err := http.NewRequest("GET", "/auvious.video/rtc-recorder/api/recordings/{conversationId}/active", bytes.NewBuffer(body))
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
const fetch = require('node-fetch');
const headers = {
'Accept': 'application/json', 'Authorization': 'API_KEY'
}
fetch('/auvious.video/rtc-recorder/api/recordings/{conversationId}/active', {
method: 'GET',
headers
})
.then(r => r.json())
.then((body) => {
console.log(body)
})
// This sample needs improvement.
URL obj = new URL("/auvious.video/rtc-recorder/api/recordings/{conversationId}/active");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream())
);
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get(
'/auvious.video/rtc-recorder/api/recordings/{conversationId}/active',
params={},
headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/auvious.video/rtc-recorder/api/recordings/{conversationId}/active',
params: {}, headers: headers
p JSON.parse(result)
Get chatTranscript of a given conversationId.
GET /auvious.video/rtc-recorder/api/recordings/{conversationId}/chat/transcript HTTP/1.1
Accept: application/json
Parameters
Parameter | In | Type | Required | Description |
---|---|---|---|---|
conversationId | path | string | true | conversationId |
Responses
Overview
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | ConversationChatTranscriptDataMessage |
401 | Unauthorized | Unauthorized | None |
403 | Forbidden | Forbidden | None |
404 | Not Found | Not Found | None |
Examples
200 Response
{
"chatTranscriptList": [
{
"id": "string",
"timestamp": "string",
"transcript": "string",
"userDisplayName": "string",
"userId": "string"
}
]
}
To perform this operation, you must be authenticated by means of one of the following methods: apiKey ( Scopes: global )
Code samples
- Shell
- Go
- Node
- Java
- Python
- Ruby
curl -X GET /auvious.video/rtc-recorder/api/recordings/{conversationId}/chat/transcript \
-H 'Accept: application/json' \ -H 'Authorization: API_KEY'
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"API_KEY"},
}
var body []byte
// body = ...
req, err := http.NewRequest("GET", "/auvious.video/rtc-recorder/api/recordings/{conversationId}/chat/transcript", bytes.NewBuffer(body))
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
const fetch = require('node-fetch');
const headers = {
'Accept': 'application/json', 'Authorization': 'API_KEY'
}
fetch('/auvious.video/rtc-recorder/api/recordings/{conversationId}/chat/transcript', {
method: 'GET',
headers
})
.then(r => r.json())
.then((body) => {
console.log(body)
})
// This sample needs improvement.
URL obj = new URL("/auvious.video/rtc-recorder/api/recordings/{conversationId}/chat/transcript");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream())
);
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get(
'/auvious.video/rtc-recorder/api/recordings/{conversationId}/chat/transcript',
params={},
headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/auvious.video/rtc-recorder/api/recordings/{conversationId}/chat/transcript',
params: {}, headers: headers
p JSON.parse(result)
Get all cobrowse sessions for a given conversationId.
GET /auvious.video/rtc-recorder/api/recordings/{conversationId}/cobrowse HTTP/1.1
Accept: application/json
Parameters
Parameter | In | Type | Required | Description |
---|---|---|---|---|
conversationId | path | string | true | conversationId |
Responses
Overview
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | ConversationCobrowseSessionDataMessage |
401 | Unauthorized | Unauthorized | None |
403 | Forbidden | Forbidden | None |
404 | Not Found | Not Found | None |
Examples
200 Response
{
"cobrowseSessions": [
{
"cobrowseSessionId": "string",
"recorderId": "string",
"recorderInstanceId": "string",
"uploaded": "string"
}
],
"conversationId": "string"
}
To perform this operation, you must be authenticated by means of one of the following methods: apiKey ( Scopes: global )
Code samples
- Shell
- Go
- Node
- Java
- Python
- Ruby
curl -X GET /auvious.video/rtc-recorder/api/recordings/{conversationId}/cobrowse \
-H 'Accept: application/json' \ -H 'Authorization: API_KEY'
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"API_KEY"},
}
var body []byte
// body = ...
req, err := http.NewRequest("GET", "/auvious.video/rtc-recorder/api/recordings/{conversationId}/cobrowse", bytes.NewBuffer(body))
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
const fetch = require('node-fetch');
const headers = {
'Accept': 'application/json', 'Authorization': 'API_KEY'
}
fetch('/auvious.video/rtc-recorder/api/recordings/{conversationId}/cobrowse', {
method: 'GET',
headers
})
.then(r => r.json())
.then((body) => {
console.log(body)
})
// This sample needs improvement.
URL obj = new URL("/auvious.video/rtc-recorder/api/recordings/{conversationId}/cobrowse");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream())
);
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get(
'/auvious.video/rtc-recorder/api/recordings/{conversationId}/cobrowse',
params={},
headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/auvious.video/rtc-recorder/api/recordings/{conversationId}/cobrowse',
params: {}, headers: headers
p JSON.parse(result)
Get information of an existing recorder.
GET /auvious.video/rtc-recorder/api/recordings/{conversationId}/{recorderId}/{instanceId} HTTP/1.1
Accept: application/json
Parameters
Parameter | In | Type | Required | Description |
---|---|---|---|---|
conversationId | path | string | true | conversationId |
instanceId | path | string | true | instanceId |
recorderId | path | string | true | recorderId |
Responses
Overview
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | RecordingDataMessage |
401 | Unauthorized | Unauthorized | None |
403 | Forbidden | Forbidden | None |
404 | Not Found | Not Found | None |
Examples
200 Response
{
"audio": true,
"chatTranscript": {
"created": "2019-08-24T14:15:22Z",
"id": "string",
"location": "string"
},
"conferenceId": "string",
"conversationId": "string",
"error": {
"code": "string",
"message": "string",
"occurred": "string"
},
"instanceId": "string",
"organizationId": "string",
"recorderId": "string",
"recovered": "string",
"started": "string",
"state": "ABORTED",
"stopped": "string",
"storageProfile": {
"applicationId": "string",
"provider": "AMAZON_S3",
"url": "string"
},
"streams": [
{
"id": "string",
"state": "FAILED",
"tracks": [
{
"id": "string",
"started": "string",
"stopped": "string",
"storage": {
"localStorage": {
"created": "string",
"deleted": "string",
"error": {
"code": "string",
"message": "string",
"occurred": "string"
},
"location": "string"
},
"objectStorage": {
"error": {
"code": "string",
"message": "string",
"occurred": "string"
},
"location": "string",
"size": "string",
"uploaded": "string"
}
},
"type": "AUDIO",
"url": "string"
}
],
"type": "CAM",
"userId": "string"
}
],
"video": true
}
To perform this operation, you must be authenticated by means of one of the following methods: apiKey ( Scopes: global )
Code samples
- Shell
- Go
- Node
- Java
- Python
- Ruby
curl -X GET /auvious.video/rtc-recorder/api/recordings/{conversationId}/{recorderId}/{instanceId} \
-H 'Accept: application/json' \ -H 'Authorization: API_KEY'
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"API_KEY"},
}
var body []byte
// body = ...
req, err := http.NewRequest("GET", "/auvious.video/rtc-recorder/api/recordings/{conversationId}/{recorderId}/{instanceId}", bytes.NewBuffer(body))
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
const fetch = require('node-fetch');
const headers = {
'Accept': 'application/json', 'Authorization': 'API_KEY'
}
fetch('/auvious.video/rtc-recorder/api/recordings/{conversationId}/{recorderId}/{instanceId}', {
method: 'GET',
headers
})
.then(r => r.json())
.then((body) => {
console.log(body)
})
// This sample needs improvement.
URL obj = new URL("/auvious.video/rtc-recorder/api/recordings/{conversationId}/{recorderId}/{instanceId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream())
);
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get(
'/auvious.video/rtc-recorder/api/recordings/{conversationId}/{recorderId}/{instanceId}',
params={},
headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/auvious.video/rtc-recorder/api/recordings/{conversationId}/{recorderId}/{instanceId}',
params: {}, headers: headers
p JSON.parse(result)
Get a signed URL for a given cobrowse session file
GET /auvious.video/rtc-recorder/api/recordings/{conversationId}/{recorderId}/{instanceId}/cobrowse/{sessionId}/url/attachment?conversationId=string&id=string&instanceId=string&organizationId=string HTTP/1.1
Accept: */*
referer: string
Parameters
Parameter | In | Type | Required | Description |
---|---|---|---|---|
conversationId | query | string | true | none |
id | query | string | true | none |
instanceId | query | string | true | none |
organizationId | query | string | true | none |
referer | header | string | true | referer |
sessionId | path | string | true | sessionId |
Responses
Overview
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | URLResourceMessage |
401 | Unauthorized | Unauthorized | None |
403 | Forbidden | Forbidden | None |
404 | Not Found | Not Found | None |
Examples
200 Response
To perform this operation, you must be authenticated by means of one of the following methods: apiKey ( Scopes: global )
Code samples
- Shell
- Go
- Node
- Java
- Python
- Ruby
curl -X GET /auvious.video/rtc-recorder/api/recordings/{conversationId}/{recorderId}/{instanceId}/cobrowse/{sessionId}/url/attachment?conversationId=string&id=string&instanceId=string&organizationId=string \
-H 'Accept: */*' \ -H 'referer: string' \ -H 'Authorization: API_KEY'
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"*/*"},
"referer": []string{"string"},
"Authorization": []string{"API_KEY"},
}
var body []byte
// body = ...
req, err := http.NewRequest("GET", "/auvious.video/rtc-recorder/api/recordings/{conversationId}/{recorderId}/{instanceId}/cobrowse/{sessionId}/url/attachment", bytes.NewBuffer(body))
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
const fetch = require('node-fetch');
const headers = {
'Accept': '*/*', 'referer': 'string', 'Authorization': 'API_KEY'
}
fetch('/auvious.video/rtc-recorder/api/recordings/{conversationId}/{recorderId}/{instanceId}/cobrowse/{sessionId}/url/attachment?conversationId=string&id=string&instanceId=string&organizationId=string', {
method: 'GET',
headers
})
.then(r => r.json())
.then((body) => {
console.log(body)
})
// This sample needs improvement.
URL obj = new URL("/auvious.video/rtc-recorder/api/recordings/{conversationId}/{recorderId}/{instanceId}/cobrowse/{sessionId}/url/attachment?conversationId=string&id=string&instanceId=string&organizationId=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream())
);
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
import requests
headers = {
'Accept': '*/*',
'referer': 'string',
'Authorization': 'API_KEY'
}
r = requests.get(
'/auvious.video/rtc-recorder/api/recordings/{conversationId}/{recorderId}/{instanceId}/cobrowse/{sessionId}/url/attachment',
params={
'conversationId': 'string',
'id': 'string',
'instanceId': 'string',
'organizationId': 'string'},
headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => '*/*',
'referer' => 'string',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/auvious.video/rtc-recorder/api/recordings/{conversationId}/{recorderId}/{instanceId}/cobrowse/{sessionId}/url/attachment',
params: {
'conversationId' => 'string',
'id' => 'string',
'instanceId' => 'string',
'organizationId' => 'string'}, headers: headers
p JSON.parse(result)
Get status of an existing recorder.
GET /auvious.video/rtc-recorder/api/recordings/{conversationId}/{recorderId}/{instanceId}/state HTTP/1.1
Accept: application/json
Parameters
Parameter | In | Type | Required | Description |
---|---|---|---|---|
conversationId | path | string | true | conversationId |
instanceId | path | string | true | instanceId |
recorderId | path | string | true | recorderId |
Responses
Overview
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | RecordingDataEvent |
401 | Unauthorized | Unauthorized | None |
403 | Forbidden | Forbidden | None |
404 | Not Found | Not Found | None |
Examples
200 Response
{
"conversationId": "string",
"error": {
"code": "string",
"message": "string",
"occurred": "string"
},
"instanceId": "string",
"recorderId": "string",
"state": "ABORTED"
}
To perform this operation, you must be authenticated by means of one of the following methods: apiKey ( Scopes: global )
Code samples
- Shell
- Go
- Node
- Java
- Python
- Ruby
curl -X GET /auvious.video/rtc-recorder/api/recordings/{conversationId}/{recorderId}/{instanceId}/state \
-H 'Accept: application/json' \ -H 'Authorization: API_KEY'
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"API_KEY"},
}
var body []byte
// body = ...
req, err := http.NewRequest("GET", "/auvious.video/rtc-recorder/api/recordings/{conversationId}/{recorderId}/{instanceId}/state", bytes.NewBuffer(body))
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
const fetch = require('node-fetch');
const headers = {
'Accept': 'application/json', 'Authorization': 'API_KEY'
}
fetch('/auvious.video/rtc-recorder/api/recordings/{conversationId}/{recorderId}/{instanceId}/state', {
method: 'GET',
headers
})
.then(r => r.json())
.then((body) => {
console.log(body)
})
// This sample needs improvement.
URL obj = new URL("/auvious.video/rtc-recorder/api/recordings/{conversationId}/{recorderId}/{instanceId}/state");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream())
);
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get(
'/auvious.video/rtc-recorder/api/recordings/{conversationId}/{recorderId}/{instanceId}/state',
params={},
headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/auvious.video/rtc-recorder/api/recordings/{conversationId}/{recorderId}/{instanceId}/state',
params: {}, headers: headers
p JSON.parse(result)
Stop an existing recorder instance.
POST /auvious.video/rtc-recorder/api/recordings/{conversationId}/{recorderId}/{instanceId}/stop HTTP/1.1
Accept: */*
Parameters
Parameter | In | Type | Required | Description |
---|---|---|---|---|
conversationId | path | string | true | conversationId |
instanceId | path | string | true | instanceId |
recorderId | path | string | true | recorderId |
Responses
Overview
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | Inline |
201 | Created | Created | None |
401 | Unauthorized | Unauthorized | None |
403 | Forbidden | Forbidden | None |
404 | Not Found | Not Found | None |
Response Schema
Examples
200 Response
To perform this operation, you must be authenticated by means of one of the following methods: apiKey ( Scopes: global )
Code samples
- Shell
- Go
- Node
- Java
- Python
- Ruby
curl -X POST /auvious.video/rtc-recorder/api/recordings/{conversationId}/{recorderId}/{instanceId}/stop \
-H 'Accept: */*' \ -H 'Authorization: API_KEY'
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"*/*"},
"Authorization": []string{"API_KEY"},
}
var body []byte
// body = ...
req, err := http.NewRequest("POST", "/auvious.video/rtc-recorder/api/recordings/{conversationId}/{recorderId}/{instanceId}/stop", bytes.NewBuffer(body))
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
const fetch = require('node-fetch');
const headers = {
'Accept': '*/*', 'Authorization': 'API_KEY'
}
fetch('/auvious.video/rtc-recorder/api/recordings/{conversationId}/{recorderId}/{instanceId}/stop', {
method: 'POST',
headers
})
.then(r => r.json())
.then((body) => {
console.log(body)
})
// This sample needs improvement.
URL obj = new URL("/auvious.video/rtc-recorder/api/recordings/{conversationId}/{recorderId}/{instanceId}/stop");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream())
);
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
import requests
headers = {
'Accept': '*/*',
'Authorization': 'API_KEY'
}
r = requests.post(
'/auvious.video/rtc-recorder/api/recordings/{conversationId}/{recorderId}/{instanceId}/stop',
params={},
headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => '*/*',
'Authorization' => 'API_KEY'
}
result = RestClient.post '/auvious.video/rtc-recorder/api/recordings/{conversationId}/{recorderId}/{instanceId}/stop',
params: {}, headers: headers
p JSON.parse(result)
Get basic storage profile information of an existing recorder.
GET /auvious.video/rtc-recorder/api/recordings/{conversationId}/{recorderId}/{instanceId}/storage/info HTTP/1.1
Accept: application/json
Parameters
Parameter | In | Type | Required | Description |
---|---|---|---|---|
conversationId | path | string | true | conversationId |
instanceId | path | string | true | instanceId |
recorderId | path | string | true | recorderId |
Responses
Overview
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | StorageProfileDataMessage |
401 | Unauthorized | Unauthorized | None |
403 | Forbidden | Forbidden | None |
404 | Not Found | Not Found | None |
Examples
200 Response
{
"applicationId": "string",
"provider": "AMAZON_S3",
"url": "string"
}
To perform this operation, you must be authenticated by means of one of the following methods: apiKey ( Scopes: global )
Code samples
- Shell
- Go
- Node
- Java
- Python
- Ruby
curl -X GET /auvious.video/rtc-recorder/api/recordings/{conversationId}/{recorderId}/{instanceId}/storage/info \
-H 'Accept: application/json' \ -H 'Authorization: API_KEY'
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"API_KEY"},
}
var body []byte
// body = ...
req, err := http.NewRequest("GET", "/auvious.video/rtc-recorder/api/recordings/{conversationId}/{recorderId}/{instanceId}/storage/info", bytes.NewBuffer(body))
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
const fetch = require('node-fetch');
const headers = {
'Accept': 'application/json', 'Authorization': 'API_KEY'
}
fetch('/auvious.video/rtc-recorder/api/recordings/{conversationId}/{recorderId}/{instanceId}/storage/info', {
method: 'GET',
headers
})
.then(r => r.json())
.then((body) => {
console.log(body)
})
// This sample needs improvement.
URL obj = new URL("/auvious.video/rtc-recorder/api/recordings/{conversationId}/{recorderId}/{instanceId}/storage/info");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream())
);
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get(
'/auvious.video/rtc-recorder/api/recordings/{conversationId}/{recorderId}/{instanceId}/storage/info',
params={},
headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get '/auvious.video/rtc-recorder/api/recordings/{conversationId}/{recorderId}/{instanceId}/storage/info',
params: {}, headers: headers
p JSON.parse(result)
Media Storage
Provider Controller
Verify the validity of a given storage provider profile.
POST /auvious.video/rtc-recorder/api/storageproviders/{applicationId}/verify HTTP/1.1
Accept: */*
Parameters
Parameter | In | Type | Required | Description |
---|---|---|---|---|
applicationId | path | string | true | applicationId |
Responses
Overview
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | StorageVerificationStatusMessage |
201 | Created | Created | None |
401 | Unauthorized | Unauthorized | None |
403 | Forbidden | Forbidden | None |
404 | Not Found | Not Found | None |
Examples
200 Response
To perform this operation, you must be authenticated by means of one of the following methods: apiKey ( Scopes: global )
Code samples
- Shell
- Go
- Node
- Java
- Python
- Ruby
curl -X POST /auvious.video/rtc-recorder/api/storageproviders/{applicationId}/verify \
-H 'Accept: */*' \ -H 'Authorization: API_KEY'
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"*/*"},
"Authorization": []string{"API_KEY"},
}
var body []byte
// body = ...
req, err := http.NewRequest("POST", "/auvious.video/rtc-recorder/api/storageproviders/{applicationId}/verify", bytes.NewBuffer(body))
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
const fetch = require('node-fetch');
const headers = {
'Accept': '*/*', 'Authorization': 'API_KEY'
}
fetch('/auvious.video/rtc-recorder/api/storageproviders/{applicationId}/verify', {
method: 'POST',
headers
})
.then(r => r.json())
.then((body) => {
console.log(body)
})
// This sample needs improvement.
URL obj = new URL("/auvious.video/rtc-recorder/api/storageproviders/{applicationId}/verify");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream())
);
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
import requests
headers = {
'Accept': '*/*',
'Authorization': 'API_KEY'
}
r = requests.post(
'/auvious.video/rtc-recorder/api/storageproviders/{applicationId}/verify',
params={},
headers = headers)
print r.json()
require 'rest-client'
require 'json'
headers = {
'Accept' => '*/*',
'Authorization' => 'API_KEY'
}
result = RestClient.post '/auvious.video/rtc-recorder/api/storageproviders/{applicationId}/verify',
params: {}, headers: headers
p JSON.parse(result)
Schemas
AddChatTranscriptCmd
{
"chatTranscriptList": [
{
"id": "string",
"timestamp": "string",
"transcript": "string",
"userDisplayName": "string",
"userId": "string"
}
],
"conversationId": "string",
"instanceId": "string",
"recorderId": "string"
}
AddChatTranscriptCmd
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
chatTranscriptList | [ChatTranscriptEntry] | true | none | none |
conversationId | string | true | none | none |
instanceId | string | true | none | none |
recorderId | string | true | none | none |
AddCobrowseEventCmd
{
"conversationId": "string",
"event": {
"payload": "string",
"sequenceId": 0,
"sessionId": "string",
"timestamp": 0
},
"instanceId": "string",
"recorderId": "string"
}
AddCobrowseEventCmd
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
conversationId | string | true | none | none |
event | CobrowseEvent | true | none | none |
instanceId | string | true | none | none |
recorderId | string | true | none | none |
ChatTranscriptData
{
"created": "2019-08-24T14:15:22Z",
"id": "string",
"location": "string"
}
ChatTranscriptData
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
created | string(date-time) | true | none | none |
id | string | true | none | none |
location | string | true | none | none |
ChatTranscriptEntry
{
"id": "string",
"timestamp": "string",
"transcript": "string",
"userDisplayName": "string",
"userId": "string"
}
ChatTranscriptEntry
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | string | false | none | none |
timestamp | string | true | none | none |
transcript | string | true | none | none |
userDisplayName | string | false | none | none |
userId | string | true | none | none |
CobrowseEvent
{
"payload": "string",
"sequenceId": 0,
"sessionId": "string",
"timestamp": 0
}
CobrowseEvent
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
payload | string | true | none | none |
sequenceId | integer(int32) | true | none | none |
sessionId | string | true | none | none |
timestamp | integer(int64) | true | none | none |
CobrowseSessionDataMessage
{
"cobrowseSessionId": "string",
"recorderId": "string",
"recorderInstanceId": "string",
"uploaded": "string"
}
CobrowseSessionDataMessage
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
cobrowseSessionId | string | false | none | none |
recorderId | string | false | none | none |
recorderInstanceId | string | false | none | none |
uploaded | string | false | none | none |
ConversationChatTranscriptDataMessage
{
"chatTranscriptList": [
{
"id": "string",
"timestamp": "string",
"transcript": "string",
"userDisplayName": "string",
"userId": "string"
}
]
}
ConversationChatTranscriptDataMessage
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
chatTranscriptList | [ChatTranscriptEntry] | true | none | none |
ConversationCobrowseSessionDataMessage
{
"cobrowseSessions": [
{
"cobrowseSessionId": "string",
"recorderId": "string",
"recorderInstanceId": "string",
"uploaded": "string"
}
],
"conversationId": "string"
}
ConversationCobrowseSessionDataMessage
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
cobrowseSessions | [CobrowseSessionDataMessage] | false | none | none |
conversationId | string | false | none | none |
ConversationMessage
{
"applicationId": "string",
"chatTranscript": {
"created": "2019-08-24T14:15:22Z",
"id": "string",
"location": "string"
},
"conversationId": "string",
"duration": "string",
"provider": "AMAZON_S3",
"recordings": [
{
"audio": true,
"conferenceId": "string",
"recorderId": "string",
"recovered": "string",
"started": "string",
"stopped": "string",
"streams": [
{
"started": "string",
"stopped": "string",
"streamId": "string",
"tracks": [
{
"started": "string",
"stopped": "string",
"storage": {
"location": "string",
"size": "string",
"uploaded": "string"
},
"type": "AUDIO"
}
],
"type": "CAM",
"userId": "string"
}
],
"video": true
}
]
}
ConversationMessage
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
applicationId | string | false | none | none |
chatTranscript | ChatTranscriptData | false | none | none |
conversationId | string | false | none | none |
duration | string | false | none | none |
provider | string | false | none | none |
recordings | [ConversationRecordingData] | false | none | none |
Enumerated Values
Property | Value |
---|---|
provider | AMAZON_S3 |
provider | AZURE_BLOB |
provider | GOOGLE_CLOUD |
provider | SFTP_STORAGE |
ConversationRecordingData
{
"audio": true,
"conferenceId": "string",
"recorderId": "string",
"recovered": "string",
"started": "string",
"stopped": "string",
"streams": [
{
"started": "string",
"stopped": "string",
"streamId": "string",
"tracks": [
{
"started": "string",
"stopped": "string",
"storage": {
"location": "string",
"size": "string",
"uploaded": "string"
},
"type": "AUDIO"
}
],
"type": "CAM",
"userId": "string"
}
],
"video": true
}
ConversationRecordingData
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
audio | boolean | false | none | none |
conferenceId | string | false | none | none |
recorderId | string | false | none | none |
recovered | string | false | none | none |
started | string | false | none | none |
stopped | string | false | none | none |
streams | [ConversationStreamData] | false | none | none |
video | boolean | false | none | none |
ConversationStreamData
{
"started": "string",
"stopped": "string",
"streamId": "string",
"tracks": [
{
"started": "string",
"stopped": "string",
"storage": {
"location": "string",
"size": "string",
"uploaded": "string"
},
"type": "AUDIO"
}
],
"type": "CAM",
"userId": "string"
}
ConversationStreamData
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
started | string | false | none | none |
stopped | string | false | none | none |
streamId | string | false | none | none |
tracks | [ConversationTrackData] | false | none | none |
type | string | false | none | none |
userId | string | false | none | none |
Enumerated Values
Property | Value |
---|---|
type | CAM |
type | HOLD |
type | MIC |
type | SCREEN |
type | UNKNOWN |
type | VIDEO |
ConversationTrackData
{
"started": "string",
"stopped": "string",
"storage": {
"location": "string",
"size": "string",
"uploaded": "string"
},
"type": "AUDIO"
}
ConversationTrackData
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
started | string | false | none | none |
stopped | string | false | none | none |
storage | ConversationTrackStorageData | false | none | none |
type | string | false | none | none |
Enumerated Values
Property | Value |
---|---|
type | AUDIO |
type | VIDEO |
ConversationTrackStorageData
{
"location": "string",
"size": "string",
"uploaded": "string"
}
ConversationTrackStorageData
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
location | string | false | none | none |
size | string | false | none | none |
uploaded | string | false | none | none |
Error
{
"code": "string",
"message": "string",
"occurred": "string"
}
Error
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
code | string | false | none | none |
message | string | false | none | none |
occurred | string | false | none | none |
InputStream
{}
InputStream
Properties
None
LocalFileDataMessage
{
"created": "string",
"deleted": "string",
"error": {
"code": "string",
"message": "string",
"occurred": "string"
},
"location": "string"
}
LocalFileDataMessage
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
created | string | false | none | none |
deleted | string | false | none | none |
error | Error | false | none | none |
location | string | false | none | none |
RecordingDataEvent
{
"conversationId": "string",
"error": {
"code": "string",
"message": "string",
"occurred": "string"
},
"instanceId": "string",
"recorderId": "string",
"state": "ABORTED"
}
RecordingDataEvent
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
conversationId | string | false | none | none |
error | Error | false | none | none |
instanceId | string | false | none | none |
recorderId | string | false | none | none |
state | string | false | none | none |
Enumerated Values
Property | Value |
---|---|
state | ABORTED |
state | ACTIVE |
state | FAILED |
state | INITIALISED |
state | PENDING_RECOVERY |
state | STOPPED |
RecordingDataMessage
{
"audio": true,
"chatTranscript": {
"created": "2019-08-24T14:15:22Z",
"id": "string",
"location": "string"
},
"conferenceId": "string",
"conversationId": "string",
"error": {
"code": "string",
"message": "string",
"occurred": "string"
},
"instanceId": "string",
"organizationId": "string",
"recorderId": "string",
"recovered": "string",
"started": "string",
"state": "ABORTED",
"stopped": "string",
"storageProfile": {
"applicationId": "string",
"provider": "AMAZON_S3",
"url": "string"
},
"streams": [
{
"id": "string",
"state": "FAILED",
"tracks": [
{
"id": "string",
"started": "string",
"stopped": "string",
"storage": {
"localStorage": {
"created": "string",
"deleted": "string",
"error": {
"code": "string",
"message": "string",
"occurred": "string"
},
"location": "string"
},
"objectStorage": {
"error": {
"code": "string",
"message": "string",
"occurred": "string"
},
"location": "string",
"size": "string",
"uploaded": "string"
}
},
"type": "AUDIO",
"url": "string"
}
],
"type": "CAM",
"userId": "string"
}
],
"video": true
}
RecordingDataMessage
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
audio | boolean | false | none | none |
chatTranscript | ChatTranscriptData | false | none | none |
conferenceId | string | false | none | none |
conversationId | string | false | none | none |
error | Error | false | none | none |
instanceId | string | false | none | none |
organizationId | string | false | none | none |
recorderId | string | false | none | none |
recovered | string | false | none | none |
started | string | false | none | none |
state | string | false | none | none |
stopped | string | false | none | none |
storageProfile | StorageProfileDataMessage | false | none | none |
streams | [StreamDataMessage] | false | none | none |
video | boolean | false | none | none |
Enumerated Values
Property | Value |
---|---|
state | ABORTED |
state | ACTIVE |
state | FAILED |
state | INITIALISED |
state | PENDING_RECOVERY |
state | STOPPED |
Resource
{
"description": "string",
"file": null,
"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 | file | 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 |
StartRecording
{
"applicationId": "string",
"audio": true,
"conferenceId": "string",
"conversationId": "string",
"video": true
}
StartRecording
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
applicationId | string | true | none | none |
audio | boolean | false | none | none |
conferenceId | string | true | none | none |
conversationId | string | true | none | none |
video | boolean | false | none | none |
StorageProfileDataMessage
{
"applicationId": "string",
"provider": "AMAZON_S3",
"url": "string"
}
StorageProfileDataMessage
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
applicationId | string | false | none | none |
provider | string | false | none | none |
url | string | false | none | none |
Enumerated Values
Property | Value |
---|---|
provider | AMAZON_S3 |
provider | AZURE_BLOB |
provider | GOOGLE_CLOUD |
provider | SFTP_STORAGE |
StorageTestResult
{
"message": "string",
"passed": true
}
StorageTestResult
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
message | string | false | none | none |
passed | boolean | false | none | none |
StorageVerificationStatusMessage
{
"bucketTestResult": {
"message": "string",
"passed": true
},
"deleteTestResult": {
"message": "string",
"passed": true
},
"modifyTestResult": {
"message": "string",
"passed": true
},
"readTestResult": {
"message": "string",
"passed": true
},
"writeTestResult": {
"message": "string",
"passed": true
}
}
StorageVerificationStatusMessage
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
bucketTestResult | StorageTestResult | false | none | none |
deleteTestResult | StorageTestResult | false | none | none |
modifyTestResult | StorageTestResult | false | none | none |
readTestResult | StorageTestResult | false | none | none |
writeTestResult | StorageTestResult | false | none | none |
StreamDataMessage
{
"id": "string",
"state": "FAILED",
"tracks": [
{
"id": "string",
"started": "string",
"stopped": "string",
"storage": {
"localStorage": {
"created": "string",
"deleted": "string",
"error": {
"code": "string",
"message": "string",
"occurred": "string"
},
"location": "string"
},
"objectStorage": {
"error": {
"code": "string",
"message": "string",
"occurred": "string"
},
"location": "string",
"size": "string",
"uploaded": "string"
}
},
"type": "AUDIO",
"url": "string"
}
],
"type": "CAM",
"userId": "string"
}
StreamDataMessage
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | string | false | none | none |
state | string | false | none | none |
tracks | [TrackDataMessage] | false | none | none |
type | string | false | none | none |
userId | string | false | none | none |
Enumerated Values
Property | Value |
---|---|
state | FAILED |
state | RECORDING |
state | STOPPED |
type | CAM |
type | HOLD |
type | MIC |
type | SCREEN |
type | UNKNOWN |
type | VIDEO |
TrackDataMessage
{
"id": "string",
"started": "string",
"stopped": "string",
"storage": {
"localStorage": {
"created": "string",
"deleted": "string",
"error": {
"code": "string",
"message": "string",
"occurred": "string"
},
"location": "string"
},
"objectStorage": {
"error": {
"code": "string",
"message": "string",
"occurred": "string"
},
"location": "string",
"size": "string",
"uploaded": "string"
}
},
"type": "AUDIO",
"url": "string"
}
TrackDataMessage
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | string | false | none | none |
started | string | false | none | none |
stopped | string | false | none | none |
storage | TrackStorageDataMessage | false | none | none |
type | string | false | none | none |
url | string | false | none | none |
Enumerated Values
Property | Value |
---|---|
type | AUDIO |
type | VIDEO |
TrackStorageDataMessage
{
"localStorage": {
"created": "string",
"deleted": "string",
"error": {
"code": "string",
"message": "string",
"occurred": "string"
},
"location": "string"
},
"objectStorage": {
"error": {
"code": "string",
"message": "string",
"occurred": "string"
},
"location": "string",
"size": "string",
"uploaded": "string"
}
}
TrackStorageDataMessage
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
localStorage | LocalFileDataMessage | false | none | none |
objectStorage | UploadDataMessage | false | none | none |
URLResourceMessage
{
"url": "https://storage.googleapis.com/bucket/6e6d5224-1919-48fa-a982-66cef9fa4c08/7edf1e1e-0109-4d92-9bad-ab43059a28e3/ca900103-16d3-4b34-884a-003fd8b8e9ca/7edf1e1e-0109-4d92-9bad-ab43059a28e3.mp4?GoogleAccessId=rtc-recorder-gcs@auvious.iam.gserviceaccount.com&Expires=1610649825&Signature=t2f4bXWN842Z7eHHVKaMZs1KHUzcqX8EXX4QoaWinjcKrMcq1AnADJ7iV2MjLgScnJFhlFYiFosHiLNUSqbjuar9IKEtH9JTyLdvkljEzBPPrkvZ5X0XIi5%2FsEQTekwdzKmTjjGRUZWCix%2FIMbizCl0qnX6Tpi%2BbKhTD7u9PjXk1PEum2P2siAnB0s8D9sow6IDuH8%2FrKYMjCe3jb2P%2Fi6asce9xOwmNjW7lxnyLMAeydxCWyZ66kcas0wXZ5BillG%2BA9NvqvnBXKQrGV5im6%2FnleElz9JhcFS%2B2U5suXt9tok3SScbgMvSWfLQ0PyttJuKtQ%2FxTzUnvGOc5WGkTNg%3D%3D",
"validUntil": "2021-01-14T18:43:45.569343Z"
}
URLResourceMessage
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
url | string(url) | false | none | A signed URL of a given resource. |
validUntil | string | false | none | The date until the given URL will remain valid. |
UploadDataMessage
{
"error": {
"code": "string",
"message": "string",
"occurred": "string"
},
"location": "string",
"size": "string",
"uploaded": "string"
}
UploadDataMessage
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
error | Error | false | none | none |
location | string | false | none | none |
size | string | false | none | none |
uploaded | string | false | none | none |