Skip to main content

Auvious Recorder API v1.0

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

  • API Key (apiKey)
    • Parameter Name: Authorization, in: header.

Media Composition

Composition Controller

Get recording information for a given conversationId.

GET /auvious.video/rtc-recorder/api/compositions/{conversationId} HTTP/1.1
Accept: application/json

Parameters

ParameterInTypeRequiredDescription
conversationIdpathstringtrueconversationId

Responses

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

200 Response

{
"audio": true,
"chatTranscript": {
"created": "2019-08-24T14:15:22Z",
"id": "string",
"location": "string"
},
"conferenceId": "string",
"conversationId": "string",
"error": {
"code": "string",
"message": "string",
"occurred": "string"
},
"instanceId": "string",
"organizationId": "string",
"recorderId": "string",
"recovered": "string",
"started": "string",
"state": "ABORTED",
"stopped": "string",
"storageProfile": {
"applicationId": "string",
"provider": "AMAZON_S3",
"url": "string"
},
"streams": [
{
"id": "string",
"state": "FAILED",
"tracks": [
{
"id": "string",
"started": "string",
"stopped": "string",
"storage": {
"localStorage": {
"created": "string",
"deleted": "string",
"error": {
"code": "string",
"message": "string",
"occurred": "string"
},
"location": "string"
},
"objectStorage": {
"error": {
"code": "string",
"message": "string",
"occurred": "string"
},
"location": "string",
"size": "string",
"uploaded": "string"
}
},
"type": "AUDIO",
"url": "string"
}
],
"type": "CAM",
"userId": "string"
}
],
"video": true
}
caution

To perform this operation, you must be authenticated by means of one of the following methods: apiKey ( Scopes: global )

Code samples

curl -X GET /auvious.video/rtc-recorder/api/compositions/{conversationId} \
-H 'Accept: application/json' \ -H 'Authorization: API_KEY'

Media Recording

Recorder Controller

getCobrowseSessionResourceAsAttachment

GET /auvious.video/rtc-recorder/api/recordings/attachment/cobrowse/{conversationId}/{recorderId}/{instanceId}/{sessionId}/{fileName}?Date=string&Expires=string&Signature=string HTTP/1.1
Accept: */*
Range: string

Parameters

ParameterInTypeRequiredDescription
conversationIdpathstringtrueconversationId
DatequerystringtrueDate
ExpiresquerystringtrueExpires
fileNamepathstringtruefileName
instanceIdpathstringtrueinstanceId
RangeheaderstringfalseRange
recorderIdpathstringtruerecorderId
sessionIdpathstringtruesessionId
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: apiKey ( Scopes: global )

Code samples

curl -X GET /auvious.video/rtc-recorder/api/recordings/attachment/cobrowse/{conversationId}/{recorderId}/{instanceId}/{sessionId}/{fileName}?Date=string&Expires=string&Signature=string \
-H 'Accept: */*' \ -H 'Range: string' \ -H 'Authorization: API_KEY'

Upload a conversation chat transcript to an existing recorder instance.

POST /auvious.video/rtc-recorder/api/recordings/chat/transcript/add HTTP/1.1
Content-Type: application/json
Accept: */*

Request body

{
"chatTranscriptList": [
{
"timeStamp": "2019-08-24T14:15:22Z",
"transcript": "string",
"userDisplayName": "string",
"userId": "string"
}
],
"conversationId": "string",
"instanceId": "string",
"recorderId": "string"
}

Parameters

ParameterInTypeRequiredDescription
bodybodyAddChatTranscriptCmdtruecmd

Responses

Overview
StatusMeaningDescriptionSchema
200OKOKInline
201CreatedCreatedNone
401UnauthorizedUnauthorizedNone
403ForbiddenForbiddenNone
404Not FoundNot FoundNone
Response Schema
Examples

200 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: apiKey ( Scopes: global )

Code samples

curl -X POST /auvious.video/rtc-recorder/api/recordings/chat/transcript/add \
-H 'Content-Type: application/json' \ -H 'Accept: */*' \ -H 'Authorization: API_KEY'

Send a cobrowse session event to an existing recorder instance.

POST /auvious.video/rtc-recorder/api/recordings/cobrowse/event HTTP/1.1
Content-Type: application/json
Accept: */*

Request body

{
"conversationId": "string",
"event": {
"payload": "string",
"sequenceId": 0,
"sessionId": "string",
"timestamp": 0
},
"instanceId": "string",
"recorderId": "string"
}

Parameters

ParameterInTypeRequiredDescription
bodybodyAddCobrowseEventCmdtruecmd

Responses

Overview
StatusMeaningDescriptionSchema
200OKOKInline
201CreatedCreatedNone
401UnauthorizedUnauthorizedNone
403ForbiddenForbiddenNone
404Not FoundNot FoundNone
Response Schema
Examples

200 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: apiKey ( Scopes: global )

Code samples

curl -X POST /auvious.video/rtc-recorder/api/recordings/cobrowse/event \
-H 'Content-Type: application/json' \ -H 'Accept: */*' \ -H 'Authorization: API_KEY'

Start a new recorder instance.

POST /auvious.video/rtc-recorder/api/recordings/start HTTP/1.1
Content-Type: application/json
Accept: */*

Request body

{
"applicationId": "string",
"audio": true,
"conferenceId": "string",
"conversationId": "string",
"video": true
}

Parameters

ParameterInTypeRequiredDescription
bodybodyStartRecordingtruecmd

Responses

Overview
StatusMeaningDescriptionSchema
200OKOKRecordingDataEvent
201CreatedCreatedNone
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: apiKey ( Scopes: global )

Code samples

curl -X POST /auvious.video/rtc-recorder/api/recordings/start \
-H 'Content-Type: application/json' \ -H 'Accept: */*' \ -H 'Authorization: API_KEY'

Get a list of recordings for a given conversationId.

GET /auvious.video/rtc-recorder/api/recordings/{conversationId} HTTP/1.1
Accept: application/json

Parameters

ParameterInTypeRequiredDescription
conversationIdpathstringtrueconversationId

Responses

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

200 Response

{
"applicationId": "string",
"chatTranscript": {
"created": "2019-08-24T14:15:22Z",
"id": "string",
"location": "string"
},
"conversationId": "string",
"duration": "string",
"provider": "AMAZON_S3",
"recordings": [
{
"audio": true,
"conferenceId": "string",
"recorderId": "string",
"recovered": "string",
"started": "string",
"stopped": "string",
"streams": [
{
"started": "string",
"stopped": "string",
"tracks": [
{
"started": "string",
"stopped": "string",
"storage": {
"location": "string",
"size": "string",
"uploaded": "string"
},
"type": "AUDIO"
}
],
"type": "CAM",
"userId": "string"
}
],
"video": true
}
]
}
caution

To perform this operation, you must be authenticated by means of one of the following methods: apiKey ( Scopes: global )

Code samples

curl -X GET /auvious.video/rtc-recorder/api/recordings/{conversationId} \
-H 'Accept: application/json' \ -H 'Authorization: API_KEY'

Get an active recording by conversationId

GET /auvious.video/rtc-recorder/api/recordings/{conversationId}/active HTTP/1.1
Accept: application/json

Parameters

ParameterInTypeRequiredDescription
conversationIdpathstringtrueconversationId

Responses

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

200 Response

{
"conversationId": "string",
"error": {
"code": "string",
"message": "string",
"occurred": "string"
},
"instanceId": "string",
"recorderId": "string",
"state": "ABORTED"
}
caution

To perform this operation, you must be authenticated by means of one of the following methods: apiKey ( Scopes: global )

Code samples

curl -X GET /auvious.video/rtc-recorder/api/recordings/{conversationId}/active \
-H 'Accept: application/json' \ -H 'Authorization: API_KEY'

Get all cobrowse sessions for a given conversationId.

GET /auvious.video/rtc-recorder/api/recordings/{conversationId}/cobrowse HTTP/1.1
Accept: application/json

Parameters

ParameterInTypeRequiredDescription
conversationIdpathstringtrueconversationId

Responses

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

200 Response

{
"cobrowseSessions": [
{
"cobrowseSessionId": "string",
"recorderId": "string",
"recorderInstanceId": "string",
"uploaded": "string"
}
],
"conversationId": "string"
}
caution

To perform this operation, you must be authenticated by means of one of the following methods: apiKey ( Scopes: global )

Code samples

curl -X GET /auvious.video/rtc-recorder/api/recordings/{conversationId}/cobrowse \
-H 'Accept: application/json' \ -H 'Authorization: API_KEY'

Get information of an existing recorder.

GET /auvious.video/rtc-recorder/api/recordings/{conversationId}/{recorderId}/{instanceId} HTTP/1.1
Accept: application/json

Parameters

ParameterInTypeRequiredDescription
conversationIdpathstringtrueconversationId
instanceIdpathstringtrueinstanceId
recorderIdpathstringtruerecorderId

Responses

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

200 Response

{
"audio": true,
"chatTranscript": {
"created": "2019-08-24T14:15:22Z",
"id": "string",
"location": "string"
},
"conferenceId": "string",
"conversationId": "string",
"error": {
"code": "string",
"message": "string",
"occurred": "string"
},
"instanceId": "string",
"organizationId": "string",
"recorderId": "string",
"recovered": "string",
"started": "string",
"state": "ABORTED",
"stopped": "string",
"storageProfile": {
"applicationId": "string",
"provider": "AMAZON_S3",
"url": "string"
},
"streams": [
{
"id": "string",
"state": "FAILED",
"tracks": [
{
"id": "string",
"started": "string",
"stopped": "string",
"storage": {
"localStorage": {
"created": "string",
"deleted": "string",
"error": {
"code": "string",
"message": "string",
"occurred": "string"
},
"location": "string"
},
"objectStorage": {
"error": {
"code": "string",
"message": "string",
"occurred": "string"
},
"location": "string",
"size": "string",
"uploaded": "string"
}
},
"type": "AUDIO",
"url": "string"
}
],
"type": "CAM",
"userId": "string"
}
],
"video": true
}
caution

To perform this operation, you must be authenticated by means of one of the following methods: apiKey ( Scopes: global )

Code samples

curl -X GET /auvious.video/rtc-recorder/api/recordings/{conversationId}/{recorderId}/{instanceId} \
-H 'Accept: application/json' \ -H 'Authorization: API_KEY'

Get a signed URL for a given cobrowse session file

GET /auvious.video/rtc-recorder/api/recordings/{conversationId}/{recorderId}/{instanceId}/cobrowse/{sessionId}/url/attachment?conversationId=string&id=string&instanceId=string HTTP/1.1
Accept: */*
referer: string

Parameters

ParameterInTypeRequiredDescription
conversationIdquerystringtruenone
idquerystringtruenone
instanceIdquerystringtruenone
refererheaderstringtruereferer
sessionIdpathstringtruesessionId

Responses

Overview
StatusMeaningDescriptionSchema
200OKOKURLResourceMessage
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: apiKey ( Scopes: global )

Code samples

curl -X GET /auvious.video/rtc-recorder/api/recordings/{conversationId}/{recorderId}/{instanceId}/cobrowse/{sessionId}/url/attachment?conversationId=string&id=string&instanceId=string \
-H 'Accept: */*' \ -H 'referer: string' \ -H 'Authorization: API_KEY'

Get status of an existing recorder.

GET /auvious.video/rtc-recorder/api/recordings/{conversationId}/{recorderId}/{instanceId}/state HTTP/1.1
Accept: application/json

Parameters

ParameterInTypeRequiredDescription
conversationIdpathstringtrueconversationId
instanceIdpathstringtrueinstanceId
recorderIdpathstringtruerecorderId

Responses

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

200 Response

{
"conversationId": "string",
"error": {
"code": "string",
"message": "string",
"occurred": "string"
},
"instanceId": "string",
"recorderId": "string",
"state": "ABORTED"
}
caution

To perform this operation, you must be authenticated by means of one of the following methods: apiKey ( Scopes: global )

Code samples

curl -X GET /auvious.video/rtc-recorder/api/recordings/{conversationId}/{recorderId}/{instanceId}/state \
-H 'Accept: application/json' \ -H 'Authorization: API_KEY'

Stop an existing recorder instance.

POST /auvious.video/rtc-recorder/api/recordings/{conversationId}/{recorderId}/{instanceId}/stop HTTP/1.1
Accept: */*

Parameters

ParameterInTypeRequiredDescription
conversationIdpathstringtrueconversationId
instanceIdpathstringtrueinstanceId
recorderIdpathstringtruerecorderId

Responses

Overview
StatusMeaningDescriptionSchema
200OKOKInline
201CreatedCreatedNone
401UnauthorizedUnauthorizedNone
403ForbiddenForbiddenNone
404Not FoundNot FoundNone
Response Schema
Examples

200 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: apiKey ( Scopes: global )

Code samples

curl -X POST /auvious.video/rtc-recorder/api/recordings/{conversationId}/{recorderId}/{instanceId}/stop \
-H 'Accept: */*' \ -H 'Authorization: API_KEY'

Get basic storage profile information of an existing recorder.

GET /auvious.video/rtc-recorder/api/recordings/{conversationId}/{recorderId}/{instanceId}/storage/info HTTP/1.1
Accept: application/json

Parameters

ParameterInTypeRequiredDescription
conversationIdpathstringtrueconversationId
instanceIdpathstringtrueinstanceId
recorderIdpathstringtruerecorderId

Responses

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

200 Response

{
"applicationId": "string",
"provider": "AMAZON_S3",
"url": "string"
}
caution

To perform this operation, you must be authenticated by means of one of the following methods: apiKey ( Scopes: global )

Code samples

curl -X GET /auvious.video/rtc-recorder/api/recordings/{conversationId}/{recorderId}/{instanceId}/storage/info \
-H 'Accept: application/json' \ -H 'Authorization: API_KEY'

Media Storage

Provider Controller

Verify the validity of a given storage provider profile.

POST /auvious.video/rtc-recorder/api/storageproviders/{applicationId}/verify HTTP/1.1
Accept: */*

Parameters

ParameterInTypeRequiredDescription
applicationIdpathstringtrueapplicationId

Responses

Overview
StatusMeaningDescriptionSchema
200OKOKStorageVerificationStatusMessage
201CreatedCreatedNone
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: apiKey ( Scopes: global )

Code samples

curl -X POST /auvious.video/rtc-recorder/api/storageproviders/{applicationId}/verify \
-H 'Accept: */*' \ -H 'Authorization: API_KEY'

Schemas

AddChatTranscriptCmd

{
"chatTranscriptList": [
{
"timeStamp": "2019-08-24T14:15:22Z",
"transcript": "string",
"userDisplayName": "string",
"userId": "string"
}
],
"conversationId": "string",
"instanceId": "string",
"recorderId": "string"
}

AddChatTranscriptCmd

Properties

NameTypeRequiredRestrictionsDescription
chatTranscriptList[ChatTranscriptEntry]truenonenone
conversationIdstringtruenonenone
instanceIdstringtruenonenone
recorderIdstringtruenonenone

AddCobrowseEventCmd

{
"conversationId": "string",
"event": {
"payload": "string",
"sequenceId": 0,
"sessionId": "string",
"timestamp": 0
},
"instanceId": "string",
"recorderId": "string"
}

AddCobrowseEventCmd

Properties

NameTypeRequiredRestrictionsDescription
conversationIdstringtruenonenone
eventCobrowseEventtruenonenone
instanceIdstringtruenonenone
recorderIdstringtruenonenone

ChatTranscriptData

{
"created": "2019-08-24T14:15:22Z",
"id": "string",
"location": "string"
}

ChatTranscriptData

Properties

NameTypeRequiredRestrictionsDescription
createdstring(date-time)truenonenone
idstringtruenonenone
locationstringtruenonenone

ChatTranscriptEntry

{
"timeStamp": "2019-08-24T14:15:22Z",
"transcript": "string",
"userDisplayName": "string",
"userId": "string"
}

ChatTranscriptEntry

Properties

NameTypeRequiredRestrictionsDescription
timeStampstring(date-time)truenonenone
transcriptstringtruenonenone
userDisplayNamestringfalsenonenone
userIdstringtruenonenone

CobrowseEvent

{
"payload": "string",
"sequenceId": 0,
"sessionId": "string",
"timestamp": 0
}

CobrowseEvent

Properties

NameTypeRequiredRestrictionsDescription
payloadstringtruenonenone
sequenceIdinteger(int32)truenonenone
sessionIdstringtruenonenone
timestampinteger(int64)truenonenone

CobrowseSessionDataMessage

{
"cobrowseSessionId": "string",
"recorderId": "string",
"recorderInstanceId": "string",
"uploaded": "string"
}

CobrowseSessionDataMessage

Properties

NameTypeRequiredRestrictionsDescription
cobrowseSessionIdstringfalsenonenone
recorderIdstringfalsenonenone
recorderInstanceIdstringfalsenonenone
uploadedstringfalsenonenone

ConversationCobrowseSessionDataMessage

{
"cobrowseSessions": [
{
"cobrowseSessionId": "string",
"recorderId": "string",
"recorderInstanceId": "string",
"uploaded": "string"
}
],
"conversationId": "string"
}

ConversationCobrowseSessionDataMessage

Properties

NameTypeRequiredRestrictionsDescription
cobrowseSessions[CobrowseSessionDataMessage]falsenonenone
conversationIdstringfalsenonenone

ConversationMessage

{
"applicationId": "string",
"chatTranscript": {
"created": "2019-08-24T14:15:22Z",
"id": "string",
"location": "string"
},
"conversationId": "string",
"duration": "string",
"provider": "AMAZON_S3",
"recordings": [
{
"audio": true,
"conferenceId": "string",
"recorderId": "string",
"recovered": "string",
"started": "string",
"stopped": "string",
"streams": [
{
"started": "string",
"stopped": "string",
"tracks": [
{
"started": "string",
"stopped": "string",
"storage": {
"location": "string",
"size": "string",
"uploaded": "string"
},
"type": "AUDIO"
}
],
"type": "CAM",
"userId": "string"
}
],
"video": true
}
]
}

ConversationMessage

Properties

NameTypeRequiredRestrictionsDescription
applicationIdstringfalsenonenone
chatTranscriptChatTranscriptDatafalsenonenone
conversationIdstringfalsenonenone
durationstringfalsenonenone
providerstringfalsenonenone
recordings[ConversationRecordingData]falsenonenone
Enumerated Values
PropertyValue
providerAMAZON_S3
providerAZURE_BLOB
providerGOOGLE_CLOUD
providerSFTP_STORAGE

ConversationRecordingData

{
"audio": true,
"conferenceId": "string",
"recorderId": "string",
"recovered": "string",
"started": "string",
"stopped": "string",
"streams": [
{
"started": "string",
"stopped": "string",
"tracks": [
{
"started": "string",
"stopped": "string",
"storage": {
"location": "string",
"size": "string",
"uploaded": "string"
},
"type": "AUDIO"
}
],
"type": "CAM",
"userId": "string"
}
],
"video": true
}

ConversationRecordingData

Properties

NameTypeRequiredRestrictionsDescription
audiobooleanfalsenonenone
conferenceIdstringfalsenonenone
recorderIdstringfalsenonenone
recoveredstringfalsenonenone
startedstringfalsenonenone
stoppedstringfalsenonenone
streams[ConversationStreamData]falsenonenone
videobooleanfalsenonenone

ConversationStreamData

{
"started": "string",
"stopped": "string",
"tracks": [
{
"started": "string",
"stopped": "string",
"storage": {
"location": "string",
"size": "string",
"uploaded": "string"
},
"type": "AUDIO"
}
],
"type": "CAM",
"userId": "string"
}

ConversationStreamData

Properties

NameTypeRequiredRestrictionsDescription
startedstringfalsenonenone
stoppedstringfalsenonenone
tracks[ConversationTrackData]falsenonenone
typestringfalsenonenone
userIdstringfalsenonenone
Enumerated Values
PropertyValue
typeCAM
typeHOLD
typeMIC
typeSCREEN
typeUNKNOWN
typeVIDEO

ConversationTrackData

{
"started": "string",
"stopped": "string",
"storage": {
"location": "string",
"size": "string",
"uploaded": "string"
},
"type": "AUDIO"
}

ConversationTrackData

Properties

NameTypeRequiredRestrictionsDescription
startedstringfalsenonenone
stoppedstringfalsenonenone
storageConversationTrackStorageDatafalsenonenone
typestringfalsenonenone
Enumerated Values
PropertyValue
typeAUDIO
typeVIDEO

ConversationTrackStorageData

{
"location": "string",
"size": "string",
"uploaded": "string"
}

ConversationTrackStorageData

Properties

NameTypeRequiredRestrictionsDescription
locationstringfalsenonenone
sizestringfalsenonenone
uploadedstringfalsenonenone

Error

{
"code": "string",
"message": "string",
"occurred": "string"
}

Error

Properties

NameTypeRequiredRestrictionsDescription
codestringfalsenonenone
messagestringfalsenonenone
occurredstringfalsenonenone

InputStream

{}

InputStream

Properties

None

LocalFileDataMessage

{
"created": "string",
"deleted": "string",
"error": {
"code": "string",
"message": "string",
"occurred": "string"
},
"location": "string"
}

LocalFileDataMessage

Properties

NameTypeRequiredRestrictionsDescription
createdstringfalsenonenone
deletedstringfalsenonenone
errorErrorfalsenonenone
locationstringfalsenonenone

RecordingDataEvent

{
"conversationId": "string",
"error": {
"code": "string",
"message": "string",
"occurred": "string"
},
"instanceId": "string",
"recorderId": "string",
"state": "ABORTED"
}

RecordingDataEvent

Properties

NameTypeRequiredRestrictionsDescription
conversationIdstringfalsenonenone
errorErrorfalsenonenone
instanceIdstringfalsenonenone
recorderIdstringfalsenonenone
statestringfalsenonenone
Enumerated Values
PropertyValue
stateABORTED
stateACTIVE
stateFAILED
stateINITIALISED
statePENDING_RECOVERY
stateSTOPPED

RecordingDataMessage

{
"audio": true,
"chatTranscript": {
"created": "2019-08-24T14:15:22Z",
"id": "string",
"location": "string"
},
"conferenceId": "string",
"conversationId": "string",
"error": {
"code": "string",
"message": "string",
"occurred": "string"
},
"instanceId": "string",
"organizationId": "string",
"recorderId": "string",
"recovered": "string",
"started": "string",
"state": "ABORTED",
"stopped": "string",
"storageProfile": {
"applicationId": "string",
"provider": "AMAZON_S3",
"url": "string"
},
"streams": [
{
"id": "string",
"state": "FAILED",
"tracks": [
{
"id": "string",
"started": "string",
"stopped": "string",
"storage": {
"localStorage": {
"created": "string",
"deleted": "string",
"error": {
"code": "string",
"message": "string",
"occurred": "string"
},
"location": "string"
},
"objectStorage": {
"error": {
"code": "string",
"message": "string",
"occurred": "string"
},
"location": "string",
"size": "string",
"uploaded": "string"
}
},
"type": "AUDIO",
"url": "string"
}
],
"type": "CAM",
"userId": "string"
}
],
"video": true
}

RecordingDataMessage

Properties

NameTypeRequiredRestrictionsDescription
audiobooleanfalsenonenone
chatTranscriptChatTranscriptDatafalsenonenone
conferenceIdstringfalsenonenone
conversationIdstringfalsenonenone
errorErrorfalsenonenone
instanceIdstringfalsenonenone
organizationIdstringfalsenonenone
recorderIdstringfalsenonenone
recoveredstringfalsenonenone
startedstringfalsenonenone
statestringfalsenonenone
stoppedstringfalsenonenone
storageProfileStorageProfileDataMessagefalsenonenone
streams[StreamDataMessage]falsenonenone
videobooleanfalsenonenone
Enumerated Values
PropertyValue
stateABORTED
stateACTIVE
stateFAILED
stateINITIALISED
statePENDING_RECOVERY
stateSTOPPED

Resource

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

Resource

Properties

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

StartRecording

{
"applicationId": "string",
"audio": true,
"conferenceId": "string",
"conversationId": "string",
"video": true
}

StartRecording

Properties

NameTypeRequiredRestrictionsDescription
applicationIdstringtruenonenone
audiobooleanfalsenonenone
conferenceIdstringtruenonenone
conversationIdstringtruenonenone
videobooleanfalsenonenone

StorageProfileDataMessage

{
"applicationId": "string",
"provider": "AMAZON_S3",
"url": "string"
}

StorageProfileDataMessage

Properties

NameTypeRequiredRestrictionsDescription
applicationIdstringfalsenonenone
providerstringfalsenonenone
urlstringfalsenonenone
Enumerated Values
PropertyValue
providerAMAZON_S3
providerAZURE_BLOB
providerGOOGLE_CLOUD
providerSFTP_STORAGE

StorageTestResult

{
"message": "string",
"passed": true
}

StorageTestResult

Properties

NameTypeRequiredRestrictionsDescription
messagestringfalsenonenone
passedbooleanfalsenonenone

StorageVerificationStatusMessage

{
"bucketTestResult": {
"message": "string",
"passed": true
},
"deleteTestResult": {
"message": "string",
"passed": true
},
"modifyTestResult": {
"message": "string",
"passed": true
},
"readTestResult": {
"message": "string",
"passed": true
},
"writeTestResult": {
"message": "string",
"passed": true
}
}

StorageVerificationStatusMessage

Properties

NameTypeRequiredRestrictionsDescription
bucketTestResultStorageTestResultfalsenonenone
deleteTestResultStorageTestResultfalsenonenone
modifyTestResultStorageTestResultfalsenonenone
readTestResultStorageTestResultfalsenonenone
writeTestResultStorageTestResultfalsenonenone

StreamDataMessage

{
"id": "string",
"state": "FAILED",
"tracks": [
{
"id": "string",
"started": "string",
"stopped": "string",
"storage": {
"localStorage": {
"created": "string",
"deleted": "string",
"error": {
"code": "string",
"message": "string",
"occurred": "string"
},
"location": "string"
},
"objectStorage": {
"error": {
"code": "string",
"message": "string",
"occurred": "string"
},
"location": "string",
"size": "string",
"uploaded": "string"
}
},
"type": "AUDIO",
"url": "string"
}
],
"type": "CAM",
"userId": "string"
}

StreamDataMessage

Properties

NameTypeRequiredRestrictionsDescription
idstringfalsenonenone
statestringfalsenonenone
tracks[TrackDataMessage]falsenonenone
typestringfalsenonenone
userIdstringfalsenonenone
Enumerated Values
PropertyValue
stateFAILED
stateRECORDING
stateSTOPPED
typeCAM
typeHOLD
typeMIC
typeSCREEN
typeUNKNOWN
typeVIDEO

TrackDataMessage

{
"id": "string",
"started": "string",
"stopped": "string",
"storage": {
"localStorage": {
"created": "string",
"deleted": "string",
"error": {
"code": "string",
"message": "string",
"occurred": "string"
},
"location": "string"
},
"objectStorage": {
"error": {
"code": "string",
"message": "string",
"occurred": "string"
},
"location": "string",
"size": "string",
"uploaded": "string"
}
},
"type": "AUDIO",
"url": "string"
}

TrackDataMessage

Properties

NameTypeRequiredRestrictionsDescription
idstringfalsenonenone
startedstringfalsenonenone
stoppedstringfalsenonenone
storageTrackStorageDataMessagefalsenonenone
typestringfalsenonenone
urlstringfalsenonenone
Enumerated Values
PropertyValue
typeAUDIO
typeVIDEO

TrackStorageDataMessage

{
"localStorage": {
"created": "string",
"deleted": "string",
"error": {
"code": "string",
"message": "string",
"occurred": "string"
},
"location": "string"
},
"objectStorage": {
"error": {
"code": "string",
"message": "string",
"occurred": "string"
},
"location": "string",
"size": "string",
"uploaded": "string"
}
}

TrackStorageDataMessage

Properties

NameTypeRequiredRestrictionsDescription
localStorageLocalFileDataMessagefalsenonenone
objectStorageUploadDataMessagefalsenonenone

URLResourceMessage

{
"url": "https://storage.googleapis.com/bucket/6e6d5224-1919-48fa-a982-66cef9fa4c08/7edf1e1e-0109-4d92-9bad-ab43059a28e3/ca900103-16d3-4b34-884a-003fd8b8e9ca/7edf1e1e-0109-4d92-9bad-ab43059a28e3.mp4?GoogleAccessId=rtc-recorder-gcs@auvious.iam.gserviceaccount.com&Expires=1610649825&Signature=t2f4bXWN842Z7eHHVKaMZs1KHUzcqX8EXX4QoaWinjcKrMcq1AnADJ7iV2MjLgScnJFhlFYiFosHiLNUSqbjuar9IKEtH9JTyLdvkljEzBPPrkvZ5X0XIi5%2FsEQTekwdzKmTjjGRUZWCix%2FIMbizCl0qnX6Tpi%2BbKhTD7u9PjXk1PEum2P2siAnB0s8D9sow6IDuH8%2FrKYMjCe3jb2P%2Fi6asce9xOwmNjW7lxnyLMAeydxCWyZ66kcas0wXZ5BillG%2BA9NvqvnBXKQrGV5im6%2FnleElz9JhcFS%2B2U5suXt9tok3SScbgMvSWfLQ0PyttJuKtQ%2FxTzUnvGOc5WGkTNg%3D%3D",
"validUntil": "2021-01-14T18:43:45.569343Z"
}

URLResourceMessage

Properties

NameTypeRequiredRestrictionsDescription
urlstring(url)falsenoneA signed URL of a given resource.
validUntilstringfalsenoneThe date until the given URL will remain valid.

UploadDataMessage

{
"error": {
"code": "string",
"message": "string",
"occurred": "string"
},
"location": "string",
"size": "string",
"uploaded": "string"
}

UploadDataMessage

Properties

NameTypeRequiredRestrictionsDescription
errorErrorfalsenonenone
locationstringfalsenonenone
sizestringfalsenonenone
uploadedstringfalsenonenone