Skip to main content

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

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 HTTP/1.1
Host: auvious.video:443
Accept: application/json

Parameters

ParameterInTypeRequiredDescription
offsetqueryinteger(int64)falsenone
pageNumberqueryinteger(int32)falsenone
pageSizequeryinteger(int32)falsenone
pagedquerybooleanfalsenone
sort.sortedquerybooleanfalsenone
sort.unsortedquerybooleanfalsenone
unpagedquerybooleanfalsenone
startquerystring(date-time)truestart
endquerystring(date-time)trueend

Responses

Overview
StatusMeaningDescriptionSchema
200OKOKPage«Interaction»
401UnauthorizedUnauthorizedNone
403ForbiddenForbiddenNone
404Not FoundNot FoundNone
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 \
-H 'Accept: application/json' \ -H 'Authorization: Bearer {access-token}'

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

ParameterInTypeRequiredDescription
bodybodyCreateInteractionWebCommandfalsenone

Responses

Overview
StatusMeaningDescriptionSchema
200OKOKCreateInteractionResponse
201CreatedCreatedNone
401UnauthorizedUnauthorizedNone
403ForbiddenForbiddenNone
404Not FoundNot FoundNone
Examples

200 Response

{
"interactionId": "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://auvious.video:443/rtc-api/interactions \
-H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {access-token}'

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

ParameterInTypeRequiredDescription
interactionIdpathstringtrueinteractionId

Responses

Overview
StatusMeaningDescriptionSchema
200OKOKInteraction
401UnauthorizedUnauthorizedNone
403ForbiddenForbiddenNone
404Not FoundNot FoundNone
Examples

200 Response

{
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"data": {},
"id": "string",
"organizationId": "string",
"type": "string",
"version": 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/{interactionId} \
-H 'Accept: application/json' \ -H 'Authorization: Bearer {access-token}'

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

ParameterInTypeRequiredDescription
interactionIdpathstringtrueinteractionId
bodybodyUpdateInteractionWebCommandfalsenone

Responses

Overview
StatusMeaningDescriptionSchema
201CreatedCreatedNone
204No ContentUpdatedNone
401UnauthorizedUnauthorizedNone
403ForbiddenForbiddenNone
404Not FoundNot FoundNone
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 PUT https://auvious.video:443/rtc-api/interactions/{interactionId} \
-H 'Content-Type: application/json' \ -H 'Authorization: Bearer {access-token}'

Schemas

CreateInteractionResponse

{
"interactionId": "string"
}

CreateInteractionResponse

Properties

NameTypeRequiredRestrictionsDescription
interactionIdstringfalsenonenone

CreateInteractionWebCommand

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

CreateInteractionWebCommand

Properties

NameTypeRequiredRestrictionsDescription
dataobjectfalsenoneinteraction data, this is the place to store arbitrary data that might be needed later
interactionIdstringfalsenoneinteraction id, can be supplied to match integration party e.g. Genesys Cloud interaction/conversation id
typestringfalsenonetype 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

NameTypeRequiredRestrictionsDescription
createdAtstring(date-time)falsenonecreation timestamp
createdBystringfalsenonecreation user id
dataobjectfalsenoneinteraction data
idstringfalsenoneinteraction id
organizationIdstringfalsenoneorganization id
typestringfalsenoneinteraction type
versioninteger(int64)falsenonenone

Pageable

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

Pageable

Properties

NameTypeRequiredRestrictionsDescription
offsetinteger(int64)falsenonenone
pageNumberinteger(int32)falsenonenone
pageSizeinteger(int32)falsenonenone
pagedbooleanfalsenonenone
sortSortfalsenonenone
unpagedbooleanfalsenonenone

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

NameTypeRequiredRestrictionsDescription
content[Interaction]falsenonenone
emptybooleanfalsenonenone
firstbooleanfalsenonenone
lastbooleanfalsenonenone
numberinteger(int32)falsenonenone
numberOfElementsinteger(int32)falsenonenone
pageablePageablefalsenonenone
sizeinteger(int32)falsenonenone
sortSortfalsenonenone
totalElementsinteger(int64)falsenonenone
totalPagesinteger(int32)falsenonenone

Sort

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

Sort

Properties

NameTypeRequiredRestrictionsDescription
emptybooleanfalsenonenone
sortedbooleanfalsenonenone
unsortedbooleanfalsenonenone

UpdateInteractionWebCommand

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

UpdateInteractionWebCommand

Properties

NameTypeRequiredRestrictionsDescription
dataobjectfalsenoneinteraction 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
typestringfalsenonetype of interaction, e.g. video call if omitted it wont be updated