AR Live REST API

• ROOM API
  • postRoom 생성(Conference/Call) 통합 ver V2
  • getRoom 리스트 조회
  • postRoom 접속 Token 발급
  • getRoom 상세정보 조회
  • delRoom 삭제
  • patchRoom 수정
  • getAttendee List 조회
  • postAttendee 초대
  • postAttendee 강퇴
  • postRoom 종료
  • postRoom 녹화 시작
  • post회의 녹화 중지
  • post회의 Presenter 설정
  • postData 전송
  • get녹화 파일 리스트 정보제공
  • post호스트 위임
  • postblock user restore
• ROOM API V2
  • postRoom 생성(Conference/Call) 통합 ver V2
  • getRoom 리스트 조회
  • getRoom 상세정보 조회
  • patchRoom 수정
  • delRoom 삭제
  • postRoom 접속 Token 발급
  • postAttendee 강퇴
  • postRoom 종료
  • getAttendee List 조회
  • post회의 Presenter 설정
  • postRoom 녹화 시작
  • post회의 녹화 중지
  • get녹화 파일 리스트 정보제공
• Console
  • getPlatformAdminController_getRooms
  • delPlatformAdminController_deleteRoom
  • getPlatformAdminController_getRoom
  • patchPlatformAdminController_updateRoom
  • postPlatformAdminController_endRoom
  • getPlatformAdminController_getAttendees
  • getPlatformAdminController_getBlockedAttendees
  • postPlatformAdminController_blockAttendees
  • postPlatformAdminController_restoreAttendees
  • getPlatformAdminController_getRoomHistory
  • getPlatformAdminController_getAttendeeHistory
  • postPlatformAdminController_createAppConfig
  • putPlatformAdminController_updateAppConfig
  • getPlatformAdminController_getAppConfig

API docs by Redocly

Maxst Media API Document (v0.1)

Download OpenAPI specification:Download

Maxst Media API

ROOM API

Room 생성(Conference/Call) 통합 ver V2

Room 생성 API, conference 와 instant-call 이 아닌 Room 하나로 통합됨. [created-by] Jimmy [일시] 2023-07-07

Authorizations:

client-token

Request Body schema: application/json

name required	string 방 이름
created_by required	string 회의를 생성한 사람
is_public	boolean Default: true isPublic 이 false 인 경우에는 방에 참가하려면 attendee 목록에 등록되어야 한다. default 값은 true 이다
max_attendee_count	number Default: 30 미팅에 최대로 참여할 수 있는 참석자의 수
attendees	Array of strings 미팅에 참가하는 유저의 id 목록, isPublic 이 false 인 경우에는 방에 참가하려면 attendee 목록에 등록되어야 한다
reserved_start_time	string <date-time> 회의 시작시간
reserved_end_time	string <date-time> 예약 회의 종료시간
description	string Default: ""
is_token_receive	boolean Default: true CALL 와 CONFERENCE 생성시 토큰 반환 여부에 대한 옵션이다. 해당 값이 true 일 시 위의 reservedStartTime 및 reservedEndTime 여부와 관계없이 현재시간 현지사간+1h 로 설정된다.
host_selection_type required	string Enum: "CREATOR" "FIRST_ENTER_USER" 최초접속자를 host로 지정할 것인지 createdBy 를 host로 지정할것인지 판단
is_elect_host required	boolean 호스트가 방안에 없어질 경우 선출을 해야하는지 에 대한 판단여부
is_joinable required	boolean 방에 host 만 접속 가능하게끔(false)혹은 전부가 다 들어올 수 있게끔(true) 결정해주는 값

Responses

https://alpha-api.maxst.com/media/v1/rooms

Request samples

• Payload

Content type

application/json

{

• "name": "test conferences",
• "created_by": "fj1vm23uf-f6eojv23als-fjeslqpopplc",
• "is_public": true,
• "max_attendee_count": 30,
• "attendees": [

  • "fjfkcls-tjkdja12-48pjvaLk"

  ],
• "reserved_start_time": "2022-10-04T10:10:16.765Z",
• "reserved_end_time": "2022-10-04T10:10:16.765Z",
• "description": "해당회의는 ~회의입니다",
• "is_token_receive": true,
• "host_selection_type": "CREATOR",
• "is_elect_host": true,
• "is_joinable": true

}

Response samples

• 200
• default

Content type

application/json

{

• "status": "SUCCESS",
• "data": {

  • "room_id": "fsdfjfdsfa-fdaggdfa-fjo129r7uck",
  • "token": "fabfejiod_dfadf-fdfadgadf-clqa"

  }

}

Room 리스트 조회

Room 리스트들을 조회하는 api 이다 room 의 개략적인 정보 및 방의 status 입장여부까지 제공한다.

Authorizations:

client-token

query Parameters

asc	boolean Example: asc=true 기본으로 desc 로 정렬되는것을 asc 를 true 로 설정시 asc 로 정렬 되어서 반환됨

Responses

https://alpha-api.maxst.com/media/v1/rooms

Response samples

• 200
• default

Content type

application/json

{

• "status": "SUCCESS",
• "data": [

  • {

    • "room_id": "u4ekjfda-1x4jvfj-f1kf2dap4",
    • "name": "임시방",
    • "room_status": "RESERVED",
    • "reserved_start_time": "2022-10-04T10:10:16.765Z",
    • "reserved_end_time": "2022-10-04T10:10:16.765Z",
    • "start_time": "2022-10-04T10:10:16.765Z",
    • "end_time": "2022-10-04T10:10:16.765Z",
    • "max_attendee_count": 30,
    • "is_public": true,
    • "created_by": "fj1vm23uf-f6eojv23als-fjeslqpopplc",
    • "description": "string",
    • "is_joinable": true

    }

  ]

}

Room 접속 Token 발급

Room token 발급 API, 생성된 Room 에 접속하는데 필요한 token 을 발급받을 수 있다.

Authorizations:

client-token

path Parameters

roomId required	string
userId required	string

Request Body schema: application/json

user_name

string livekit 해당 방에서 ParticipantInfo.name 을 설정할 수 있음. 참조: https://docs.livekit.io/server/room-management/#participantinfo

Responses

https://alpha-api.maxst.com/media/v1/rooms/{roomId}/attendees/{userId}/token

Request samples

• Payload

Content type

application/json

{

• "user_name": "tempName"

}

Response samples

• 200
• default

Content type

application/json

{

• "status": "SUCCESS",
• "data": {

  • "token": "fabfejiod_dfadf-fdfadgadf-clqa"

  }

}

Room 상세정보 조회

Room 상세정보 조회 API, Room에대한 생성 정보 및 state , attendees 에 대한 정보들까지 제공한다.

Authorizations:

client-tokenclient-token

path Parameters

roomId required

string

Responses

https://alpha-api.maxst.com/media/v1/rooms/{roomId}

Response samples

• 200
• default

Content type

application/json

{

• "status": "SUCCESS",
• "data": {

  • "room_id": "u4ekjfda-1x4jvfj-f1kf2dap4",
  • "name": "임시방",
  • "room_status": "RESERVED",
  • "reserved_start_time": "2022-10-04T10:10:16.765Z",
  • "reserved_end_time": "2022-10-04T10:10:16.765Z",
  • "start_time": "2022-10-04T10:10:16.765Z",
  • "end_time": "2022-10-04T10:10:16.765Z",
  • "max_attendee_count": 30,
  • "is_public": true,
  • "created_by": "fj1vm23uf-f6eojv23als-fjeslqpopplc",
  • "description": "string",
  • "is_joinable": true,
  • "is_elect_host": true,
  • "host_selection_type": "string",
  • "attendees": [

    • {

      • "user_id": "u4ekjfda-1x4jvfj-f1kf2dap4",
      • "is_host": true,
      • "is_reserved": true,
      • "is_present": true,
      • "is_invited": true

      }

    ],
  • "attendee_count": {

    • "present_count": 3,
    • "reserved_count": 10,
    • "invited_count": 10

    }

  }

}

Room 삭제

Room 삭제 API, call 및 conference 구분 없이 roomId 로만 판단혀여 현재 ROOM STATUS 가 RESERVED 인 룸에대해서만 삭제진행 할 수 있고, 요청자가 host 여야만 정상응답 가능하다.

Authorizations:

client-tokenclient-token

path Parameters

roomId required

string

Request Body schema: application/json

requester_id

string 회의 삭제를 요청한 requester 의 id

Responses

https://alpha-api.maxst.com/media/v1/rooms/{roomId}

Request samples

• Payload

Content type

application/json

{

• "requester_id": "76cfe56a-8ccd-4514-8ced-022323"

}

Response samples

• 200
• default

Content type

application/json

{

• "status": "SUCCESS"

}

Room 수정

Room 에 대한 정보 수정 API, requester 가 host 일 경우에만 방의 정보를 수정할 수 있으며, room의 status 에 따라서 수정할 수 있는 곳이 다르며 해당 내용을 참조하기 바란다.room update 규칙

Authorizations:

client-token

path Parameters

roomId required

string

Request Body schema: application/json

name	string 바꾸고자 하는 room 의 이름으로 room 의 status 가 RESERVED | MEETING 에서만 바꿀 수 있다
description	string 바꾸고자 하는 room 의 description 으로 room 의 status 가 RESERVED | MEETING 에서만 바꿀 수 있다
reserved_start_time	string <date-time> 바꾸고자 하는 room 의 예약 시작시간으로 room 의 status 가 RESERVED 상태에서만 바꿀수 있다
reserved_end_time	string <date-time> 바꾸고자 하는 room 의 예약 시작시간으로 room 의 status 가 RESERVED 상태에서만 바꿀수 있다
is_public	boolean 바꾸고자 하는 room의 공개여부 값으로 room 의 status 가 RESERVED | MEETING 에서만 바꿀 수 있다.
is_joinable	boolean 현재 방에 대해서 입장가능한지에 대해서 확인한다.
requester_id required	string 바꾸고자 하는 roomd의 update 요청을 한 유저의 id

Responses

https://alpha-api.maxst.com/media/v1/rooms/{roomId}

Request samples

• Payload

Content type

application/json

{

• "name": "changed room name",
• "description": "description of changed room",
• "reserved_start_time": "2022-10-04T10:10:16.765Z",
• "reserved_end_time": "2022-10-05T10:10:16.765Z",
• "is_public": true,
• "is_joinable": true,
• "requester_id": "fkdjtjkad-tjlsak-jvkcaos"

}

Response samples

• 200
• default

Content type

application/json

{

• "status": "SUCCESS"

}

Attendee List 조회

방의 attendees 조회 API, 유저들의 리스트를 반환해준다

Authorizations:

client-token

path Parameters

roomId required

string

Responses

https://alpha-api.maxst.com/media/v1/rooms/{roomId}/attendees

Response samples

• 200

Content type

application/json

{

• "status": "SUCCESS",
• "data": [

  • {

    • "user_id": "u4ekjfda-1x4jvfj-f1kf2dap4",
    • "is_host": true,
    • "is_reserved": true,
    • "is_present": true,
    • "is_invited": true

    }

  ]

}

Attendee 초대

attendee 초대 API, 유저를 방에 초대할 수 있는 api 이다.

Authorizations:

client-token

path Parameters

roomId required

string

Request Body schema: application/json

attendees required

Array of strings 초대자들의 userId

Responses

https://alpha-api.maxst.com/media/v1/rooms/{roomId}/attendees

Request samples

• Payload

Content type

application/json

{

• "attendees": [

  • "ljdfal-dopa1jk-1fdaf1m21ldx"

  ]

}

Response samples

• 200
• default

Content type

application/json

{

• "status": "SUCCESS"

}

Attendee 강퇴

attendee 강퇴 API, 특정 유저에 대한 강퇴를 할 수 있으며, requester 가 host 인 경우에만 가능하다.

Authorizations:

client-token

path Parameters

roomId required

string

Request Body schema: application/json

requester_id required	string 추방을 call 한 user의 id
attendees required	Array of strings 추방할 유저의 userId

Responses

https://alpha-api.maxst.com/media/v1/rooms/{roomId}/block

Request samples

• Payload

Content type

application/json

{

• "requester_id": "ljdfal-dopa1jk-1fdaf1m21ldx",
• "attendees": [

  • "ljdfal-dopa1jk-1fdaf1m21ldx"

  ]

}

Response samples

• 200
• default

Content type

application/json

{

• "status": "SUCCESS"

}

Room 종료

Room 종료 API, 방에 대한 종료를 할 수 있으며, requester가 host 인 경우에만 가능하다.

Authorizations:

client-token

path Parameters

roomId required

string

Request Body schema: application/json

requester_id

string 회의 종료를 요청한 requester 의 id

Responses

https://alpha-api.maxst.com/media/v1/rooms/{roomId}/end

Request samples

• Payload

Content type

application/json

{

• "requester_id": "76cfe56a-8ccd-4514-8ced-022323"

}

Response samples

• 200
• default

Content type

application/json

{

• "status": "SUCCESS"

}

Room 녹화 시작

Room 녹화 시작 API, requester 가 host 인 경우에만 요청 할 수 있다.

Authorizations:

client-token

path Parameters

roomId required

string

Request Body schema: application/json

requester_id	string 회의 종료를 요청한 requester 의 id
layout required	string egress room composite 에 저장될 레이아웃 옵션

Responses

https://alpha-api.maxst.com/media/v1/rooms/{roomId}/record

Request samples

• Payload

Content type

application/json

{

• "requester_id": "76cfe56a-8ccd-4514-8ced-022323",
• "layout": "SINGLE_SPEAKER"

}

Response samples

• default

Content type

application/json

{

• "status": "FAIL",
• "message": "sample fail message",
• "error_code": "FAILED_PRECONDITION"

}

회의 녹화 중지

Room 녹화 종료 API, requester 가 host 인 경우에만 요청 할 수 있다.

Authorizations:

client-token

path Parameters

roomId required

string

Request Body schema: application/json

requester_id

string 녹화 종료를 요청한 requester 의 id

Responses

https://alpha-api.maxst.com/media/v1/rooms/{roomId}/stop-record

Request samples

• Payload

Content type

application/json

{

• "requester_id": "76cfe56a-8ccd-4514-8ced-022323"

}

Response samples

• 200
• default

Content type

application/json

{

• "status": "SUCCESS"

}

회의 Presenter 설정

회의 presenter 지정 API, requester 가 host 인 경우에만 요청할 수 있다.

Authorizations:

client-token

path Parameters

roomId required

string

Request Body schema: application/json

requester_id required	string update presentor api 를 요청한 유저의 id
user_id required	string 대표화면으로 설정될 user의 Id, Livekit의 room의 metadata가 적용된다. required=true 로 변경될 예정. metadata는 JSON.stringfy({presenter:{userId}}) 가 반영된다. 참조: https://docs.livekit.io/server/room-management/#room

Responses

https://alpha-api.maxst.com/media/v1/rooms/{roomId}/update-presenter

Request samples

• Payload

Content type

application/json

{

• "requester_id": "ljdfal-dopa1jk-1fdaf1m21ldx",
• "user_id": "fkdjtjkad-tjlsak-jvkcaos"

}

Response samples

• 200
• default

Content type

application/json

{

• "status": "SUCCESS"

}

Data 전송

Authorizations:

client-token

path Parameters

roomId required

string

Request Body schema: application/json

from	string (data를 전송한 참여자 userId)
to	Array of strings (특정 참여자에게만 data 를 전달하고 싶은 경우에 참가자들을 list 형식으로 설정, 빈 경우에는 해당 방의 모든 참여자에게 data 가 전송된다) 수신자 userId들의 array 형식, 필수값은 아니다. 비어 있는 경우 방 전체에 publish 된다.
data required	string datachannel을 이용해 해당 방에 pub 할 data 를 string type 으로 설정한다.

Responses

https://alpha-api.maxst.com/media/v1/rooms/{roomId}/publish-data

Request samples

• Payload

Content type

application/json

{

• "from": "fabfejiod_dfadf-fdfadgadf-clqa",
• "to": [

  • "fabfejiod_dfadf-fdfadgadf-clqa",
  • "aciejjiod_dfadf-fsjcngadf-xhek"

  ],
• "data": "string"

}

Response samples

• 200
• default

Content type

application/json

{

• "status": "SUCCESS",
• "data": {

  • "id": "ljsdf-wuiower-slkj"

  }

}

녹화 파일 리스트 정보제공

녹화 파일 리스트 정보제공 API, 파일 크기(byte) 시간(nano-second), filePath 값을 제공해준다.

Authorizations:

client-token

path Parameters

roomId required

string

Responses

https://alpha-api.maxst.com/media/v1/rooms/{roomId}/recordings

Response samples

• 200
• default

Content type

application/json

{

• "status": "SUCCESS",
• "data": [

  • {

    • "file_name": "livekit/xxx/xxxdfefadffe-23241213.mp4",
    • "file_size": 23123421321,
    • "duration": 231234213212

    }

  ]

}

호스트 위임

호스트가 현재 본인의 host 권한을 일반 유저에게 위임할 수 있다.

Authorizations:

client-token

path Parameters

roomId required

string

Request Body schema: application/json

requester_id required	string 호스트를 위임 api 를 요청한 요청자
user_id required	string 호스트를 위임 하려는 attendee의 id

Responses

https://alpha-api.maxst.com/media/v1/rooms/{roomId}/delegate

Request samples

• Payload

Content type

application/json

{

• "requester_id": "ljdfal-dopa1jk-1fdaf1m21ldx",
• "user_id": "fsfda2al-d30la1jk-1fl1m893x"

}

Response samples

• 200
• default

Content type

application/json

{

• "status": "SUCCESS"

}

block user restore

현재 추방당한 유저들에 한정하여 방의 접속권한을 다시 받도록 할 수 있도록 한다.

Authorizations:

client-token

path Parameters

roomId required

string

Request Body schema: application/json

requester_id required	string restore를 call 한 user의 id
attendees required	Array of strings block 상태를 해제시킬 userId 목록

Responses

https://alpha-api.maxst.com/media/v1/rooms/{roomId}/restore

Request samples

• Payload

Content type

application/json

{

• "requester_id": "ljdfal-dopa1jk-1fdaf1m21ldx",
• "attendees": [

  • "ljdfal-dopa1jk-1fdaf1m21ldx"

  ]

}

Response samples

• 200
• default

Content type

application/json

{

• "status": "SUCCESS"

}

ROOM API V2

Room 생성(Conference/Call) 통합 ver V2

Room 생성 API, V1에서 필수항목들이 빠짐. [created-by] Jimmy [일시] 2023-07-07

Authorizations:

client-token

Request Body schema: application/json

name required	string 방 이름
created_by required	string 회의를 생성한 사람
max_attendee_count	number Default: 30 미팅에 최대로 참여할 수 있는 참석자의 수
reserved_start_time	string <date-time> 회의 시작시간
reserved_end_time	string <date-time> 예약 회의 종료시간
description	string Default: ""
password	string
required	object (AlertPropertyV2)

Responses

https://alpha-api.maxst.com/media/v2/rooms

Request samples

• Payload

Content type

application/json

{

• "name": "test conferences",
• "created_by": "fj1vm23uf-f6eojv23als-fjeslqpopplc",
• "max_attendee_count": 30,
• "reserved_start_time": "2022-10-04T10:10:16.765Z",
• "reserved_end_time": "2022-10-04T10:10:16.765Z",
• "description": "해당회의는 ~회의입니다",
• "password": "abcde",
• "alert": {

  • "method": "EMAIL",
  • "emailList": [

    • "aaa@xxx.com",
    • "bbb@xxx.com"

    ]

  }

}

Response samples

• 200
• default

Content type

application/json

{

• "status": "SUCCESS",
• "data": {

  • "room_id": "fsdfjfdsfa-fdaggdfa-fjo129r7uck"

  }

}

Room 리스트 조회

Room 리스트들을 조회하는 api 이다 room 의 개략적인 정보 및 방의 status 입장여부까지 제공한다.

Authorizations:

client-token

query Parameters

asc	boolean Example: asc=true 기본으로 desc 로 정렬되는것을 asc 를 true 로 설정시 asc 로 정렬 되어서 반환됨

Responses

https://alpha-api.maxst.com/media/v2/rooms

Response samples

• 200
• default

Content type

application/json

{

• "status": "SUCCESS",
• "data": [

  • {

    • "room_id": "u4ekjfda-1x4jvfj-f1kf2dap4",
    • "name": "임시방",
    • "room_status": "RESERVED",
    • "reserved_start_time": "2022-10-04T10:10:16.765Z",
    • "reserved_end_time": "2022-10-04T10:10:16.765Z",
    • "start_time": "2022-10-04T10:10:16.765Z",
    • "end_time": "2022-10-04T10:10:16.765Z",
    • "max_attendee_count": 30,
    • "description": "string",
    • "use_password": true,
    • "created_by": "string"

    }

  ]

}

Room 상세정보 조회

Room 상세정보 조회 API, Room에대한 생성 정보 및 state , attendees 에 대한 정보들까지 제공한다.

Authorizations:

client-tokenclient-token

path Parameters

roomId required

string

Responses

https://alpha-api.maxst.com/media/v2/rooms/{roomId}

Response samples

• 200
• default

Content type

application/json

{

• "status": "SUCCESS",
• "data": {

  • "room_id": "u4ekjfda-1x4jvfj-f1kf2dap4",
  • "name": "임시방",
  • "room_status": "RESERVED",
  • "reserved_start_time": "2022-10-04T10:10:16.765Z",
  • "reserved_end_time": "2022-10-04T10:10:16.765Z",
  • "start_time": "2022-10-04T10:10:16.765Z",
  • "end_time": "2022-10-04T10:10:16.765Z",
  • "max_attendee_count": 30,
  • "created_by": "fj1vm23uf-f6eojv23als-fjeslqpopplc",
  • "description": "string",
  • "use_password": true

  }

}

Room 수정

Room 에 대한 정보 수정 API, requester 가 creator 일 경우에만 방의 정보를 수정할 수 있으며, room의 status 에 따라서 수정할 수 있는 곳이 다르다. V1 에서 isPublic isJoinable 삭제되었다.

Authorizations:

client-token

path Parameters

roomId required

string

Request Body schema: application/json

name	string 바꾸고자 하는 room 의 이름으로 room 의 status 가 RESERVED | MEETING 에서만 바꿀 수 있다
description	string 바꾸고자 하는 room 의 description 으로 room 의 status 가 RESERVED | MEETING 에서만 바꿀 수 있다
reserved_start_time	string <date-time> 바꾸고자 하는 room 의 예약 시작시간으로 room 의 status 가 RESERVED 상태에서만 바꿀수 있다
reserved_end_time	string <date-time> 바꾸고자 하는 room 의 예약 시작시간으로 room 의 status 가 RESERVED 상태에서만 바꿀수 있다
requester_id required	string 바꾸고자 하는 roomd의 update 요청을 한 유저의 id

Responses

https://alpha-api.maxst.com/media/v2/rooms/{roomId}

Request samples

• Payload

Content type

application/json

{

• "name": "changed room name",
• "description": "description of changed room",
• "reserved_start_time": "2022-10-04T10:10:16.765Z",
• "reserved_end_time": "2022-10-05T10:10:16.765Z",
• "requester_id": "fkdjtjkad-tjlsak-jvkcaos"

}

Response samples

• 200
• default

Content type

application/json

{

• "status": "SUCCESS"

}

Room 삭제

Room 삭제 API, ROOM STATUS 가 RESERVED 인 룸에대해서만 삭제진행 할 수 있고, 요청자가 creator 여야만 정상응답 가능하다.

Authorizations:

client-tokenclient-token

path Parameters

roomId required

string

Request Body schema: application/json

requester_id

string 회의 삭제를 요청한 requester 의 id

Responses

https://alpha-api.maxst.com/media/v2/rooms/{roomId}

Request samples

• Payload

Content type

application/json

{

• "requester_id": "76cfe56a-8ccd-4514-8ced-022323"

}

Response samples

• 200
• default

Content type

application/json

{

• "status": "SUCCESS"

}

Room 접속 Token 발급

Room token 발급 API, 생성된 Room 에 접속하는데 필요한 token 을 발급받을 수 있다.

Authorizations:

client-token

path Parameters

roomId required

string

Request Body schema: application/json

user_id	string room 에서 의 user 식별자로 , 빈칸으로 submit 시 서버에서 uuid 값을 만들어서 제공
user_name	string livekit 해당 방에서 ParticipantInfo.name 을 설정할 수 있음. 참조: https://docs.livekit.io/server/room-management/#participantinfo
password	string 방에 password 가 걸려있을 경우 해당하는 방의 값의 password 를 넣어준다.

Responses

https://alpha-api.maxst.com/media/v2/rooms/{roomId}/token

Request samples

• Payload

Content type

application/json

{

• "user_id": "12opakdf-19Djdlw823-fjvnm13rks",
• "user_name": "tempName",
• "password": "12344"

}

Response samples

• 200
• default

Content type

application/json

{

• "status": "SUCCESS",
• "data": {

  • "token": "fabfejiod_dfadf-fdfadgadf-clqa",
  • "user_id": "32o9ejiod_pqvdf14-dftecqf-c92v"

  }

}

Attendee 강퇴

attendee 강퇴 API, 특정 유저에 대한 강퇴를 할 수 있으며, requester 가 creator 인 경우에만 가능하다.

Authorizations:

client-token

path Parameters

roomId required

string

Request Body schema: application/json

requester_id required	string 추방을 call 한 user의 id
attendee required	string 추방할 유저의 userId

Responses

https://alpha-api.maxst.com/media/v2/rooms/{roomId}/block

Request samples

• Payload

Content type

application/json

{

• "requester_id": "ljdfal-dopa1jk-1fdaf1m21ldx",
• "attendee": "ljdfal-dopa1jk-1fdaf1m21ldx"

}

Response samples

• 200
• default

Content type

application/json

{

• "status": "SUCCESS"

}

Room 종료

Room 종료 API, 방에 대한 종료를 할 수 있으며, requester가 Creator 인 경우에만 가능하다.

Authorizations:

client-token

path Parameters

roomId required

string

Request Body schema: application/json

requester_id

string 회의 종료를 요청한 requester 의 id

Responses

https://alpha-api.maxst.com/media/v2/rooms/{roomId}/end

Request samples

• Payload

Content type

application/json

{

• "requester_id": "76cfe56a-8ccd-4514-8ced-022323"

}

Response samples

• 200
• default

Content type

application/json

{

• "status": "SUCCESS"

}

Attendee List 조회

방의 attendees 조회 API, 유저들의 리스트 (v1 과 달리 block 된 유저를 포함 하여 ) 참석 여부를 반환해준다

Authorizations:

client-token

path Parameters

roomId required

string

Responses

https://alpha-api.maxst.com/media/v2/rooms/{roomId}/attendees

Response samples

• 200

Content type

application/json

{

• "status": "SUCCESS",
• "data": [

  • {

    • "user_id": "u4ekjfda-1x4jvfj-f1kf2dap4",
    • "is_present": true

    }

  ]

}

회의 Presenter 설정

회의 presenter 지정 API, requester 가 creator 인 경우에만 요청할 수 있다.

Authorizations:

client-token

path Parameters

roomId required

string

Request Body schema: application/json

requester_id required	string update presentor api 를 요청한 유저의 id
target_user_id required	string 대표화면으로 설정될 user의 Id 값으로 해당 userId 의 화면을 presetner 로 업데이트한다. 다만 값을 넣지 않았을 경우 빈값으로 설정되어 현재 presentor 정보를 Flush 한다.`

Responses

https://alpha-api.maxst.com/media/v2/rooms/{roomId}/update-presenter

Request samples

• Payload

Content type

application/json

{

• "requester_id": "ljdfal-dopa1jk-1fdaf1m21ldx",
• "target_user_id": "fkdjtjkad-tjlsak-jvkcaos"

}

Response samples

• 200
• default

Content type

application/json

{

• "status": "SUCCESS"

}

Room 녹화 시작

Room 녹화 시작 API, requester 가 host 인 경우에만 요청 할 수 있다. 방을 생성한 생성자만이 해당 Api 에 정상응답

Authorizations:

client-token

path Parameters

roomId required

string

Request Body schema: application/json

requester_id	string 회의 종료를 요청한 requester 의 id
layout required	string egress room composite 에 저장될 레이아웃 옵션

Responses

https://alpha-api.maxst.com/media/v2/rooms/{roomId}/record

Request samples

• Payload

Content type

application/json

{

• "requester_id": "76cfe56a-8ccd-4514-8ced-022323",
• "layout": "SINGLE_SPEAKER"

}

Response samples

• 200
• default

Content type

application/json

{

• "status": "SUCCESS"

}

회의 녹화 중지

Room 녹화 종료 API, requester 가 Creator 인 경우에만 요청 할 수 있다.

Authorizations:

client-token

path Parameters

roomId required

string

Request Body schema: application/json

requester_id

string 녹화 종료를 요청한 requester 의 id

Responses

https://alpha-api.maxst.com/media/v2/rooms/{roomId}/stop-record

Request samples

• Payload

Content type

application/json

{

• "requester_id": "76cfe56a-8ccd-4514-8ced-022323"

}

Response samples

• 200
• default

Content type

application/json

{

• "status": "SUCCESS"

}

녹화 파일 리스트 정보제공

녹화 파일 리스트 정보제공 API, 파일 크기(byte) 시간(nano-second), filePath, 유효기간(valid_at) 값을 제공해준다.

Authorizations:

client-token

path Parameters

roomId required

string

Responses

https://alpha-api.maxst.com/media/v2/rooms/{roomId}/recordings

Response samples

• 200
• default

Content type

application/json

{

• "status": "SUCCESS",
• "data": [

  • {

    • "file_name": "livekit/xxx/xxxdfefadffe-23241213.mp4",
    • "file_size": 23123421321,
    • "duration": 231234213212,
    • "valid_at": "2023-11-06T04:55:42"

    }

  ]

}

Console

PlatformAdminController_getRooms

Authorizations:

client-token

path Parameters

applicationId required

string

query Parameters

page required	number Example: page=1
size required	number Example: size=10
asc	boolean Example: asc=true

Responses

https://alpha-api.maxst.com/media/v1/application/{applicationId}/rooms

PlatformAdminController_deleteRoom

Authorizations:

client-token

path Parameters

applicationId required

string

Request Body schema: application/json

room_ids required

Array of strings

Responses

https://alpha-api.maxst.com/media/v1/application/{applicationId}/rooms

Request samples

• Payload

Content type

application/json

{

• "room_ids": [

  • "fa417146-9095-4f51-9315-be7389e1effc"

  ]

}

PlatformAdminController_getRoom

Authorizations:

client-token

path Parameters

roomId required	string
applicationId required	string

Responses

https://alpha-api.maxst.com/media/v1/application/{applicationId}/rooms/{roomId}

PlatformAdminController_updateRoom

Authorizations:

client-token

path Parameters

roomId required	string
applicationId required	string

Request Body schema: application/json

name	string 바꾸고자 하는 room 의 이름으로 room 의 status 가 RESERVED | MEETING 에서만 바꿀 수 있다
description	string 바꾸고자 하는 room 의 description 으로 room 의 status 가 RESERVED | MEETING 에서만 바꿀 수 있다
reserved_start_time	string <date-time> 바꾸고자 하는 room 의 예약 시작시간으로 room 의 status 가 RESERVED 상태에서만 바꿀수 있다
reserved_end_time	string <date-time> 바꾸고자 하는 room 의 예약 시작시간으로 room 의 status 가 RESERVED 상태에서만 바꿀수 있다
is_public	boolean 바꾸고자 하는 room의 공개여부 값으로 room 의 status 가 RESERVED | MEETING 에서만 바꿀 수 있다.
is_joinable	boolean 현재 방에 대해서 입장가능한지에 대해서 확인한다.

Responses

https://alpha-api.maxst.com/media/v1/application/{applicationId}/rooms/{roomId}

Request samples

• Payload

Content type

application/json

{

• "name": "changed room name",
• "description": "description of changed room",
• "reserved_start_time": "2022-10-04T10:10:16.765Z",
• "reserved_end_time": "2022-10-05T10:10:16.765Z",
• "is_public": true,
• "is_joinable": true

}

PlatformAdminController_endRoom

Authorizations:

client-token

path Parameters

roomId required	string
applicationId required	string

Responses

https://alpha-api.maxst.com/media/v1/application/{applicationId}/rooms/{roomId}/end

PlatformAdminController_getAttendees

Authorizations:

client-token

path Parameters

roomId required	string
applicationId required	string

query Parameters

page required	number Example: page=1
size required	number Example: size=10

Responses

https://alpha-api.maxst.com/media/v1/application/{applicationId}/rooms/{roomId}/attendees

PlatformAdminController_getBlockedAttendees

Authorizations:

client-token

path Parameters

roomId required	string
applicationId required	string

query Parameters

page required	number Example: page=1
size required	number Example: size=10

Responses

https://alpha-api.maxst.com/media/v1/application/{applicationId}/rooms/{roomId}/blocked-attendees

PlatformAdminController_blockAttendees

Authorizations:

client-token

path Parameters

roomId required	string
applicationId required	string

Request Body schema: application/json

object (PlatformAdminBlockAttendeesRequest)

Responses

https://alpha-api.maxst.com/media/v1/application/{applicationId}/rooms/{roomId}/block

Request samples

• Payload

Content type

application/json

{ }

PlatformAdminController_restoreAttendees

Authorizations:

client-token

path Parameters

roomId required	string
applicationId required	string

Request Body schema: application/json

object (PlatformAdminRestoreAttendeesRequest)

Responses

https://alpha-api.maxst.com/media/v1/application/{applicationId}/rooms/{roomId}/restore

Request samples

• Payload

Content type

application/json

{ }

PlatformAdminController_getRoomHistory

Authorizations:

client-token

path Parameters

applicationId required

string

query Parameters

event_type	string Example: event_type=CREATED CREATED , UPDATED , STATUS_UPDATED , DELETED
user_id	string Example: user_id=19kladae-edcb-090b-8fs15-1fs15a65cea7b

Responses

https://alpha-api.maxst.com/media/v1/application/{applicationId}/history/rooms

PlatformAdminController_getAttendeeHistory

Authorizations:

client-token

path Parameters

applicationId required

string

query Parameters

event_type	string Example: event_type=ENTER ENTER : 유저입장 , LEFT : 유저퇴장
user_id	string Example: user_id=19kladae-edcb-090b-8fs15-1fs15a65cea7b

Responses

https://alpha-api.maxst.com/media/v1/application/{applicationId}/history/attendees

PlatformAdminController_createAppConfig

Authorizations:

client-token

path Parameters

applicationId required

string

Request Body schema: application/json

config_max_attendee_count	number 최대입장 가능인원 수
config_is_joinable_view	boolean 방에 입장가능 하게 할건지 아닌지를 판별
config_host_selection_type	string 호스트 선정 로직 CREATOR : 생성자가 호스트 FIRST_ENTER_USER : 첫번째로 들어온 유저가 호스트
config_is_elect_host	boolean 방에서 호스트가 나갔을 경우 호스트를 선출 할 것인지 판단 아닐경우 방을 폭파
config_is_download_record	boolean 일반유저가 영상을 다운로드 할 수 있을지 판별

Responses

https://alpha-api.maxst.com/media/v1/application/{applicationId}/app-config

Request samples

• Payload

Content type

application/json

{

• "config_max_attendee_count": 30,
• "config_is_joinable_view": true,
• "config_host_selection_type": "CREATOR",
• "config_is_elect_host": true,
• "config_is_download_record": true

}

PlatformAdminController_updateAppConfig

Authorizations:

client-token

path Parameters

applicationId required

string

Request Body schema: application/json

config_max_attendee_count	number 최대입장 가능인원 수
config_is_joinable_view	boolean 방에 입장가능 하게 할건지 아닌지를 판별
config_host_selection_type	string 호스트 선정 로직 CREATOR : 생성자가 호스트 FIRST_ENTER_USER : 첫번째로 들어온 유저가 호스트
config_is_elect_host	boolean 방에서 호스트가 나갔을 경우 호스트를 선출 할 것인지 판단 아닐경우 방을 폭파
config_is_download_record	boolean 일반유저가 영상을 다운로드 할 수 있을지 판별

Responses

https://alpha-api.maxst.com/media/v1/application/{applicationId}/app-config

Request samples

• Payload

Content type

application/json

{

• "config_max_attendee_count": 30,
• "config_is_joinable_view": true,
• "config_host_selection_type": "CREATOR",
• "config_is_elect_host": true,
• "config_is_download_record": true

}

PlatformAdminController_getAppConfig

Authorizations:

client-token

path Parameters

applicationId required

string

Responses

https://alpha-api.maxst.com/media/v1/application/{applicationId}/app-config