Cloud Storage Start Convert #

🔑 Need JWT Authorization

Description #

Start convert file to cloud storage

Method And Path #

POST /v2/cloud-storage/convert/start

Request #

Header #

{
    "authorization": string;
    "x-request-id": string;
    "x-session-id": string;
}

Body #

{
    "fileUUID": string;
}

fileUUID #

File uuid

• format: uuid-v4

Response #

Success #

HTTP Status Code: 200

{
    status: Status.Success,
    data: {
        resourceType: FileResourceType.WhiteboardConvert,
        whiteboardConvert: {
            taskUUID: string,
            taskToken: string,
        },
    }
}

// or

{
    status: Status.Success,
    data: {
        resourceType: FileResourceType.WhiteboardProjector,
        whiteboardProjector: {
            taskUUID: string,
            taskToken: string,
        },
    }
}

Extends Type: Status, FileResourceType

resourceType #

File resource type.

For more information: FileResourceType

whiteboardConvert.taskUUID #

whiteboard convert task uuid

For more information: netless-server-conversion

whiteboardConvert.taskToken #

whiteboard convert task token

For more information: netless-server-conversion

whiteboardProjector.taskUUID #

whiteboard projector task uuid

For more information: agora-server-conversion

whiteboardProjector.taskToken #

whiteboard projector task token

For more information: agora-server-conversion

Failed #

HTTP Status Code: 200

{
    status: Status.Failed,
    code: ErrorCode
}

Extends Type: Status, ErrorCode