Skip to main content

FileTransfer v1.0

Operations supporting file transfers between user (endpoints), using application (setup by the customer) storage as an intermediary station. Also files are stored there in order to be retrieved later e.g. when reviewing the interaction/session.

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‚Äč

File Transfers‚Äč

File Transfer Controller

Find file transfers‚Äč

GET https://dev.auvious.video:443/rtc-api/filetransfers HTTP/1.1
Host: dev.auvious.video:443
Accept: application/json

Parameters‚Äč

ParameterInTypeRequiredDescription
interactionIdquerystringfalsefind by interactionId, mutually exclusive with conferenceId
conferenceIdquerystringfalsefind by conferenceId, mutually exclusive with interactionId
allquerybooleanfalseif provided and true, all file transfers will be received, not just the ones sent or received by user calling which is the default behavior

Responses‚Äč

Overview‚Äč
StatusMeaningDescriptionSchema
200OKOKIterable¬ęFileTransferInfo¬Ľ
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://dev.auvious.video:443/rtc-api/filetransfers \
-H 'Accept: application/json' \ -H 'Authorization: Bearer {access-token}'

Transfer a file‚Äč

POST https://dev.auvious.video:443/rtc-api/filetransfers HTTP/1.1
Host: dev.auvious.video:443
Content-Type: multipart/form-data
Accept: */*
X-Auvious-TransactionId: string

Request body‚Äč

applicationId: string
conferenceId: string
file: string
interactionId: string
targetId: string
targetType: string
userEndpointId: string

Parameters‚Äč

ParameterInTypeRequiredDescription
X-Auvious-TransactionIdheaderstringfalseused for detecting retries of the same request
bodybodyobjectfalsenone
¬Ľ applicationIdbodystringtruewhich application id to use, must match user organization
¬Ľ conferenceIdbodystringtruewhich conference id to link this transfer to, optional
¬Ľ filebodystring(binary)truethe actual file
¬Ľ interactionIdbodystringtruewhich integration id to link this transfer to, optional
¬Ľ targetIdbodystringtruetarget id e.g. a user id, will be used to send the FileTransferEvent to all user endpoints of user
¬Ľ targetTypebodystringtruetarget type e.g. USER, affects which users will receive the FileTransferEvent message
¬Ľ userEndpointIdbodystringfalsewhich userEndpoint id to link to

Responses‚Äč

Overview‚Äč
StatusMeaningDescriptionSchema
200OKOKFileTransferResult
201CreatedCreatedNone
204No ContentNo ContentNone
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 POST https://dev.auvious.video:443/rtc-api/filetransfers \
-H 'Content-Type: multipart/form-data' \ -H 'Accept: */*' \ -H 'X-Auvious-TransactionId: string' \ -H 'Authorization: Bearer {access-token}'

get a builtin signed url‚Äč

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

Parameters‚Äč

ParameterInTypeRequiredDescription
fileTransferIdpathstringtruefileTransferId
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://dev.auvious.video:443/rtc-api/filetransfers/signed/{fileTransferId}/{expiration}?signature=string \
-H 'Accept: */*' \ -H 'Authorization: Bearer {access-token}'

create a signed url‚Äč

POST https://dev.auvious.video:443/rtc-api/filetransfers/{fileTransferId}/signedUrl HTTP/1.1
Host: dev.auvious.video:443
Accept: application/json
Referer: string

Parameters‚Äč

ParameterInTypeRequiredDescription
fileTransferIdpathstringtruefileTransferId
RefererheaderstringtrueReferer

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://dev.auvious.video:443/rtc-api/filetransfers/{fileTransferId}/signedUrl \
-H 'Accept: application/json' \ -H 'Referer: string' \ -H 'Authorization: Bearer {access-token}'

Schemas‚Äč

ConferenceId‚Äč

{
"id": "string"
}

ConferenceId

Properties‚Äč

NameTypeRequiredRestrictionsDescription
idstringfalsenonenone

FileTransferInfo‚Äč

{
"conferenceId": {
"id": "string"
},
"fileTransferId": "string",
"filename": "string",
"interactionId": "string",
"mimeType": "string",
"sentAt": "2019-08-24T14:15:22Z",
"targetId": "string",
"targetType": "CONFERENCE",
"userEndpointId": "string",
"userId": "string"
}

FileTransferInfo

Properties‚Äč

NameTypeRequiredRestrictionsDescription
conferenceIdConferenceIdfalsenonenone
fileTransferIdstringfalsenonenone
filenamestringfalsenonenone
interactionIdstringfalsenonenone
mimeTypestringfalsenonenone
sentAtstring(date-time)falsenonenone
targetIdstringfalsenonenone
targetTypestringfalsenonenone
userEndpointIdstringfalsenonenone
userIdstringfalsenonenone
Enumerated Values‚Äč
PropertyValue
targetTypeCONFERENCE
targetTypeUNKNOWN
targetTypeUSER
targetTypeUSER_ENDPOINT

FileTransferResult‚Äč

{
"fileTransferId": "string"
}

FileTransferResult

Properties‚Äč

NameTypeRequiredRestrictionsDescription
fileTransferIdstringfalsenonenone

InputStream‚Äč

{}

InputStream

Properties‚Äč

None

Iterable¬ęFileTransferInfo¬Ľ‚Äč

{}

Iterable¬ęFileTransferInfo¬Ľ

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