Skip to main content

Snapshot v1.0

Operations supporting taking snapshots using the camera of the remote party.

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

Snapshots

Snapshot Controller

retrieve snapshots

GET https://auvious.video:443/rtc-api/snapshots?interactionId=string HTTP/1.1
Host: auvious.video:443
Accept: */*

Parameters

ParameterInTypeRequiredDescription
interactionIdquerystringtrueinteractionId

Responses

Overview
StatusMeaningDescriptionSchema
200OKOKIterable«Snapshot»
401UnauthorizedUnauthorizedNone
403ForbiddenForbiddenNone
404Not FoundNot FoundNone
Examples

200 Response

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/snapshots?interactionId=string \
-H 'Accept: */*' \ -H 'Authorization: Bearer {access-token}'

Acquire a snapshot

POST https://auvious.video:443/rtc-api/snapshots/acquire HTTP/1.1
Host: auvious.video:443
Content-Type: multipart/form-data

Request body

image: string
snapshotId: string
snapshotMimeType: string
snapshotSuffix: string
snapshotType: string
userEndpointId: string

Parameters

ParameterInTypeRequiredDescription
bodybodyobjectfalsenone
» imagebodystring(binary)trueimage
» snapshotIdbodystringtruesnapshotId
» snapshotMimeTypebodystringtruesnapshotMimeType
» snapshotSuffixbodystringtruesnapshotSuffix
» snapshotTypebodystringtruesnapshotType
» userEndpointIdbodystringtrueuserEndpointId

Responses

Overview
StatusMeaningDescriptionSchema
201CreatedCreatedNone
204No ContentNo ContentNone
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 POST https://auvious.video:443/rtc-api/snapshots/acquire \
-H 'Content-Type: multipart/form-data' \ -H 'Authorization: Bearer {access-token}'

Approve a snapshot

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

Request body

{
"snapshotId": "string",
"snapshotType": "string",
"userEndpointId": "string"
}

Parameters

ParameterInTypeRequiredDescription
bodybodySnapshotApproveWebCommandfalsenone

Responses

Overview
StatusMeaningDescriptionSchema
201CreatedCreatedNone
204No ContentNo ContentNone
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 POST https://auvious.video:443/rtc-api/snapshots/approve \
-H 'Content-Type: application/json' \ -H 'Authorization: Bearer {access-token}'

Creates a new camera request

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

Request body

{
"cameraRequestType": "CAMERA_SWITCH",
"sessionId": "string",
"sessionType": "CALL",
"targetUserEndpointId": "string",
"targetUserId": "string",
"userEndpointId": "string"
}

Parameters

ParameterInTypeRequiredDescription
bodybodySnapshotCameraRequestWebCommandfalsenone

Responses

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

200 Response

"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/snapshots/cameraRequest \
-H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {access-token}'

Responds to a camera request

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

Request body

{
"additionalInformation": "string",
"snapshotCameraRequestId": "string",
"succeeded": false,
"userEndpointId": "string"
}

Parameters

ParameterInTypeRequiredDescription
bodybodySnapshotCameraRequestRespondWebCommandfalsenone

Responses

Overview
StatusMeaningDescriptionSchema
201CreatedCreatedNone
204No ContentNo ContentNone
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 POST https://auvious.video:443/rtc-api/snapshots/cameraRequestRespond \
-H 'Content-Type: application/json' \ -H 'Authorization: Bearer {access-token}'

Discard a snapshot

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

Request body

{
"snapshotId": "string",
"userEndpointId": "string"
}

Parameters

ParameterInTypeRequiredDescription
bodybodySnapshotDiscardWebCommandfalsenone

Responses

Overview
StatusMeaningDescriptionSchema
201CreatedCreatedNone
204No ContentNo ContentNone
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 POST https://auvious.video:443/rtc-api/snapshots/discard \
-H 'Content-Type: application/json' \ -H 'Authorization: Bearer {access-token}'

Creates a new snapshot request

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

Request body

{
"applicationId": {
"id": "string"
},
"interactionId": "string",
"sessionId": "string",
"sessionType": "CALL",
"snapshotType": "string",
"targetUserEndpointId": "string",
"targetUserId": "string",
"userEndpointId": "string"
}

Parameters

ParameterInTypeRequiredDescription
bodybodySnapshotRequestWebCommandfalsenone

Responses

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

200 Response

{
"snapshotId": "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/snapshots/request \
-H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer {access-token}'

get a builtin signed url

GET https://auvious.video:443/rtc-api/snapshots/signed/{snapshotId}/{expiration}?signature=string HTTP/1.1
Host: auvious.video:443
Accept: */*

Parameters

ParameterInTypeRequiredDescription
snapshotIdpathstringtruesnapshotId
expirationpathinteger(int64)trueexpiration
signaturequerystringtruesignature

Responses

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

200 Response

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/snapshots/signed/{snapshotId}/{expiration}?signature=string \
-H 'Accept: */*' \ -H 'Authorization: Bearer {access-token}'

Create a signed url for a snapshot

POST https://auvious.video:443/rtc-api/snapshots/signedUrl HTTP/1.1
Host: auvious.video:443
Content-Type: application/json
Accept: application/json
Referer: string

Request body

{
"snapshotId": "string"
}

Parameters

ParameterInTypeRequiredDescription
RefererheaderstringtrueReferer
bodybodyCreateSnapshotSignedURLWebCommandfalsenone

Responses

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

200 Response

{
"url": "string",
"validUntil": "2019-08-24T14:15:22Z"
}
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/snapshots/signedUrl \
-H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Referer: string' \ -H 'Authorization: Bearer {access-token}'

Schemas

ApplicationId

{
"id": "string"
}

ApplicationId

Properties

NameTypeRequiredRestrictionsDescription
idstringfalsenonenone

CreateSnapshotSignedURLWebCommand

{
"snapshotId": "string"
}

CreateSnapshotSignedURLWebCommand

Properties

NameTypeRequiredRestrictionsDescription
snapshotIdstringtruenonenone

InputStream

{}

InputStream

Properties

None

Iterable«Snapshot»

{}

Iterable«Snapshot»

Properties

None

Resource

{
"description": "string",
"file": "string",
"filename": "string",
"inputStream": {},
"open": true,
"readable": true,
"uri": "http://example.com",
"url": "string"
}

Resource

Properties

NameTypeRequiredRestrictionsDescription
descriptionstringfalsenonenone
filestring(binary)falsenonenone
filenamestringfalsenonenone
inputStreamInputStreamfalsenonenone
openbooleanfalsenonenone
readablebooleanfalsenonenone
uristring(uri)falsenonenone
urlstring(url)falsenonenone

SignedUrl

{
"url": "string",
"validUntil": "2019-08-24T14:15:22Z"
}

SignedUrl

Properties

NameTypeRequiredRestrictionsDescription
urlstring(url)falsenonenone
validUntilstring(date-time)falsenonenone

Snapshot

{
"applicationId": {
"id": "string"
},
"approvalProcessingResult": {
"additionalInformation": "string",
"succeeded": true
},
"approved": true,
"id": "string",
"interactionId": "string",
"mimeType": "string",
"organizationId": "string",
"path": "string",
"requestProcessingResult": {
"error": "string",
"snapshotAcquired": true
},
"requesterUserEndpointId": "string",
"requesterUserId": "string",
"sessionId": "string",
"sessionType": "CALL",
"state": "APPROVED",
"suffix": "string",
"timestamp": "2019-08-24T14:15:22Z",
"type": "string",
"userEndpointId": "string",
"userId": "string",
"version": 0
}

Snapshot

Properties

NameTypeRequiredRestrictionsDescription
applicationIdApplicationIdfalsenonenone
approvalProcessingResultSnapshotApprovalProcessingResultfalsenonenone
approvedbooleanfalsenonenone
idstringfalsenonenone
interactionIdstringfalsenonenone
mimeTypestringfalsenonenone
organizationIdstringfalsenonenone
pathstringfalsenonenone
requestProcessingResultSnapshotRequestResultfalsenonenone
requesterUserEndpointIdstringfalsenonenone
requesterUserIdstringfalsenonenone
sessionIdstringfalsenonenone
sessionTypestringfalsenonenone
statestringfalsenonenone
suffixstringfalsenonenone
timestampstring(date-time)falsenonenone
typestringfalsenonenone
userEndpointIdstringfalsenonenone
userIdstringfalsenonenone
versioninteger(int64)falsenonenone
Enumerated Values
PropertyValue
sessionTypeCALL
sessionTypeCONFERENCE
sessionTypeUNKNOWN
stateAPPROVED
stateDISCARDED
stateUPLOADED

SnapshotApprovalProcessingResult

{
"additionalInformation": "string",
"succeeded": true
}

SnapshotApprovalProcessingResult

Properties

NameTypeRequiredRestrictionsDescription
additionalInformationstringfalsenonenone
succeededbooleanfalsenonenone

SnapshotApproveWebCommand

{
"snapshotId": "string",
"snapshotType": "string",
"userEndpointId": "string"
}

SnapshotApproveWebCommand

Properties

NameTypeRequiredRestrictionsDescription
snapshotIdstringfalsenonethe snapshot id
snapshotTypestringfalsenonethe snapshot type (override request snapshot type)
userEndpointIdstringfalsenonethe requester's userEndpointId

SnapshotCameraRequestRespondWebCommand

{
"additionalInformation": "string",
"snapshotCameraRequestId": "string",
"succeeded": false,
"userEndpointId": "string"
}

SnapshotCameraRequestRespondWebCommand

Properties

NameTypeRequiredRestrictionsDescription
additionalInformationstringfalsenoneadditional information about the request success or failure
snapshotCameraRequestIdstringfalsenonethe request id
succeededbooleanfalsenoneindicates if the request succeeded
userEndpointIdstringfalsenonethe responder's userEndpointId

SnapshotCameraRequestWebCommand

{
"cameraRequestType": "CAMERA_SWITCH",
"sessionId": "string",
"sessionType": "CALL",
"targetUserEndpointId": "string",
"targetUserId": "string",
"userEndpointId": "string"
}

SnapshotCameraRequestWebCommand

Properties

NameTypeRequiredRestrictionsDescription
cameraRequestTypestringfalsenonethe request type, feel free to enter what suits you
sessionIdstringfalsenonesession id, e.g. conference id for conference
sessionTypestringfalsenonesession type, one of CONFERENCE
targetUserEndpointIdstringfalsenonethe request's target userEndpointId
targetUserIdstringfalsenonethe request's target userId
userEndpointIdstringfalsenonethe requester's userEndpointId
Enumerated Values
PropertyValue
cameraRequestTypeCAMERA_SWITCH
cameraRequestTypeFLASH_OFF
cameraRequestTypeFLASH_ON
sessionTypeCALL
sessionTypeCONFERENCE
sessionTypeUNKNOWN

SnapshotDiscardWebCommand

{
"snapshotId": "string",
"userEndpointId": "string"
}

SnapshotDiscardWebCommand

Properties

NameTypeRequiredRestrictionsDescription
snapshotIdstringfalsenonethe snapshot id
userEndpointIdstringfalsenonethe discarder's userEndpointId

SnapshotRequestResult

{
"error": "string",
"snapshotAcquired": true
}

SnapshotRequestResult

Properties

NameTypeRequiredRestrictionsDescription
errorstringfalsenonenone
snapshotAcquiredbooleanfalsenonenone

SnapshotRequestResult0

{
"snapshotId": "string"
}

SnapshotRequestResult0

Properties

NameTypeRequiredRestrictionsDescription
snapshotIdstringfalsenonenone

SnapshotRequestWebCommand

{
"applicationId": {
"id": "string"
},
"interactionId": "string",
"sessionId": "string",
"sessionType": "CALL",
"snapshotType": "string",
"targetUserEndpointId": "string",
"targetUserId": "string",
"userEndpointId": "string"
}

SnapshotRequestWebCommand

Properties

NameTypeRequiredRestrictionsDescription
applicationIdApplicationIdfalsenonethe application to use
interactionIdstringfalsenoneinteraction id, e.g. if provided snapshot will be stored under interactions/{interaction-id} folder in storage
sessionIdstringfalsenonesession id, e.g. conference id for conference
sessionTypestringfalsenonesession type, one of CONFERENCE
snapshotTypestringfalsenonethe snapshot's type
targetUserEndpointIdstringfalsenonethe request's target userEndpointId
targetUserIdstringfalsenonethe request's target userId
userEndpointIdstringfalsenonethe requester's userEndpointId
Enumerated Values
PropertyValue
sessionTypeCALL
sessionTypeCONFERENCE
sessionTypeUNKNOWN