Skip to main content

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​

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​

ParameterInTypeRequiredDescription
bodybodyCreateRatingWebCommandfalsenone

Responses​

Overview​
StatusMeaningDescriptionSchema
200OKOKCreatingRatingWebResponse
201CreatedCreatedNone
401UnauthorizedUnauthorizedNone
403ForbiddenForbiddenNone
404Not FoundNot FoundNone
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​

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}'

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​

ParameterInTypeRequiredDescription
conferenceIdpathstringtrueconferenceId

Responses​

Overview​
StatusMeaningDescriptionSchema
200OKOKInline
401UnauthorizedUnauthorizedNone
403ForbiddenForbiddenNone
404Not FoundNot FoundNone
Response Schema​

Status Code 200

NameTypeRequiredRestrictionsDescription
anonymous[Rating]falsenonenone
» RatingRatingfalsenonenone
»» commentstringfalsenoneany comment the user gave
»» idstringfalsenonerating id
»» interactionIdstringfalsenonerelated interaction id
»» organizationIdstringfalsenonerelated organization id
»» scoreinteger(int32)falsenonethe rating the user gave, scale is 1-5, 1 meaning bad and 5 perfect
»» sessionIdstringfalsenonethe call or conference id related with this rating
»» sessionTypestringfalsenonekind of session, CALL or CONFERENCE
»» userEndpointIdstringfalsenonethe user endpoint from which the user created this rating
»» userIdstringfalsenonethe user who created this rating
Enumerated Values​
PropertyValue
sessionTypeCALL
sessionTypeCONFERENCE
sessionTypeUNKNOWN
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​

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

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​

ParameterInTypeRequiredDescription
interactionIdpathstringtrueinteractionId

Responses​

Overview​
StatusMeaningDescriptionSchema
200OKOKInline
401UnauthorizedUnauthorizedNone
403ForbiddenForbiddenNone
404Not FoundNot FoundNone
Response Schema​

Status Code 200

NameTypeRequiredRestrictionsDescription
anonymous[Rating]falsenonenone
» RatingRatingfalsenonenone
»» commentstringfalsenoneany comment the user gave
»» idstringfalsenonerating id
»» interactionIdstringfalsenonerelated interaction id
»» organizationIdstringfalsenonerelated organization id
»» scoreinteger(int32)falsenonethe rating the user gave, scale is 1-5, 1 meaning bad and 5 perfect
»» sessionIdstringfalsenonethe call or conference id related with this rating
»» sessionTypestringfalsenonekind of session, CALL or CONFERENCE
»» userEndpointIdstringfalsenonethe user endpoint from which the user created this rating
»» userIdstringfalsenonethe user who created this rating
Enumerated Values​
PropertyValue
sessionTypeCALL
sessionTypeCONFERENCE
sessionTypeUNKNOWN
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​

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

Schemas​

CreateRatingWebCommand​

{
"comment": "string",
"interactionId": "string",
"rating": 0,
"sessionId": "string",
"sessionType": "CALL",
"userEndpointId": "string"
}

CreateRatingWebCommand

Properties​

NameTypeRequiredRestrictionsDescription
commentstringfalsenoneany comment the user gave
interactionIdstringfalsenonerelated interaction id
ratinginteger(int32)falsenonethe rating the user gave, scale is 1-5, 1 meaning bad and 5 perfect
sessionIdstringfalsenonethe call or conference id related with this rating
sessionTypestringfalsenonetype of session, CALL or CONFERENCE
userEndpointIdstringfalsenoneuser endpoint id, optional
Enumerated Values​
PropertyValue
sessionTypeCALL
sessionTypeCONFERENCE
sessionTypeUNKNOWN

CreatingRatingWebResponse​

{
"id": "string"
}

CreatingRatingWebResponse

Properties​

NameTypeRequiredRestrictionsDescription
idstringfalsenonenone

Rating​

{
"comment": "string",
"id": "string",
"interactionId": "string",
"organizationId": "string",
"score": 0,
"sessionId": "string",
"sessionType": "CALL",
"userEndpointId": "string",
"userId": "string"
}

Rating

Properties​

NameTypeRequiredRestrictionsDescription
commentstringfalsenoneany comment the user gave
idstringfalsenonerating id
interactionIdstringfalsenonerelated interaction id
organizationIdstringfalsenonerelated organization id
scoreinteger(int32)falsenonethe rating the user gave, scale is 1-5, 1 meaning bad and 5 perfect
sessionIdstringfalsenonethe call or conference id related with this rating
sessionTypestringfalsenonekind of session, CALL or CONFERENCE
userEndpointIdstringfalsenonethe user endpoint from which the user created this rating
userIdstringfalsenonethe user who created this rating
Enumerated Values​
PropertyValue
sessionTypeCALL
sessionTypeCONFERENCE
sessionTypeUNKNOWN