Export Users #

🔑 Need JWT Authorization

Description #

Export user information in the room

Method And Path #

POST /v2/room/export-users

Request #

Header #

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

Body #

{
    "roomUUID": string;
}

roomUUID #

room UUID

• format: uuid-v4

Response #

Success #

HTTP Status Code: 200

{
    status: Status.Success,
    data: {
        roomStartDate: number,
        roomEndDate: number,
        ownerName: string,
        roomTitle: string,
        users: RoomExportUserItem[],
    },
}

Extends Type: Status, RoomExportUserItem

roomStartDate #

The start time of the room

roomEndDate #

The end time of the room

ownerName #

The name of the room owner

roomTitle #

The title of the room

users #

The user information joined the room. Ref: RoomExportUserItem

Failed #

HTTP Status Code: 200

{
    status: Status.Failed,
    code: ErrorCode
}

Extends Type: Status, ErrorCode