Auvious RTC API v1.9.10-beta.0

Auvious RTC API is the core set of services providing the realtime communication capabilities of the Auvious Platform.

info

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

Authentication

HTTP Authentication, scheme: bearer
OAuth 2.0 Authorization.
- Flow: clientCredentials
- OAuth 2.0 Token URL = https://auvious.video/security/oauth/token
- OAuth 2.0 Scope
  Scope Scope Description

Ratings

Create a new rating

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

Create a new rating, provide at least one of the following: rating, feedback or comment

Request body

{
  "userEndpointId": "string",
  "sessionType": "UNKNOWN",
  "sessionId": "string",
  "rating": 0,
  "comment": "string",
  "feedback": [
    {
      "question": "string",
      "type": "TEXT_300",
      "choices": [
        "string"
      ],
      "choice": "string",
      "answer": "string",
      "rating": 0
    }
  ],
  "interactionId": "string"
}

Parameters

Parameter	In	Type	Required	Description
body	body	CreateRatingWebCommand	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	CreatingRatingWebResponse
400	Bad Request	Bad Request	Inline

Response Schema

Status Code 400

Name	Type	Required	Restrictions	Description
» additionalProperties	string	false	none	none

Examples

200 Response

{
  "id": "string"
}

400 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

curl -X POST https://auvious.video/rtc-api/ratings \
  -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/rtc-api/ratings", bytes.NewBuffer(body))
    req.Header = headers

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

const fetch = require('node-fetch');
const input = '{
  "userEndpointId": "string",
  "sessionType": "UNKNOWN",
  "sessionId": "string",
  "rating": 0,
  "comment": "string",
  "feedback": [
    {
      "question": "string",
      "type": "TEXT_300",
      "choices": [
        "string"
      ],
      "choice": "string",
      "answer": "string",
      "rating": 0
    }
  ],
  "interactionId": "string"
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

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

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/rtc-api/ratings',
  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/rtc-api/ratings',
  params: {}, headers: headers

p JSON.parse(result)

Find ratings by interaction id

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

Parameters

Parameter	In	Type	Required	Description
interactionId	path	string	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad Request	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[Rating]	false	none	none
» id	string	false	none	rating id
» userId	string	false	none	the user who created this rating
» userEndpointId	string	false	none	the user endpoint from which the user created this rating
» userRole	string	false	none	the main user role ("CUSTOMER" or "AGENT")
» organizationId	string	false	none	related organization id
» interactionId	string	false	none	related interaction id
» sessionType	string	false	none	kind of session, CALL or CONFERENCE
» sessionId	string	false	none	the call or conference id related with this rating
» score	integer(int32)	false	none	the rating the user gave, scale is 1-5, 1 meaning bad and 5 perfect
» comment	string	false	none	any comment the user gave
» feedback	[FeedbackItem]	false	none	feedback items
»» question	string	false	none	the question asked or description of feedback
»» type	string	false	none	the type of feedback item
»» choices	[string]	false	none	the choices for MULTIPLE_CHOICE answers
»» choice	string	false	none	the choice for SINGLE_CHOICE feedback item type
»» answer	string	false	none	the answer for TEXT_300 or TEXT_1000 feedback item type
»» rating	integer(int32)	false	none	the rating for RATING_1_5 or RATING_1_10 feedback item type
» createdAt	string(date-time)	false	none	none

Enumerated Values

Property	Value
sessionType	UNKNOWN
sessionType	CALL
sessionType	CONFERENCE
type	TEXT_300
type	TEXT_1000
type	RATING_1_5
type	RATING_1_10
type	SINGLE_CHOICE
type	MULTIPLE_CHOICE

Status Code 400

Name	Type	Required	Restrictions	Description
» additionalProperties	string	false	none	none

Examples

200 Response

[
  {
    "id": "string",
    "userId": "string",
    "userEndpointId": "string",
    "userRole": "string",
    "organizationId": "string",
    "interactionId": "string",
    "sessionType": "UNKNOWN",
    "sessionId": "string",
    "score": 0,
    "comment": "string",
    "feedback": [
      {
        "question": "string",
        "type": "TEXT_300",
        "choices": [
          "string"
        ],
        "choice": "string",
        "answer": "string",
        "rating": 0
      }
    ],
    "createdAt": "2019-08-24T14:15:22Z"
  }
]

400 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

curl -X GET https://auvious.video/rtc-api/ratings/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/rtc-api/ratings/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/rtc-api/ratings/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/rtc-api/ratings/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/rtc-api/ratings/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/rtc-api/ratings/interactions/{interactionId}',
  params: {}, headers: headers

p JSON.parse(result)

Find ratings by conference id

GET https://auvious.video/rtc-api/ratings/conferences/{conferenceId} HTTP/1.1
Host: auvious.video
Accept: application/json

Parameters

Parameter	In	Type	Required	Description
conferenceId	path	string	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	Inline
400	Bad Request	Bad Request	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[Rating]	false	none	none
» id	string	false	none	rating id
» userId	string	false	none	the user who created this rating
» userEndpointId	string	false	none	the user endpoint from which the user created this rating
» userRole	string	false	none	the main user role ("CUSTOMER" or "AGENT")
» organizationId	string	false	none	related organization id
» interactionId	string	false	none	related interaction id
» sessionType	string	false	none	kind of session, CALL or CONFERENCE
» sessionId	string	false	none	the call or conference id related with this rating
» score	integer(int32)	false	none	the rating the user gave, scale is 1-5, 1 meaning bad and 5 perfect
» comment	string	false	none	any comment the user gave
» feedback	[FeedbackItem]	false	none	feedback items
»» question	string	false	none	the question asked or description of feedback
»» type	string	false	none	the type of feedback item
»» choices	[string]	false	none	the choices for MULTIPLE_CHOICE answers
»» choice	string	false	none	the choice for SINGLE_CHOICE feedback item type
»» answer	string	false	none	the answer for TEXT_300 or TEXT_1000 feedback item type
»» rating	integer(int32)	false	none	the rating for RATING_1_5 or RATING_1_10 feedback item type
» createdAt	string(date-time)	false	none	none

Enumerated Values

Property	Value
sessionType	UNKNOWN
sessionType	CALL
sessionType	CONFERENCE
type	TEXT_300
type	TEXT_1000
type	RATING_1_5
type	RATING_1_10
type	SINGLE_CHOICE
type	MULTIPLE_CHOICE

Status Code 400

Name	Type	Required	Restrictions	Description
» additionalProperties	string	false	none	none

Examples

200 Response

[
  {
    "id": "string",
    "userId": "string",
    "userEndpointId": "string",
    "userRole": "string",
    "organizationId": "string",
    "interactionId": "string",
    "sessionType": "UNKNOWN",
    "sessionId": "string",
    "score": 0,
    "comment": "string",
    "feedback": [
      {
        "question": "string",
        "type": "TEXT_300",
        "choices": [
          "string"
        ],
        "choice": "string",
        "answer": "string",
        "rating": 0
      }
    ],
    "createdAt": "2019-08-24T14:15:22Z"
  }
]

400 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

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

// This sample needs improvement.
URL obj = new URL("https://auvious.video/rtc-api/ratings/conferences/{conferenceId}");

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/rtc-api/ratings/conferences/{conferenceId}',
  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/rtc-api/ratings/conferences/{conferenceId}',
  params: {}, headers: headers

p JSON.parse(result)

Schemas

CreateRatingWebCommand

{
  "userEndpointId": "string",
  "sessionType": "UNKNOWN",
  "sessionId": "string",
  "rating": 0,
  "comment": "string",
  "feedback": [
    {
      "question": "string",
      "type": "TEXT_300",
      "choices": [
        "string"
      ],
      "choice": "string",
      "answer": "string",
      "rating": 0
    }
  ],
  "interactionId": "string"
}

Properties

Name	Type	Required	Restrictions	Description
userEndpointId	string	false	none	user endpoint id, optional
sessionType	string	true	none	type of session, CALL or CONFERENCE
sessionId	string	true	none	the call or conference id related with this rating
rating	integer(int32)	false	none	the rating the user gave, scale is 1-5, 1 meaning bad and 5 perfect, optional
comment	string	false	none	any comment the user gave, optional
feedback	[FeedbackItem]	false	none	feedback
interactionId	string	false	none	related interaction id

Enumerated Values

Property	Value
sessionType	UNKNOWN
sessionType	CALL
sessionType	CONFERENCE

FeedbackItem

{
  "question": "string",
  "type": "TEXT_300",
  "choices": [
    "string"
  ],
  "choice": "string",
  "answer": "string",
  "rating": 0
}

feedback

Properties

Name	Type	Required	Restrictions	Description
question	string	false	none	the question asked or description of feedback
type	string	false	none	the type of feedback item
choices	[string]	false	none	the choices for MULTIPLE_CHOICE answers
choice	string	false	none	the choice for SINGLE_CHOICE feedback item type
answer	string	false	none	the answer for TEXT_300 or TEXT_1000 feedback item type
rating	integer(int32)	false	none	the rating for RATING_1_5 or RATING_1_10 feedback item type

Enumerated Values

Property	Value
type	TEXT_300
type	TEXT_1000
type	RATING_1_5
type	RATING_1_10
type	SINGLE_CHOICE
type	MULTIPLE_CHOICE

CreatingRatingWebResponse

{
  "id": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none

Rating

{
  "id": "string",
  "userId": "string",
  "userEndpointId": "string",
  "userRole": "string",
  "organizationId": "string",
  "interactionId": "string",
  "sessionType": "UNKNOWN",
  "sessionId": "string",
  "score": 0,
  "comment": "string",
  "feedback": [
    {
      "question": "string",
      "type": "TEXT_300",
      "choices": [
        "string"
      ],
      "choice": "string",
      "answer": "string",
      "rating": 0
    }
  ],
  "createdAt": "2019-08-24T14:15:22Z"
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	rating id
userId	string	false	none	the user who created this rating
userEndpointId	string	false	none	the user endpoint from which the user created this rating
userRole	string	false	none	the main user role ("CUSTOMER" or "AGENT")
organizationId	string	false	none	related organization id
interactionId	string	false	none	related interaction id
sessionType	string	false	none	kind of session, CALL or CONFERENCE
sessionId	string	false	none	the call or conference id related with this rating
score	integer(int32)	false	none	the rating the user gave, scale is 1-5, 1 meaning bad and 5 perfect
comment	string	false	none	any comment the user gave
feedback	[FeedbackItem]	false	none	feedback items
createdAt	string(date-time)	false	none	none

Enumerated Values

Property	Value
sessionType	UNKNOWN
sessionType	CALL
sessionType	CONFERENCE

Authentication​

Ratings​

Create a new rating​

Request body​

Parameters​

Responses​

Overview​

Response Schema​

Examples​

Code samples​

Find ratings by interaction id​

Parameters​

Responses​

Overview​

Response Schema​

Enumerated Values​

Examples​

Code samples​

Find ratings by conference id​

Parameters​

Responses​

Overview​

Response Schema​

Enumerated Values​

Examples​

Code samples​

Schemas​

CreateRatingWebCommand​

Properties​

Enumerated Values​

FeedbackItem​

Properties​

Enumerated Values​

CreatingRatingWebResponse​

Properties​

Rating​

Properties​

Enumerated Values​

Authentication

Ratings

Create a new rating

Request body

Parameters

Responses

Overview

Response Schema

Examples

Code samples

Find ratings by interaction id

Parameters

Responses

Overview

Response Schema

Enumerated Values

Examples

Code samples

Find ratings by conference id

Parameters

Responses

Overview

Response Schema

Enumerated Values

Examples

Code samples

Schemas

CreateRatingWebCommand

Properties

Enumerated Values

FeedbackItem

Properties

Enumerated Values

CreatingRatingWebResponse

Properties

Rating

Properties

Enumerated Values