Interaction v1.0

This API enables storing information about customer interactions, which can be used later mainly for reporting purposes.

info

You are viewing REST API documentation. This documentation is auto-generated from a swagger specification which itself is generated from annotations in the source code of the project. It is possible that this documentation includes bugs and that code samples are incomplete or wrong.

Authentication

OAuth 2.0 Authorization. Authenticate using client credentials
- Flow: clientCredentials
- OAuth 2.0 Authorization URL = https://auvious.video/security/oauth/authorize
- OAuth 2.0 Token URL = https://auvious.video/security/oauth/token
- OAuth 2.0 Scope
  Scope Scope Description
  any this is the default
HTTP Authentication, scheme: bearer jwt bearer token access

Scope	Scope Description
any	this is the default

Interaction

Interaction Controller

Retrieve interactions by date range

GET https://auvious.video:443/rtc-api/interactions?start=2019-08-24T14%3A15%3A22Z&end=2019-08-24T14%3A15%3A22Z&property1=string&property2=string HTTP/1.1
Host: auvious.video:443
Accept: application/json

Parameters

Parameter	In	Type	Required	Description
offset	query	integer(int64)	false	none
pageNumber	query	integer(int32)	false	none
pageSize	query	integer(int32)	false	none
paged	query	boolean	false	none
sort.sorted	query	boolean	false	none
sort.unsorted	query	boolean	false	none
unpaged	query	boolean	false	none
start	query	string(date-time)	true	start
end	query	string(date-time)	true	end
params	query	object	true	params

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	Page«Interaction»
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	None
404	Not Found	Not Found	None

Examples

200 Response

{
  "content": [
    {
      "createdAt": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "data": {},
      "id": "string",
      "organizationId": "string",
      "type": "string",
      "version": 0
    }
  ],
  "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: Client Credentials Flow ( Scopes: global ), Jwt ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global )

Code samples

curl -X GET https://auvious.video:443/rtc-api/interactions?start=2019-08-24T14%3A15%3A22Z&end=2019-08-24T14%3A15%3A22Z&property1=string&property2=string \
  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

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

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

fetch('https://auvious.video:443/rtc-api/interactions?start=2019-08-24T14%3A15%3A22Z&end=2019-08-24T14%3A15%3A22Z&property1=string&property2=string', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("https://auvious.video:443/rtc-api/interactions?start=2019-08-24T14%3A15%3A22Z&end=2019-08-24T14%3A15%3A22Z&property1=string&property2=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': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get(
  'https://auvious.video:443/rtc-api/interactions',
  params={
    'start': '2019-08-24T14:15:22Z',
    'end': '2019-08-24T14:15:22Z',
    'params': {
  "property1": "string",
  "property2": "string"
}},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://auvious.video:443/rtc-api/interactions',
  params: {
    'start' => 'string(date-time)',
    'end' => 'string(date-time)',
    'params' => 'object'}, headers: headers

p JSON.parse(result)

Create a new interaction

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

Request body

{
  "data": {},
  "interactionId": "string",
  "type": "string"
}

Parameters

Parameter	In	Type	Required	Description
body	body	CreateInteractionWebCommand	false	none

Responses

Overview

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

Examples

200 Response

{
  "interactionId": "string"
}

caution

Code samples

curl -X POST https://auvious.video:443/rtc-api/interactions \
  -H 'Content-Type: application/json' \  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

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

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

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

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

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

fetch('https://auvious.video:443/rtc-api/interactions', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("https://auvious.video:443/rtc-api/interactions");

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': 'Bearer {access-token}'
}

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

print r.json()

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

Retrieve an existing interaction by it's id

GET https://auvious.video:443/rtc-api/interactions/{interactionId} HTTP/1.1
Host: auvious.video:443
Accept: application/json

Parameters

Parameter	In	Type	Required	Description
interactionId	path	string	true	interactionId

Responses

Overview

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

Examples

200 Response

{
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "data": {},
  "id": "string",
  "organizationId": "string",
  "type": "string",
  "version": 0
}

caution

Code samples

curl -X GET https://auvious.video:443/rtc-api/interactions/{interactionId} \
  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

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

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

fetch('https://auvious.video:443/rtc-api/interactions/{interactionId}', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("https://auvious.video:443/rtc-api/interactions/{interactionId}");

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': 'Bearer {access-token}'
}

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

print r.json()

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

Update an existing interaction

PUT https://auvious.video:443/rtc-api/interactions/{interactionId} HTTP/1.1
Host: auvious.video:443
Content-Type: application/json

Request body

{
  "data": {},
  "type": "string"
}

Parameters

Parameter	In	Type	Required	Description
interactionId	path	string	true	interactionId
body	body	UpdateInteractionWebCommand	false	none

Responses

Overview

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

caution

Code samples

curl -X PUT https://auvious.video:443/rtc-api/interactions/{interactionId} \
  -H 'Content-Type: application/json' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

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

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

    req, err := http.NewRequest("PUT", "https://auvious.video:443/rtc-api/interactions/{interactionId}", bytes.NewBuffer(body))
    req.Header = headers

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

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

fetch('https://auvious.video:443/rtc-api/interactions/{interactionId}', {
  method: 'PUT',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("https://auvious.video:443/rtc-api/interactions/{interactionId}");

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

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

import requests

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

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

print r.json()

require 'rest-client'
require 'json'

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

result = RestClient.put 'https://auvious.video:443/rtc-api/interactions/{interactionId}',
  params: {}, headers: headers

p JSON.parse(result)

Schemas

CreateInteractionResponse

{
  "interactionId": "string"
}

CreateInteractionResponse

Properties

Name	Type	Required	Restrictions	Description
interactionId	string	false	none	none

CreateInteractionWebCommand

{
  "data": {},
  "interactionId": "string",
  "type": "string"
}

CreateInteractionWebCommand

Properties

Name	Type	Required	Restrictions	Description
data	object	false	none	interaction data, this is the place to store arbitrary data that might be needed later
interactionId	string	false	none	interaction id, can be supplied to match integration party e.g. Genesys Cloud interaction/conversation id
type	string	false	none	type of interaction, e.g. video call

Interaction

{
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "data": {},
  "id": "string",
  "organizationId": "string",
  "type": "string",
  "version": 0
}

Interaction

Properties

Name	Type	Required	Restrictions	Description
createdAt	string(date-time)	false	none	creation timestamp
createdBy	string	false	none	creation user id
data	object	false	none	interaction data
id	string	false	none	interaction id
organizationId	string	false	none	organization id
type	string	false	none	interaction type
version	integer(int64)	false	none	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

Page«Interaction»

{
  "content": [
    {
      "createdAt": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "data": {},
      "id": "string",
      "organizationId": "string",
      "type": "string",
      "version": 0
    }
  ],
  "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«Interaction»

Properties

Name	Type	Required	Restrictions	Description
content	[Interaction]	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

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

UpdateInteractionWebCommand

{
  "data": {},
  "type": "string"
}

UpdateInteractionWebCommand

Properties

Name	Type	Required	Restrictions	Description
data	object	false	none	interaction data, this is the place to store arbitrary data that might be needed later, if omitted it won't be updated. Careful with this, when supplied it all data will be replaced
type	string	false	none	type of interaction, e.g. video call if omitted it wont be updated

Authentication​

Interaction​

Retrieve interactions by date range​

Parameters​

Responses​

Overview​

Examples​

Code samples​

Create a new interaction​

Request body​

Parameters​

Responses​

Overview​

Examples​

Code samples​

Retrieve an existing interaction by it's id​

Parameters​

Responses​

Overview​

Examples​

Code samples​

Update an existing interaction​

Request body​

Parameters​

Responses​

Overview​

Code samples​

Schemas​

CreateInteractionResponse​

Properties​

CreateInteractionWebCommand​

Properties​

Interaction​

Properties​

Pageable​

Properties​

Page«Interaction»​

Properties​

Sort​

Properties​

UpdateInteractionWebCommand​

Properties​

Authentication

Interaction

Retrieve interactions by date range

Parameters

Responses

Overview

Examples

Code samples

Create a new interaction

Request body

Parameters

Responses

Overview

Examples

Code samples

Retrieve an existing interaction by it's id

Parameters

Responses

Overview

Examples

Code samples

Update an existing interaction

Request body

Parameters

Responses

Overview

Code samples

Schemas

CreateInteractionResponse

Properties

CreateInteractionWebCommand

Properties

Interaction

Properties

Pageable

Properties

Page«Interaction»

Properties

Sort

Properties

UpdateInteractionWebCommand

Properties