Rating v1.0
Operations supporting session rating.
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://dev.auvious.video/security/oauth/authorize
OAuth 2.0 Token URL = https://dev.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
Ratings​
Rating Controller
Create a new rating​
POST https://dev.auvious.video:443/rtc-api/ratings HTTP/1.1
Host: dev.auvious.video:443
Content-Type: application/json
Accept: application/json
Request body​
{
"comment": "string",
"interactionId": "string",
"rating": 0,
"sessionId": "string",
"sessionType": "CALL",
"userEndpointId": "string"
}
Parameters​
Parameter | In | Type | Required | Description |
---|---|---|---|---|
body | body | CreateRatingWebCommand | false | none |
Responses​
Overview​
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | CreatingRatingWebResponse |
201 | Created | Created | None |
401 | Unauthorized | Unauthorized | None |
403 | Forbidden | Forbidden | None |
404 | Not Found | Not Found | None |
Examples​
200 Response
{
"id": "string"
}
caution
To perform this operation, you must be authenticated by means of one of the following methods: Client Credentials Flow ( Scopes: global ), Jwt ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global )
Code samples​
- Shell
- Go
- Node
- Java
- Python
- Ruby
curl -X POST https://dev.auvious.video:443/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://dev.auvious.video:443/rtc-api/ratings", bytes.NewBuffer(body))
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
const fetch = require('node-fetch');
const input = '{
"comment": "string",
"interactionId": "string",
"rating": 0,
"sessionId": "string",
"sessionType": "CALL",
"userEndpointId": "string"
}';
const headers = {
'Content-Type': 'application/json', 'Accept': 'application/json', 'Authorization': 'Bearer {access-token}'
}
fetch('https://dev.auvious.video:443/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://dev.auvious.video:443/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://dev.auvious.video:443/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://dev.auvious.video:443/rtc-api/ratings',
params: {}, headers: headers
p JSON.parse(result)
Find ratings by conference id​
GET https://dev.auvious.video:443/rtc-api/ratings/conferences/{conferenceId} HTTP/1.1
Host: dev.auvious.video:443
Accept: application/json
Parameters​
Parameter | In | Type | Required | Description |
---|---|---|---|---|
conferenceId | path | string | true | conferenceId |
Responses​
Overview​
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | Inline |
401 | Unauthorized | Unauthorized | None |
403 | Forbidden | Forbidden | None |
404 | Not Found | Not Found | None |
Response Schema​
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [Rating] | false | none | none |
» Rating | Rating | false | none | none |
»» comment | string | false | none | any comment the user gave |
»» id | string | false | none | rating id |
»» interactionId | string | false | none | related interaction id |
»» organizationId | string | false | none | related organization id |
»» score | integer(int32) | false | none | the rating the user gave, scale is 1-5, 1 meaning bad and 5 perfect |
»» sessionId | string | false | none | the call or conference id related with this rating |
»» sessionType | string | false | none | kind of session, CALL or CONFERENCE |
»» userEndpointId | string | false | none | the user endpoint from which the user created this rating |
»» userId | string | false | none | the user who created this rating |
Enumerated Values​
Property | Value |
---|---|
sessionType | CALL |
sessionType | CONFERENCE |
sessionType | UNKNOWN |
Examples​
200 Response
[
{
"comment": "string",
"id": "string",
"interactionId": "string",
"organizationId": "string",
"score": 0,
"sessionId": "string",
"sessionType": "CALL",
"userEndpointId": "string",
"userId": "string"
}
]
caution
To perform this operation, you must be authenticated by means of one of the following methods: Client Credentials Flow ( Scopes: global ), Jwt ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global )
Code samples​
- Shell
- Go
- Node
- Java
- Python
- Ruby
curl -X GET https://dev.auvious.video:443/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://dev.auvious.video:443/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://dev.auvious.video:443/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://dev.auvious.video:443/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://dev.auvious.video:443/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://dev.auvious.video:443/rtc-api/ratings/conferences/{conferenceId}',
params: {}, headers: headers
p JSON.parse(result)
Find ratings by interaction id​
GET https://dev.auvious.video:443/rtc-api/ratings/interactions/{interactionId} HTTP/1.1
Host: dev.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 | Inline |
401 | Unauthorized | Unauthorized | None |
403 | Forbidden | Forbidden | None |
404 | Not Found | Not Found | None |
Response Schema​
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [Rating] | false | none | none |
» Rating | Rating | false | none | none |
»» comment | string | false | none | any comment the user gave |
»» id | string | false | none | rating id |
»» interactionId | string | false | none | related interaction id |
»» organizationId | string | false | none | related organization id |
»» score | integer(int32) | false | none | the rating the user gave, scale is 1-5, 1 meaning bad and 5 perfect |
»» sessionId | string | false | none | the call or conference id related with this rating |
»» sessionType | string | false | none | kind of session, CALL or CONFERENCE |
»» userEndpointId | string | false | none | the user endpoint from which the user created this rating |
»» userId | string | false | none | the user who created this rating |
Enumerated Values​
Property | Value |
---|---|
sessionType | CALL |
sessionType | CONFERENCE |
sessionType | UNKNOWN |
Examples​
200 Response
[
{
"comment": "string",
"id": "string",
"interactionId": "string",
"organizationId": "string",
"score": 0,
"sessionId": "string",
"sessionType": "CALL",
"userEndpointId": "string",
"userId": "string"
}
]
caution
To perform this operation, you must be authenticated by means of one of the following methods: Client Credentials Flow ( Scopes: global ), Jwt ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global )
Code samples​
- Shell
- Go
- Node
- Java
- Python
- Ruby
curl -X GET https://dev.auvious.video:443/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://dev.auvious.video:443/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://dev.auvious.video:443/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://dev.auvious.video:443/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://dev.auvious.video:443/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://dev.auvious.video:443/rtc-api/ratings/interactions/{interactionId}',
params: {}, headers: headers
p JSON.parse(result)
Schemas​
CreateRatingWebCommand​
{
"comment": "string",
"interactionId": "string",
"rating": 0,
"sessionId": "string",
"sessionType": "CALL",
"userEndpointId": "string"
}
CreateRatingWebCommand
Properties​
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
comment | string | false | none | any comment the user gave |
interactionId | string | false | none | related interaction id |
rating | integer(int32) | false | none | the rating the user gave, scale is 1-5, 1 meaning bad and 5 perfect |
sessionId | string | false | none | the call or conference id related with this rating |
sessionType | string | false | none | type of session, CALL or CONFERENCE |
userEndpointId | string | false | none | user endpoint id, optional |
Enumerated Values​
Property | Value |
---|---|
sessionType | CALL |
sessionType | CONFERENCE |
sessionType | UNKNOWN |
CreatingRatingWebResponse​
{
"id": "string"
}
CreatingRatingWebResponse
Properties​
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | string | false | none | none |
Rating​
{
"comment": "string",
"id": "string",
"interactionId": "string",
"organizationId": "string",
"score": 0,
"sessionId": "string",
"sessionType": "CALL",
"userEndpointId": "string",
"userId": "string"
}
Rating
Properties​
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
comment | string | false | none | any comment the user gave |
id | string | false | none | rating id |
interactionId | string | false | none | related interaction id |
organizationId | string | false | none | related organization id |
score | integer(int32) | false | none | the rating the user gave, scale is 1-5, 1 meaning bad and 5 perfect |
sessionId | string | false | none | the call or conference id related with this rating |
sessionType | string | false | none | kind of session, CALL or CONFERENCE |
userEndpointId | string | false | none | the user endpoint from which the user created this rating |
userId | string | false | none | the user who created this rating |
Enumerated Values​
Property | Value |
---|---|
sessionType | CALL |
sessionType | CONFERENCE |
sessionType | UNKNOWN |