Auvious Composition API v1.0

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

API Key (apiKey)
- Parameter Name: Authorization, in: header.

Composition Command Service

Composition Command Controller

Re-execute a previously completed composition

POST /auvious.video/composition/api/reexecute HTTP/1.1
Content-Type: application/json
Accept: application/json

Supported roles (AGENT, SUPERVISOR)

Request body

{
  "conversationId": "string",
  "id": "string",
  "priority": 0
}

Parameters

Parameter	In	Type	Required	Description
body	body	ReExecuteCompositionWebCommand	true	webCommand

Responses

Overview

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

Examples

{
  "conversationId": "string",
  "id": "string"
}

caution

To perform this operation, you must be authenticated by means of one of the following methods: apiKey ( Scopes: global )

Code samples

curl -X POST /auvious.video/composition/api/reexecute \
  -H 'Content-Type: application/json' \  -H 'Accept: application/json' \  -H 'Authorization: API_KEY'

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

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

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

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

const fetch = require('node-fetch');
const input = '{
  "conversationId": "string",
  "id": "string",
  "priority": 0
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': 'application/json',  'Authorization': 'API_KEY'
}

fetch('/auvious.video/composition/api/reexecute', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("/auvious.video/composition/api/reexecute");

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': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post(
  '/auvious.video/composition/api/reexecute',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post '/auvious.video/composition/api/reexecute',
  params: {}, headers: headers

p JSON.parse(result)

Create a new Composition

POST /auvious.video/composition/api/request HTTP/1.1
Content-Type: application/json
Accept: application/json

Supported roles (AGENT, SUPERVISOR, SERVICE)

Request body

{
  "audioFormat": "MP3",
  "conversationId": "string",
  "layout": "GRID",
  "name": "string",
  "priority": 0,
  "resolution": "320x240",
  "type": "AUDIO",
  "videoFormat": "MP4"
}

Parameters

Parameter	In	Type	Required	Description
body	body	CreateCompositionWebCommand	true	webCommand

Responses

Overview

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

Examples

{
  "conversationId": "string",
  "id": "string"
}

caution

To perform this operation, you must be authenticated by means of one of the following methods: apiKey ( Scopes: global )

Code samples

curl -X POST /auvious.video/composition/api/request \
  -H 'Content-Type: application/json' \  -H 'Accept: application/json' \  -H 'Authorization: API_KEY'

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

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

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

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

const fetch = require('node-fetch');
const input = '{
  "audioFormat": "MP3",
  "conversationId": "string",
  "layout": "GRID",
  "name": "string",
  "priority": 0,
  "resolution": "320x240",
  "type": "AUDIO",
  "videoFormat": "MP4"
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': 'application/json',  'Authorization': 'API_KEY'
}

fetch('/auvious.video/composition/api/request', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("/auvious.video/composition/api/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());

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post(
  '/auvious.video/composition/api/request',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post '/auvious.video/composition/api/request',
  params: {}, headers: headers

p JSON.parse(result)

Cancel a running Composition

POST /auvious.video/composition/api/{conversationId}/{compositionId}/cancel HTTP/1.1
Accept: */*

Supported roles (AGENT, SUPERVISOR)

Parameters

Parameter	In	Type	Required	Description
compositionId	path	string	true	compositionId
conversationId	path	string	true	conversationId

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

caution

To perform this operation, you must be authenticated by means of one of the following methods: apiKey ( Scopes: global )

Code samples

curl -X POST /auvious.video/composition/api/{conversationId}/{compositionId}/cancel \
  -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/composition/api/{conversationId}/{compositionId}/cancel", 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/composition/api/{conversationId}/{compositionId}/cancel', {
  method: 'POST',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("/auvious.video/composition/api/{conversationId}/{compositionId}/cancel");

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/composition/api/{conversationId}/{compositionId}/cancel',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'API_KEY'
}

result = RestClient.post '/auvious.video/composition/api/{conversationId}/{compositionId}/cancel',
  params: {}, headers: headers

p JSON.parse(result)

Delete existing Composition

DELETE /auvious.video/composition/api/{conversationId}/{compositionId}/delete HTTP/1.1
Accept: */*

Supported roles (SUPERVISOR)

Parameters

Parameter	In	Type	Required	Description
compositionId	path	string	true	compositionId
conversationId	path	string	true	conversationId

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	Inline
204	No Content	No Content	None
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	None

Response Schema

Examples

caution

To perform this operation, you must be authenticated by means of one of the following methods: apiKey ( Scopes: global )

Code samples

curl -X DELETE /auvious.video/composition/api/{conversationId}/{compositionId}/delete \
  -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("DELETE", "/auvious.video/composition/api/{conversationId}/{compositionId}/delete", 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/composition/api/{conversationId}/{compositionId}/delete', {
  method: 'DELETE',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("/auvious.video/composition/api/{conversationId}/{compositionId}/delete");

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

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.delete(
  '/auvious.video/composition/api/{conversationId}/{compositionId}/delete',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'API_KEY'
}

result = RestClient.delete '/auvious.video/composition/api/{conversationId}/{compositionId}/delete',
  params: {}, headers: headers

p JSON.parse(result)

Composition Media Player

Composition Media Controller

getAttachment

GET /auvious.video/composition/api/player/attachment/{conversationId}/{compositionId}/{fileName}?Date=string&Expires=string&Signature=string HTTP/1.1
Accept: */*
Range: string

Parameters

Parameter	In	Type	Required	Description
compositionId	path	string	true	compositionId
conversationId	path	string	true	conversationId
Date	query	string	true	Date
Expires	query	string	true	Expires
fileName	path	string	true	fileName
Range	header	string	false	Range
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

caution

To perform this operation, you must be authenticated by means of one of the following methods: apiKey ( Scopes: global )

Code samples

curl -X GET /auvious.video/composition/api/player/attachment/{conversationId}/{compositionId}/{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/composition/api/player/attachment/{conversationId}/{compositionId}/{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/composition/api/player/attachment/{conversationId}/{compositionId}/{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/composition/api/player/attachment/{conversationId}/{compositionId}/{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/composition/api/player/attachment/{conversationId}/{compositionId}/{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/composition/api/player/attachment/{conversationId}/{compositionId}/{fileName}',
  params: {
    'Date' => 'string',
    'Expires' => 'string',
    'Signature' => 'string'}, headers: headers

p JSON.parse(result)

getInline

GET /auvious.video/composition/api/player/inline/{conversationId}/{compositionId}/{fileName}?Date=string&Expires=string&Signature=string HTTP/1.1
Accept: */*
Range: string

Parameters

Parameter	In	Type	Required	Description
compositionId	path	string	true	compositionId
conversationId	path	string	true	conversationId
Date	query	string	true	Date
Expires	query	string	true	Expires
fileName	path	string	true	fileName
Range	header	string	false	Range
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

caution

To perform this operation, you must be authenticated by means of one of the following methods: apiKey ( Scopes: global )

Code samples

curl -X GET /auvious.video/composition/api/player/inline/{conversationId}/{compositionId}/{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/composition/api/player/inline/{conversationId}/{compositionId}/{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/composition/api/player/inline/{conversationId}/{compositionId}/{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/composition/api/player/inline/{conversationId}/{compositionId}/{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/composition/api/player/inline/{conversationId}/{compositionId}/{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/composition/api/player/inline/{conversationId}/{compositionId}/{fileName}',
  params: {
    'Date' => 'string',
    'Expires' => 'string',
    'Signature' => 'string'}, headers: headers

p JSON.parse(result)

Get a signed URL to download a media file by conversation id and composition Id

GET /auvious.video/composition/api/player/{conversationId}/{compositionId}/url/attachment?conversationId=string&id=string HTTP/1.1
Accept: */*
Referer: string

Supported roles (AGENT, SUPERVISOR)

Parameters

Parameter	In	Type	Required	Description
conversationId	query	string	true	none
id	query	string	true	none
Referer	header	string	true	Referer

Responses

Overview

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

Examples

caution

To perform this operation, you must be authenticated by means of one of the following methods: apiKey ( Scopes: global )

Code samples

curl -X GET /auvious.video/composition/api/player/{conversationId}/{compositionId}/url/attachment?conversationId=string&id=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/composition/api/player/{conversationId}/{compositionId}/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/composition/api/player/{conversationId}/{compositionId}/url/attachment?conversationId=string&id=string', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("/auvious.video/composition/api/player/{conversationId}/{compositionId}/url/attachment?conversationId=string&id=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/composition/api/player/{conversationId}/{compositionId}/url/attachment',
  params={
    'conversationId': 'string',
    'id': 'string'},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Referer' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get '/auvious.video/composition/api/player/{conversationId}/{compositionId}/url/attachment',
  params: {
    'conversationId' => 'string',
    'id' => 'string'}, headers: headers

p JSON.parse(result)

Get a signed URL to play a media file by conversation id and composition Id

GET /auvious.video/composition/api/player/{conversationId}/{compositionId}/url/inline?conversationId=string&id=string HTTP/1.1
Accept: */*
Referer: string

Supported roles (AGENT, SUPERVISOR)

Parameters

Parameter	In	Type	Required	Description
conversationId	query	string	true	none
id	query	string	true	none
Referer	header	string	true	Referer

Responses

Overview

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

Examples

caution

To perform this operation, you must be authenticated by means of one of the following methods: apiKey ( Scopes: global )

Code samples

curl -X GET /auvious.video/composition/api/player/{conversationId}/{compositionId}/url/inline?conversationId=string&id=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/composition/api/player/{conversationId}/{compositionId}/url/inline", 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/composition/api/player/{conversationId}/{compositionId}/url/inline?conversationId=string&id=string', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("/auvious.video/composition/api/player/{conversationId}/{compositionId}/url/inline?conversationId=string&id=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/composition/api/player/{conversationId}/{compositionId}/url/inline',
  params={
    'conversationId': 'string',
    'id': 'string'},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Referer' => 'string',
  'Authorization' => 'API_KEY'
}

result = RestClient.get '/auvious.video/composition/api/player/{conversationId}/{compositionId}/url/inline',
  params: {
    'conversationId' => 'string',
    'id' => 'string'}, headers: headers

p JSON.parse(result)

Composition Query Service

Composition Query Controller

Get all compositions initiated by the currently authenticated user

GET /auvious.video/composition/api/query/composition HTTP/1.1
Accept: application/json

Supported roles (AGENT, SUPERVISOR)

Parameters

Parameter	In	Type	Required	Description
offset	query	integer(int64)	false	none
paged	query	boolean	false	none
pageNumber	query	integer(int32)	false	none
pageSize	query	integer(int32)	false	none
sort.sorted	query	boolean	false	none
sort.unsorted	query	boolean	false	none
unpaged	query	boolean	false	none

Responses

Overview

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

Examples

{
  "content": [
    {
      "completed": "string",
      "conversationId": "string",
      "created": "string",
      "duration": "string",
      "format": "string",
      "id": "string",
      "layout": "GRID",
      "name": "string",
      "state": "string",
      "type": "string",
      "userId": "string"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}

caution

To perform this operation, you must be authenticated by means of one of the following methods: apiKey ( Scopes: global )

Code samples

curl -X GET /auvious.video/composition/api/query/composition \
  -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/composition/api/query/composition", 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/composition/api/query/composition', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("/auvious.video/composition/api/query/composition");

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/composition/api/query/composition',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get '/auvious.video/composition/api/query/composition',
  params: {}, headers: headers

p JSON.parse(result)

Get recording data and associated composition by conversationId

GET /auvious.video/composition/api/query/conversation/{conversationId} HTTP/1.1
Accept: application/json

Supported roles (AGENT, SUPERVISOR)

Parameters

Parameter	In	Type	Required	Description
conversationId	path	string	true	conversationId

Responses

Overview

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

Examples

{
  "compositions": [
    {
      "completed": "string",
      "conversationId": "string",
      "created": "string",
      "duration": "string",
      "format": "string",
      "id": "string",
      "layout": "GRID",
      "name": "string",
      "state": "string",
      "type": "string",
      "userId": "string"
    }
  ],
  "recordingMetadata": {
    "agentId": "string",
    "audio": true,
    "canExportAudio": true,
    "canExportVideo": true,
    "conversationId": "string",
    "duration": "string",
    "organizationId": "string",
    "started": "string",
    "stopped": "string",
    "totalParticipants": 0,
    "video": true
  }
}

caution

To perform this operation, you must be authenticated by means of one of the following methods: apiKey ( Scopes: global )

Code samples

curl -X GET /auvious.video/composition/api/query/conversation/{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/composition/api/query/conversation/{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/composition/api/query/conversation/{conversationId}', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("/auvious.video/composition/api/query/conversation/{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/composition/api/query/conversation/{conversationId}',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get '/auvious.video/composition/api/query/conversation/{conversationId}',
  params: {}, headers: headers

p JSON.parse(result)

Schemas

ComposedRecordingDataMessage

{
  "agentId": "string",
  "audio": true,
  "canExportAudio": true,
  "canExportVideo": true,
  "conversationId": "string",
  "duration": "string",
  "organizationId": "string",
  "started": "string",
  "stopped": "string",
  "totalParticipants": 0,
  "video": true
}

ComposedRecordingDataMessage

Properties

Name	Type	Required	Restrictions	Description
agentId	string	false	none	none
audio	boolean	false	none	none
canExportAudio	boolean	false	none	none
canExportVideo	boolean	false	none	none
conversationId	string	false	none	none
duration	string	false	none	none
organizationId	string	false	none	none
started	string	false	none	none
stopped	string	false	none	none
totalParticipants	integer(int32)	false	none	none
video	boolean	false	none	none

CompositionIdentifier

{
  "conversationId": "string",
  "id": "string"
}

CompositionIdentifier

Properties

Name	Type	Required	Restrictions	Description
conversationId	string	true	none	none
id	string	true	none	none

CompositionMessage

{
  "compositions": [
    {
      "completed": "string",
      "conversationId": "string",
      "created": "string",
      "duration": "string",
      "format": "string",
      "id": "string",
      "layout": "GRID",
      "name": "string",
      "state": "string",
      "type": "string",
      "userId": "string"
    }
  ],
  "recordingMetadata": {
    "agentId": "string",
    "audio": true,
    "canExportAudio": true,
    "canExportVideo": true,
    "conversationId": "string",
    "duration": "string",
    "organizationId": "string",
    "started": "string",
    "stopped": "string",
    "totalParticipants": 0,
    "video": true
  }
}

CompositionMessage

Properties

Name	Type	Required	Restrictions	Description
compositions	[CompositionView]	false	none	none
recordingMetadata	ComposedRecordingDataMessage	false	none	none

CompositionResourceMessage

{
  "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"
}

CompositionResourceMessage

Properties

Name	Type	Required	Restrictions	Description
url	string(url)	false	none	A signed URL of the given resource.
validUntil	string	false	none	The date until this URL will remain valid.

CompositionView

{
  "completed": "string",
  "conversationId": "string",
  "created": "string",
  "duration": "string",
  "format": "string",
  "id": "string",
  "layout": "GRID",
  "name": "string",
  "state": "string",
  "type": "string",
  "userId": "string"
}

CompositionView

Properties

Name	Type	Required	Restrictions	Description
completed	string	false	none	none
conversationId	string	false	none	none
created	string	false	none	none
duration	string	false	none	none
format	string	false	none	none
id	string	false	none	none
layout	string	false	none	none
name	string	false	none	none
state	string	false	none	none
type	string	false	none	none
userId	string	false	none	none

Enumerated Values

Property	Value
layout	GRID

CreateCompositionWebCommand

{
  "audioFormat": "MP3",
  "conversationId": "string",
  "layout": "GRID",
  "name": "string",
  "priority": 0,
  "resolution": "320x240",
  "type": "AUDIO",
  "videoFormat": "MP4"
}

CreateCompositionWebCommand

Properties

Name	Type	Required	Restrictions	Description
audioFormat	string	false	none	Default value: MP3
conversationId	string	true	none	none
layout	string	true	none	none
name	string	true	none	none
priority	integer(int32)	false	none	Default value: 1
resolution	string	true	none	none
type	string	true	none	none
videoFormat	string	false	none	Default value: MP4

Enumerated Values

Property	Value
audioFormat	MP3
layout	GRID
resolution	320x240
type	AUDIO
type	VIDEO
videoFormat	MP4

InputStream

{}

InputStream

Properties

None

Pageable

{
  "offset": 0,
  "pageNumber": 0,
  "pageSize": 0,
  "paged": true,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "unpaged": true
}

Pageable

Properties

Name	Type	Required	Restrictions	Description
offset	integer(int64)	false	none	none
pageNumber	integer(int32)	false	none	none
pageSize	integer(int32)	false	none	none
paged	boolean	false	none	none
sort	Sort	false	none	none
unpaged	boolean	false	none	none

ReExecuteCompositionWebCommand

{
  "conversationId": "string",
  "id": "string",
  "priority": 0
}

ReExecuteCompositionWebCommand

Properties

Name	Type	Required	Restrictions	Description
conversationId	string	true	none	none
id	string	true	none	none
priority	integer(int32)	false	none	Default value: 1

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

Sort

{
  "empty": true,
  "sorted": true,
  "unsorted": true
}

Sort

Properties

Name	Type	Required	Restrictions	Description
empty	boolean	false	none	none
sorted	boolean	false	none	none
unsorted	boolean	false	none	none

PageCompositionView

{
  "content": [
    {
      "completed": "string",
      "conversationId": "string",
      "created": "string",
      "duration": "string",
      "format": "string",
      "id": "string",
      "layout": "GRID",
      "name": "string",
      "state": "string",
      "type": "string",
      "userId": "string"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}

Page«CompositionView»

Properties

Name	Type	Required	Restrictions	Description
content	[CompositionView]	false	none	none
empty	boolean	false	none	none
first	boolean	false	none	none
last	boolean	false	none	none
number	integer(int32)	false	none	none
numberOfElements	integer(int32)	false	none	none
pageable	Pageable	false	none	none
size	integer(int32)	false	none	none
sort	Sort	false	none	none
totalElements	integer(int64)	false	none	none
totalPages	integer(int32)	false	none	none

Authentication​

Composition Command Service​

Re-execute a previously completed composition​

Request body​

Parameters​

Responses​

Overview​

Examples​

Code samples​

Create a new Composition​

Request body​

Parameters​

Responses​

Overview​

Examples​

Code samples​

Cancel a running Composition​

Parameters​

Responses​

Overview​

Response Schema​

Examples​

Code samples​

Delete existing Composition​

Parameters​

Responses​

Overview​

Response Schema​

Examples​

Code samples​

Composition Media Player​

getAttachment​

Parameters​

Responses​

Overview​

Examples​

Code samples​

getInline​

Parameters​

Responses​

Overview​

Examples​

Code samples​

Get a signed URL to download a media file by conversation id and composition Id​

Parameters​

Responses​

Overview​

Examples​

Code samples​

Get a signed URL to play a media file by conversation id and composition Id​

Parameters​

Responses​

Overview​

Examples​

Code samples​

Composition Query Service​

Get all compositions initiated by the currently authenticated user​

Parameters​

Responses​

Overview​

Examples​

Code samples​

Get recording data and associated composition by conversationId​

Parameters​

Responses​

Overview​

Examples​

Code samples​

Schemas​

ComposedRecordingDataMessage​

Properties​

CompositionIdentifier​

Properties​

CompositionMessage​

Properties​

CompositionResourceMessage​

Properties​

CompositionView​

Properties​

Enumerated Values​

Authentication

Composition Command Service

Re-execute a previously completed composition

Request body

Parameters

Responses

Overview

Examples

Code samples

Create a new Composition

Request body

Parameters

Responses

Overview

Examples

Code samples

Cancel a running Composition

Parameters

Responses

Overview

Response Schema

Examples

Code samples

Delete existing Composition

Parameters

Responses

Overview

Response Schema

Examples

Code samples

Composition Media Player

getAttachment

Parameters

Responses

Overview

Examples

Code samples

getInline

Parameters

Responses

Overview

Examples

Code samples

Get a signed URL to download a media file by conversation id and composition Id

Parameters

Responses

Overview

Examples

Code samples

Get a signed URL to play a media file by conversation id and composition Id

Parameters

Responses

Overview

Examples

Code samples

Composition Query Service

Get all compositions initiated by the currently authenticated user

Parameters

Responses

Overview

Examples

Code samples

Get recording data and associated composition by conversationId

Parameters

Responses

Overview

Examples

Code samples

Schemas

ComposedRecordingDataMessage

Properties

CompositionIdentifier

Properties

CompositionMessage

Properties

CompositionResourceMessage

Properties

CompositionView

Properties

Enumerated Values