Skip to main content

Chat REST API

API docs by Redocly

Maxst Chat API (v1.0.0)

Download OpenAPI specification:Download

Maxst Chat API

ChatRoom

채팅방 관련 기능

채팅방 생성

채팅방 만들기 기능

Authorizations:
Authorization
Request Body schema: application/json
chat_room_type
required
string
Enum: "OPEN" "GROUP"

채팅방 타입

title
string

채팅방 제목

operator_ids
Array of strings

채팅방 관리자 고유ID 리스트

user_ids
Array of strings

채팅방 구성원 고유ID 리스트

is_public
boolean

Responses

Request samples

Content type
application/json
{
  • "chat_room_type": "GROUP",
  • "title": "Finn이 만든 채팅방 입니다.",
  • "operator_ids": [
    ],
  • "user_ids": [
    ],
  • "is_public": true
}

Response samples

Content type
*/*
{
  "status": "error",
  "error": {
    "message": "unexpected exception"
  }
}

채팅방 참여(Join)

선택한 채팅방에 접속기능

Authorizations:
Authorization
path Parameters
room_uuid
required
string [ 35 .. 2147483647 ] characters

채팅방_UUID

query Parameters
user_id
required
string

Responses

Response samples

Content type
*/*
{
  "status": "error",
  "error": {
    "message": "unexpected exception"
  }
}

채팅방 나가기

선택한 채팅방에서 나가기

Authorizations:
Authorization
path Parameters
room_uuid
required
string [ 35 .. 2147483647 ] characters
query Parameters
user_id
required
string

Responses

Response samples

Content type
*/*
{
  "status": "error",
  "error": {
    "message": "unexpected exception"
  }
}

채팅방 유저 목록 조회

채팅방에 참여중인 유저 고유아이디를 목록으로 조회

Authorizations:
Authorization
path Parameters
room_uuid
required
string [ 35 .. 2147483647 ] characters

채팅방_UUID

Responses

Response samples

Content type
*/*
{
  "status": "error",
  "error": {
    "message": "unexpected exception"
  }
}

계정별 참여중인 채팅방 목록 조회

향후 채팅방 타입별로 채팅방을 조회(현재는 타입구분없이 조회)

Authorizations:
Authorization
query Parameters
user_id
required
string
sort_enum
required
string
Enum: "ID_ASC" "ID_DESC" "TITLE_ASC" "TITLE_DESC"

정렬값 선택( 기본값 TITLE,ASC )

Responses

Response samples

Content type
*/*
{
  "status": "error",
  "error": {
    "message": "unexpected exception"
  }
}

채팅방 목록 조회

향후 채팅방 타입별로 채팅방을 조회(현재는 타입구분없이 조회)

Authorizations:
Authorization
query Parameters
sort_enum
required
string
Enum: "ID_ASC" "ID_DESC" "TITLE_ASC" "TITLE_DESC"

정렬값 선택( 기본값 TITLE,ASC )

Responses

Response samples

Content type
*/*
{
  "status": "error",
  "error": {
    "message": "unexpected exception"
  }
}

채팅방 삭제 (채널 운영자만 삭제 가능)

채팅방 삭제 기능 (참여인원이 있을때 채팅방 삭제와 내보내기 동시 실행)

Authorizations:
Authorization
path Parameters
room_uuid
required
string [ 35 .. 2147483647 ] characters
query Parameters
user_id
required
string

Responses

Response samples

Content type
*/*
{
  "status": "error",
  "error": {
    "message": "unexpected exception"
  }
}