VeryChat WebSocket API Docs 2.0.0

Operations

• RECEIVE /

  Operation IDChatReceiver

  Channel specific informationws

  Expand all

  object

  query

  Expand all

  object

  Login서버로 부터 발급 받은 JWT Token

  auth

  required

  string

  유저 인증을 위한 JWT Token

  Const:"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjE3OCwic25zSWQiOiIxMDU5ODY2MzcwODc3NDA5MzM5NDUiLCJlbWFpbCI6InNpYS55QHZlcnljaGF0LmlvIiwibmlja25hbWUiOiLsi5zslYQiLCJjb3VudHJ5Q29kZSI6IktSIiwibG9naW5BdCI6MTcyNjIxNzM3NTE3OCwibG9naW5WZXJzaW9uIjoiMi4wLjAiLCJpYXQiOjE3MjYyMTczNzUsImV4cCI6MjA0MTc5MzM3NX0.WDmAZ4BZ6IXZBD_mspvidEwzRPECWfonwzQQ5pWStEg"

  force_logout

  boolean

  해당 디바이스의 유저 강제 종료를 위한 QUERY

  Additional properties are allowed.

  Accepts the following message:

  채팅을 전달받기 위한 Event Listener

  Message IDuser_receive

  Payload

  Expand all

  oneOf

  Adheres to 메세지 Receive Payload:

  Expand all

  object [메세지 Receive Payload]

  메세지 수신시 받는 Object

  message

  Expand all

  required

  object [GetMessages Callback Payload]

  createdAt

  string

  deletedAt

  string

  mentions

  Expand all

  array<integer>

  유저 아이디 배열

  Items:

  integer

  message

  string

  reply

  number

  Reply Message Seq

  seq

  integer

  type

  string

  Allowed values:
  • "text"
  • "image"
  • "video"
  • "file"

  userId

  integer

  Additional properties are allowed.

  roomId

  string

  채팅방에서 수신시 roomId

  channelId

  string

  채널에서 수신시 channelId

  type

  string

  Allowed values:
  • "MESSAGE"

  channelChat

  boolean

  채널 채팅방에서 수신한 메세지인지 여부

  Additional properties are allowed.

  Or to 읽음 Receive Payload:

  Expand all

  object [읽음 Receive Payload]

  roomId

  string

  채팅방에서 수신시 roomId

  channelId

  string

  채널에서 수신시 channelId

  readers

  Expand all

  object

  userId

  integer

  위 정수는 해당 유저의 LastReadSeq [userId:lastReadSeq의 형태]

  Additional properties are allowed.

  type

  string

  Allowed values:
  • "READ"

  Additional properties are allowed.

  Or to 리액션 Receive Payload:

  Expand all

  object [리액션 Receive Payload]

  Reaction StreamId는 로컬에 저장하여 roomInfo시 받는 streamId와 비교하여 작으면 getReaction요청

  reactions

  Expand all

  object

  roomId

  string

  채팅방에서 수신시 roomId

  channelId

  string

  채널에서 수신시 channelId

  reactionCode

  string

  seq

  integer

  streamId

  integer

  userId

  integer

  Additional properties are allowed.

  type

  string

  Allowed values:
  • "REACTION"

  Additional properties are allowed.

  Or to 메세지 수정 Receive Payload:

  Expand all

  object [메세지 수정 Receive Payload]

  메세지 수정 Receive Payload

  message

  string

  roomId

  string

  채팅방에서 수신시 roomId

  channelId

  string

  채널에서 수신시 channelId

  seq

  integer

  type

  string

  Allowed values:
  • "MESSAGE_EDIT"

  userId

  integer

  channelChat

  boolean

  채널 채팅방에서 수신한 메세지인지 여부

  Additional properties are allowed.

  Or to 메세지 삭제 Receive Payload:

  Expand all

  object [메세지 삭제 Receive Payload]

  메세지 삭제 Receive Payload

  roomId

  string

  채팅방에서 수신시 roomId

  channelId

  string

  채널에서 수신시 channelId

  seq

  integer

  type

  string

  Allowed values:
  • "MESSAGE_DELETE"

  userId

  integer

  channelChat

  boolean

  채널 채팅방에서 수신한 메세지인지 여부

  Additional properties are allowed.

  Or to 채널 삭제 Receive Payload:

  Expand all

  object [채널 삭제 Receive Payload]

  channelId

  string

  event

  string

  Allowed values:
  • "DESTROYED_CHANNEL"

  Additional properties are allowed.

  Or to 채널 소유자 변경 Receive Payload:

  Expand all

  object [채널 소유자 변경 Receive Payload]

  channelId

  string

  userId

  integer

  변경된 유저 아이디

  event

  string

  Allowed values:
  • "CHANGED_CHANNEL_OWNER"

  Additional properties are allowed.

  Extensions

  x-socketio-event

  user

  Examples

  Payload

  {
    "message": {
      "createdAt": "string",
      "deletedAt": "string",
      "mentions": [
        0
      ],
      "message": "string",
      "reply": 0,
      "seq": 0,
      "type": "text",
      "userId": 0
    },
    "roomId": "string",
    "channelId": "string",
    "type": "MESSAGE",
    "channelChat": true
  }
  

  This example has been generated automatically.

• SEND /

  Operation IDChatRoomSender

  Channel specific informationws

  Expand all

  object

  query

  Expand all

  object

  Login서버로 부터 발급 받은 JWT Token

  auth

  required

  string

  유저 인증을 위한 JWT Token

  Const:"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjE3OCwic25zSWQiOiIxMDU5ODY2MzcwODc3NDA5MzM5NDUiLCJlbWFpbCI6InNpYS55QHZlcnljaGF0LmlvIiwibmlja25hbWUiOiLsi5zslYQiLCJjb3VudHJ5Q29kZSI6IktSIiwibG9naW5BdCI6MTcyNjIxNzM3NTE3OCwibG9naW5WZXJzaW9uIjoiMi4wLjAiLCJpYXQiOjE3MjYyMTczNzUsImV4cCI6MjA0MTc5MzM3NX0.WDmAZ4BZ6IXZBD_mspvidEwzRPECWfonwzQQ5pWStEg"

  force_logout

  boolean

  해당 디바이스의 유저 강제 종료를 위한 QUERY

  Additional properties are allowed.

  Accepts the following message:

  채팅방 관련 처리를 위한 EventName

  Message IDchat_room

  Payload

  Expand all

  oneOf

  Adheres to 채팅방 정보 API:

  Expand all

  object [채팅방 정보 API]

  해당 방의 정보를 가져오기 위한 API

  command

  required

  string

  Allowed values:
  • "info"

  roomId

  required

  string

  접속한 방의 Id

  Extensions

  x-socketio-ack

  Expand all

  object [채팅방 정보 Callback Payload]

  description

  string

  dmMembers

  Expand all

  array<integer>

  유저 아이디 배열

  Items:

  integer

  holdMessageSeq

  integer

  joinUserCount

  integer

  lastMessageSeq

  integer

  최근 메세지의 Seq

  lastStreamId

  integer

  Reaction History StreamId [ 리액션 조회에 사용 0이면 저장된 History X]

  maxUserCount

  integer

  ownerId

  string

  roomId

  string

  roomType

  string

  Allowed values:
  • "DM"
  • "GROUP"

  thumbnailUrl

  string

  title

  string

  Additional properties are allowed.

  Additional properties are allowed.

  Or to GetMembers API:

  Expand all

  object [GetMembers API]

  해당 방에 접속한 Members를 가져오기 위한 API [DM/GROUPCHAT]만 사용 가능
  여기서 받은 데이터는 {UserId:LastReadSeq} 형식을 띄고 있어 해당 값으로 unreadCount 값 계산

  command

  required

  string

  Allowed values:
  • "get_members"

  roomId

  required

  string

  접속한 방의 Id

  Extensions

  x-socketio-ack

  Expand all

  object [GetMembers Callback Payload]

  userId

  integer

  위 정수는 해당 유저의 LastReadSeq

  Additional properties are allowed.

  Additional properties are allowed.

  Or to GetMessages API:

  Expand all

  object [GetMessages API]

  해당 방의 메세지를 불러오기 위해 사용
  기본적으로 받은 메세지들은 Local에서 관리 하고 필요한 경우에[오프라인중 FireBasePush를 못받는경우](EX/ NetworkIssue)
  로컬 디바이스에 저장된 Seq와 해당 방의 last seq를 비교하여 없는만큼 메세지를 불러오기 위한 API
  메세지는 전달받은 seq를 기준으로 최대 100개까지 개수는 지정 가능

  command

  required

  string

  Allowed values:
  • "get_messages"

  roomId

  required

  string

  접속한 방의 Id

  seq

  required

  integer

  Message Seq

  take

  integer

  가져올 메세지 개수 [최대 100개] / Default : 100

  Extensions

  x-socketio-ack

  Expand all

  object [GetMessages Callback Payload]

  createdAt

  string

  deletedAt

  string

  mentions

  Expand all

  array<integer>

  유저 아이디 배열

  Items:

  integer

  message

  string

  reply

  number

  Reply Message Seq

  seq

  integer

  type

  string

  Allowed values:
  • "text"
  • "image"
  • "video"
  • "file"

  userId

  integer

  Additional properties are allowed.

  Additional properties are allowed.

  Or to GetReactions API:

  Expand all

  object [GetReactions API]

  해당 방의 StreamId를 기반으로 Reaction History를 불러옴 방에 접속 시, 방의 정보를 가져와서 lastStreamId와 로컬에 저장된 StreamId를 비교 lastStreamId보다 작다면 서버에 요청 next값이 true이면 더 요청할 값이 있다는 뜻이므로 로컬 StreamId를 갱신하고 해당 값으로 한번 더 요청

  command

  required

  string

  Allowed values:
  • "get_reactions"

  roomId

  required

  string

  접속한 방의 Id

  streamId

  required

  integer

  저장된 StreamId

  Extensions

  x-socketio-ack

  Expand all

  object [GetReactions Callback Payload]

  historys

  Expand all

  array<object>

  유저 아이디 배열

  object

  reactionCode

  string

  seq

  integer

  userId

  integer

  Additional properties are allowed.

  next

  boolean

  다음 값이 더 있음[최대 100개씩 가져옴]

  Additional properties are allowed.

  Additional properties are allowed.

  Or to 채팅방 생성 API:

  Expand all

  object [채팅방 생성 API]

  채팅방 생성을 위한 API

  command

  required

  string

  Allowed values:
  • "create"

  members

  Expand all

  required

  array<integer>

  유저 아이디 배열 [한번 초대에 최대 100명]

  Items:

  integer

  roomType

  required

  string

  RoomType 별 인원제한:
  DM: 2
  GROUP: 100

  Allowed values:
  • "DM"
  • "GROUP"

  title

  string

  Room Title

  Extensions

  x-socketio-ack

  Expand all

  object [채팅방 생성 Callback Payload]

  roomId

  string

  Additional properties are allowed.

  Additional properties are allowed.

  Or to 유저 초대 API:

  Expand all

  object [유저 초대 API]

  유저를 해당 방에 초대하기 위한 API

  command

  required

  string

  Allowed values:
  • "invite"

  members

  Expand all

  required

  array<integer>

  유저 아이디 배열 [한번 초대에 최대 100명]

  Items:

  integer

  Extensions

  x-socketio-ack

  true

  Additional properties are allowed.

  Or to 퇴장 API:

  Expand all

  object [퇴장 API]

  해당방에서 퇴장하기 위한 API

  command

  required

  string

  Allowed values:
  • "leave"

  roomId

  required

  string

  접속한 방의 Id

  Additional properties are allowed.

  Or to 메세지 관련 API:

  Expand all

  object [메세지 관련 API]

  메세지 관련 API[전송/읽기/수정/삭제 등]

  command

  required

  string

  Allowed values:
  • "message"

  messageCommand

  Expand all

  required

  oneOf

  Adheres to 메세지 전송 API:

  Expand all

  object [메세지 전송 API]

  메세지 전송 API

  message

  Expand all

  required

  object

  메세지 DTO

  mentions

  Expand all

  array<integer>

  유저 아이디 배열

  Items:

  integer

  message

  required

  string

  reply

  integer

  답장할 메세지의 seq

  type

  required

  string

  Allowed values:
  • "text"
  • "image"
  • "video"
  • "file"

  Additional properties are allowed.

  messageCommand

  required

  string

  Allowed values:
  • "send"

  Extensions

  x-socketio-ack

  Expand all

  object [메세지 전송 Payload]

  seq

  integer

  Additional properties are allowed.

  Additional properties are allowed.

  Or to 메세지 읽기 API:

  Expand all

  object [메세지 읽기 API]

  메세지 읽기 API

  messageCommand

  required

  string

  Allowed values:
  • "read"

  seq

  required

  integer

  내 Seq보다 해당방의 Seq가 더 클때 해당방의 수신받은 가장 최근 메세지의 seq

  Additional properties are allowed.

  Or to 메세지 수정 API:

  Expand all

  object [메세지 수정 API]

  메세지 수정 API / 해당 이벤트는 본인은 Socket Event가 수신되지 않습니다

  message

  required

  string

  messageCommand

  required

  string

  Allowed values:
  • "edit"

  roomId

  required

  string

  접속한 방의 Id

  seq

  required

  integer

  메세지 Seq

  Additional properties are allowed.

  Or to 메세지 삭제 API:

  Expand all

  object [메세지 삭제 API]

  메세지 삭제 API / 해당 이벤트는 본인은 Socket Event가 수신되지 않습니다

  messageCommand

  required

  string

  Allowed values:
  • "delete"

  seq

  required

  integer

  메세지 Seq

  Additional properties are allowed.

  Or to 메세지 리액션 API:

  Expand all

  object [메세지 리액션 API]

  리액션 API

  messageCommand

  required

  string

  Allowed values:
  • "delete"

  reactionCode

  string

  seq

  required

  integer

  메세지 Seq

  Additional properties are allowed.

  Or to 메세지 고정 API:

  Expand all

  object [메세지 고정 API]

  메세지 고정 API / 해당 이벤트는 본인은 Socket Event가 수신되지 않습니다

  messageCommand

  required

  string

  Allowed values:
  • "hold"

  seq

  required

  integer

  메세지 Seq [ 해제시 -1 ]

  Additional properties are allowed.

  roomId

  string

  접속한 방의 Id

  Additional properties are allowed.

  Extensions

  x-socketio-event

  chat_room

  Examples

  Payload

  {
    "command": "info",
    "roomId": "string"
  }
  

  This example has been generated automatically.

• SEND /

  Operation IDInitSender

  Channel specific informationws

  Expand all

  object

  query

  Expand all

  object

  Login서버로 부터 발급 받은 JWT Token

  auth

  required

  string

  유저 인증을 위한 JWT Token

  Const:"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjE3OCwic25zSWQiOiIxMDU5ODY2MzcwODc3NDA5MzM5NDUiLCJlbWFpbCI6InNpYS55QHZlcnljaGF0LmlvIiwibmlja25hbWUiOiLsi5zslYQiLCJjb3VudHJ5Q29kZSI6IktSIiwibG9naW5BdCI6MTcyNjIxNzM3NTE3OCwibG9naW5WZXJzaW9uIjoiMi4wLjAiLCJpYXQiOjE3MjYyMTczNzUsImV4cCI6MjA0MTc5MzM3NX0.WDmAZ4BZ6IXZBD_mspvidEwzRPECWfonwzQQ5pWStEg"

  force_logout

  boolean

  해당 디바이스의 유저 강제 종료를 위한 QUERY

  Additional properties are allowed.

  Accepts the following message:

  유저 로그인 후 세팅을 위한 EventName

  Message IDinit

  [필수] 최초 접속 시, 유저의 기본 세팅을 위해 사용
  [방조인, 유저정보 업데이트, Device 중복체크 등]

  Payload

  Expand all

  null

  현재 접속중인 ChatRoom과 Channel을 return으로 전달

  Extensions

  x-socketio-ack

  Expand all

  array<object>

  object

  userChatRooms

  Expand all

  object

  lastReadMessageSeq

  number

  room

  Expand all

  object

  joinUsercount

  number

  lastMessage

  Expand all

  object

  createdAt

  string

  message

  string

  seq

  number

  type

  string

  Allowed values:
  • "text"
  • "image"
  • "video"
  • "file"

  userId

  number

  Additional properties are allowed.

  roomType

  string

  Allowed values:
  • "DM"
  • "GROUP"

  thumbnailUrl

  string

  title

  string

  Additional properties are allowed.

  roomId

  string

  Additional properties are allowed.

  Additional properties are allowed.

  Extensions

  x-socketio-event

  init

  Examples

  Payload

  This example has been generated automatically.

• SEND /

  Operation IDUserSender

  Channel specific informationws

  Expand all

  object

  query

  Expand all

  object

  Login서버로 부터 발급 받은 JWT Token

  auth

  required

  string

  유저 인증을 위한 JWT Token

  Const:"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjE3OCwic25zSWQiOiIxMDU5ODY2MzcwODc3NDA5MzM5NDUiLCJlbWFpbCI6InNpYS55QHZlcnljaGF0LmlvIiwibmlja25hbWUiOiLsi5zslYQiLCJjb3VudHJ5Q29kZSI6IktSIiwibG9naW5BdCI6MTcyNjIxNzM3NTE3OCwibG9naW5WZXJzaW9uIjoiMi4wLjAiLCJpYXQiOjE3MjYyMTczNzUsImV4cCI6MjA0MTc5MzM3NX0.WDmAZ4BZ6IXZBD_mspvidEwzRPECWfonwzQQ5pWStEg"

  force_logout

  boolean

  해당 디바이스의 유저 강제 종료를 위한 QUERY

  Additional properties are allowed.

  Accepts the following message:

  User관련 처리를 위한 EventName

  Message IDuser

  User정보 조회 및 Refresh 등에 이용

  Payload

  Expand all

  oneOf

  Adheres to 유저 정보 조회 API:

  Expand all

  object [유저 정보 조회 API]

  유저들의 정보를 가져오기 위해 사용[유저들의 ProfileImage, Nickname 등]
  사용 예 : Member 혹은 Chatting에서 보이는 유저의 정보를 표시하기 위해

  command

  required

  string

  Allowed values:
  • "info"

  userIds

  Expand all

  required

  array<integer>

  유저 아이디 배열

  Items:

  integer

  Extensions

  x-socketio-ack

  Expand all

  object [유저 정보 Callback Payload]

  firebaseToken

  string

  nickname

  string

  thumbnailUrl

  string

  userId

  integer

  Additional properties are allowed.

  Additional properties are allowed.

  Or to 유저 정보 갱신 API:

  Expand all

  object [유저 정보 갱신 API]

  command

  required

  string

  유저정보 갱신 [인증정보 만료되기 전마다 갱신 혹은 프로필 정보 변경하여 갱신시 사용]

  Allowed values:
  • "refresh"

  Extensions

  x-socketio-ack

  true

  Additional properties are allowed.

  Extensions

  x-socketio-event

  user

  Examples

  Payload

  {
    "command": "info",
    "userIds": [
      0
    ]
  }
  

  This example has been generated automatically.

• SEND /

  Operation IDChannelSender

  Channel specific informationws

  Expand all

  object

  query

  Expand all

  object

  Login서버로 부터 발급 받은 JWT Token

  auth

  required

  string

  유저 인증을 위한 JWT Token

  Const:"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjE3OCwic25zSWQiOiIxMDU5ODY2MzcwODc3NDA5MzM5NDUiLCJlbWFpbCI6InNpYS55QHZlcnljaGF0LmlvIiwibmlja25hbWUiOiLsi5zslYQiLCJjb3VudHJ5Q29kZSI6IktSIiwibG9naW5BdCI6MTcyNjIxNzM3NTE3OCwibG9naW5WZXJzaW9uIjoiMi4wLjAiLCJpYXQiOjE3MjYyMTczNzUsImV4cCI6MjA0MTc5MzM3NX0.WDmAZ4BZ6IXZBD_mspvidEwzRPECWfonwzQQ5pWStEg"

  force_logout

  boolean

  해당 디바이스의 유저 강제 종료를 위한 QUERY

  Additional properties are allowed.

  Accepts the following message:

  채널 관련 처리를 위한 EventName

  Message IDchannel

  Payload

  Expand all

  oneOf

  Adheres to 채널 생성 API:

  Expand all

  object [채널 생성 API]

  채널 생성을 위한 API

  command

  required

  string

  Allowed values:
  • "create"

  userchannelId

  required

  string

  사용하고자 하는 채널의 아이디

  description

  string

  채널 설명

  type

  required

  string

  채널 타입

  Allowed values:
  • "PUBLIC"
  • "PRIVATE"

  password

  string

  비밀번호]

  thumbnailUrl

  string

  채널 썸네일 URL

  title

  string

  Title

  Extensions

  x-socketio-ack

  Expand all

  object [채널 생성 Callback Payload]

  channelId

  string

  Additional properties are allowed.

  Additional properties are allowed.

  Or to 채널 수정 API:

  Expand all

  object [채널 수정 API]

  채널 수정을 위한 API

  command

  required

  string

  Allowed values:
  • "edit"

  description

  string

  채널 설명

  type

  string

  채널 타입

  Allowed values:
  • "PUBLIC"
  • "PRIVATE"

  password

  string

  비밀번호

  thumbnailUrl

  string

  채널 썸네일 URL

  title

  string

  Title

  Extensions

  x-socketio-ack

  Expand all

  object [채널 수정 Callback Payload]

  channelId

  string

  Additional properties are allowed.

  Additional properties are allowed.

  Or to 채널 정보 API:

  Expand all

  object [채널 정보 API]

  해당 채널의 정보를 가져오기 위한 API

  command

  required

  string

  Allowed values:
  • "info"

  channelId

  required

  string

  Extensions

  x-socketio-ack

  Expand all

  object [채널 정보 Callback Payload]

  description

  string

  holdMessageSeq

  integer

  joinUserCount

  integer

  lastMessageSeq

  integer

  최근 메세지의 Seq

  lastStreamId

  integer

  Reaction History StreamId [ 리액션 조회에 사용 0이면 저장된 History X]

  lastChannelChatMessageSeq

  integer

  채널 채팅 메세지의 Seq

  lastChannelChatStreamId

  integer

  채널 채팅 Reaction History StreamId [ 리액션 조회에 사용 0이면 저장된 History X]

  maxUserCount

  integer

  ownerId

  string

  channelId

  string

  channelType

  string

  Allowed values:
  • "DM"
  • "GROUP"

  thumbnailUrl

  string

  title

  string

  Additional properties are allowed.

  Additional properties are allowed.

  Or to GetMembers API:

  Expand all

  object [GetMembers API]

  해당 방에 접속한 Members를 가져오기 위한 API Owner만 사용 가능

  command

  required

  string

  Allowed values:
  • "get_members"

  channelId

  required

  string

  Extensions

  x-socketio-ack

  Expand all

  object [GetMembers Callback Payload]

  userIds

  Expand all

  array<integer>

  유저 아이디 배열

  Items:

  integer

  Additional properties are allowed.

  Additional properties are allowed.

  Or to GetMessages API:

  Expand all

  object [GetMessages API]

  해당 방의 메세지를 불러오기 위해 사용

  command

  required

  string

  Allowed values:
  • "get_messages"

  channelId

  required

  string

  seq

  required

  integer

  Message Seq

  take

  integer

  가져올 메세지 개수 [최대 100개] / Default : 100

  Extensions

  x-socketio-ack

  Expand all

  object [GetMessages Callback Payload]

  createdAt

  string

  deletedAt

  string

  mentions

  Expand all

  array<integer>

  유저 아이디 배열

  Items:

  integer

  message

  string

  reply

  number

  Reply Message Seq

  seq

  integer

  type

  string

  Allowed values:
  • "text"
  • "image"
  • "video"
  • "file"

  userId

  integer

  Additional properties are allowed.

  Additional properties are allowed.

  Or to GetReactions API:

  Expand all

  object [GetReactions API]

  해당 방의 StreamId를 기반으로 Reaction History를 불러옴 방에 접속 시, 방의 정보를 가져와서 lastStreamId와 로컬에 저장된 StreamId를 비교 lastStreamId보다 작다면 서버에 요청 next값이 true이면 더 요청할 값이 있다는 뜻이므로 로컬 StreamId를 갱신하고 해당 값으로 한번 더 요청

  command

  required

  string

  Allowed values:
  • "get_reactions"

  channelId

  required

  string

  streamId

  required

  integer

  저장된 StreamId

  Extensions

  x-socketio-ack

  Expand all

  object [GetReactions Callback Payload]

  historys

  Expand all

  array<object>

  유저 아이디 배열

  object

  reactionCode

  string

  seq

  integer

  userId

  integer

  Additional properties are allowed.

  next

  boolean

  다음 값이 더 있음[최대 100개씩 가져옴]

  Additional properties are allowed.

  Additional properties are allowed.

  Or to 유저 채널 초대 API:

  Expand all

  object [유저 채널 초대 API]

  유저를 해당 방에 초대하기 위한 API

  command

  required

  string

  Allowed values:
  • "invite"

  channelId

  required

  string

  members

  Expand all

  required

  array<integer>

  유저 아이디 배열 [한번 초대에 최대 100명]

  Items:

  integer

  Extensions

  x-socketio-ack

  true

  Additional properties are allowed.

  Or to 채널 퇴장 API:

  Expand all

  object [채널 퇴장 API]

  해당채널에서 퇴장하기 위한 API

  command

  required

  string

  Allowed values:
  • "leave"

  channelId

  required

  string

  Additional properties are allowed.

  Or to 채널 메세지 관련 API:

  Expand all

  object [채널 메세지 관련 API]

  메세지 관련 API[전송/읽기/수정/삭제 등]

  command

  required

  string

  Allowed values:
  • "message"

  messageCommand

  Expand all

  required

  oneOf

  Adheres to 채널 메세지 전송 API:

  Expand all

  object [채널 메세지 전송 API]

  메세지 전송 API

  message

  Expand all

  required

  object

  메세지 DTO

  mentions

  Expand all

  array<integer>

  유저 아이디 배열

  Items:

  integer

  message

  required

  string

  reply

  integer

  답장할 메세지의 seq

  type

  required

  string

  Allowed values:
  • "text"
  • "image"
  • "video"
  • "file"

  Additional properties are allowed.

  messageCommand

  required

  string

  Allowed values:
  • "send"

  Extensions

  x-socketio-ack

  Expand all

  object [채널 메세지 전송 Callback Payload]

  seq

  integer

  Additional properties are allowed.

  Additional properties are allowed.

  Or to 채널 메세지 읽기 API:

  Expand all

  object [채널 메세지 읽기 API]

  메세지 읽기 API

  messageCommand

  required

  string

  Allowed values:
  • "read"

  seq

  required

  integer

  내 Seq보다 해당방의 Seq가 더 클때 해당방의 수신받은 가장 최근 메세지의 seq

  Additional properties are allowed.

  Or to 메세지 수정 API:

  Expand all

  object [메세지 수정 API]

  메세지 수정 API / 해당 이벤트는 본인은 Socket Event가 수신되지 않습니다

  message

  required

  string

  messageCommand

  required

  string

  Allowed values:
  • "edit"

  seq

  required

  integer

  메세지 Seq

  Additional properties are allowed.

  Or to 메세지 삭제 API:

  Expand all

  object [메세지 삭제 API]

  메세지 삭제 API / 해당 이벤트는 본인은 Socket Event가 수신되지 않습니다

  messageCommand

  required

  string

  Allowed values:
  • "delete"

  seq

  required

  integer

  메세지 Seq

  Additional properties are allowed.

  Or to 채널 메세지 리액션 API:

  Expand all

  object [채널 메세지 리액션 API]

  리액션 API

  messageCommand

  required

  string

  Allowed values:
  • "delete"

  reactionCode

  string

  seq

  required

  integer

  메세지 Seq

  Additional properties are allowed.

  Or to 메세지 고정 API:

  Expand all

  object [메세지 고정 API]

  메세지 고정 API [오너/운영자만 사용 가능]/ 해당 이벤트는 본인은 Socket Event가 수신되지 않습니다

  messageCommand

  required

  string

  Allowed values:
  • "hold"

  seq

  required

  integer

  메세지 Seq [ 해제시 -1 ]

  Additional properties are allowed.

  channelId

  string

  접속한 방의 Id

  Additional properties are allowed.

  Or to 채널 입장 API:

  Expand all

  object [채널 입장 API]

  해당채널에 입장하기 위한 API[구독]

  command

  required

  string

  Allowed values:
  • "join"

  channelId

  required

  string

  password

  string

  비밀번호

  Additional properties are allowed.

  Or to 채널 파괴 API:

  Expand all

  object [채널 파괴 API]

  채널 파괴 API

  command

  required

  string

  Allowed values:
  • "destroy"

  channelId

  required

  string

  Additional properties are allowed.

  Or to 채널 소유자 변경 API:

  Expand all

  object [채널 소유자 변경 API]

  채널 소유자 변경 API

  command

  required

  string

  Allowed values:
  • "change_owner"

  channelId

  required

  string

  tartgetUserId

  required

  integer

  변경할 유저 아이디

  Additional properties are allowed.

  Or to 채널 검색 API:

  Expand all

  object [채널 검색 API]

  채널 검색 API / search에 아무것도 넣지 않으면 전체 조회

  command

  required

  string

  Allowed values:
  • "search"

  search

  string

  limit

  integer

  page

  integer

  Extensions

  x-socketio-ack

  Expand all

  object [채널 검색 Callback Payload]

  title

  string

  channelType

  string

  Allowed values:
  • "PRIVATE"
  • "PUBLIC"

  joinUserCount

  integer

  lastMessage

  Expand all

  object

  최근 메세지

  createdAt

  string

  message

  string

  seq

  integer

  Additional properties are allowed.

  ownerId

  string

  channelId

  string

  thumbnailUrl

  string

  userChannelId

  string

  countryCode

  string

  Additional properties are allowed.

  Additional properties are allowed.

  Or to 채널 운영자 조회 API:

  Expand all

  object [채널 운영자 조회 API]

  채널 오퍼레이터를 가져오기 위한 API

  command

  required

  string

  Allowed values:
  • "get_operators"

  channelId

  required

  string

  Extensions

  x-socketio-ack

  Expand all

  object [GetOperators Callback Payload]

  operators

  Expand all

  array<object>

  운영자 배열

  object

  userId

  integer

  userBanAuth

  boolean

  chatDeleteAuth

  boolean

  chatSlowAuth

  boolean

  infoAuth

  boolean

  postAuth

  boolean

  pinAuth

  boolean

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Or to 채널 오퍼레이터 설정 API:

  Expand all

  object [채널 오퍼레이터 설정 API]

  채널 오퍼레이터를 설정하기 위한 API

  command

  required

  string

  Allowed values:
  • "set_operator"

  channelId

  required

  string

  tartgetUserId

  required

  string

  userBanAuth

  boolean

  chatDeleteAuth

  boolean

  chatSlowAuth

  boolean

  infoAuth

  boolean

  postAuth

  boolean

  pinAuth

  boolean

  Additional properties are allowed.

  Or to 채널 오퍼레이터 해제 API:

  Expand all

  object [채널 오퍼레이터 해제 API]

  채널 오퍼레이터를 해제하기 위한 API

  command

  required

  string

  Allowed values:
  • "remove_operator"

  channelId

  required

  string

  tartgetUserId

  required

  string

  Additional properties are allowed.

  Or to 내가 생성한 채널 목록 API:

  Expand all

  object [내가 생성한 채널 목록 API]

  내 채널 목록을 가져오기 위한 API

  command

  required

  string

  Allowed values:
  • "get_my_channels"

  Extensions

  x-socketio-ack

  Expand all

  object [내가 생성한 채널 목록 API Callback Payload]

  title

  string

  channelType

  string

  Allowed values:
  • "PUBLIC"
  • "PRIVATE"

  channelId

  string

  thumbnailUrl

  string

  joinUserCount

  integer

  Additional properties are allowed.

  Additional properties are allowed.

  Extensions

  x-socketio-event

  channel

  Examples

  Payload

  {
    "command": "create",
    "userchannelId": "string",
    "description": "string",
    "type": "PUBLIC",
    "password": "string",
    "thumbnailUrl": "string",
    "title": "string"
  }
  

  This example has been generated automatically.

• SEND /

  Operation IDChannelChatSender

  Channel specific informationws

  Expand all

  object

  query

  Expand all

  object

  Login서버로 부터 발급 받은 JWT Token

  auth

  required

  string

  유저 인증을 위한 JWT Token

  Const:"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjE3OCwic25zSWQiOiIxMDU5ODY2MzcwODc3NDA5MzM5NDUiLCJlbWFpbCI6InNpYS55QHZlcnljaGF0LmlvIiwibmlja25hbWUiOiLsi5zslYQiLCJjb3VudHJ5Q29kZSI6IktSIiwibG9naW5BdCI6MTcyNjIxNzM3NTE3OCwibG9naW5WZXJzaW9uIjoiMi4wLjAiLCJpYXQiOjE3MjYyMTczNzUsImV4cCI6MjA0MTc5MzM3NX0.WDmAZ4BZ6IXZBD_mspvidEwzRPECWfonwzQQ5pWStEg"

  force_logout

  boolean

  해당 디바이스의 유저 강제 종료를 위한 QUERY

  Additional properties are allowed.

  Accepts the following message:

  채널 채팅방 관련 처리를 위한 EventName

  Message IDchannel_chat

  Payload

  Expand all

  oneOf

  Adheres to 채널채팅방 Join API:

  Expand all

  object [채널채팅방 Join API]

  해당 채널 채팅방에 조인하기 위해 사용. 해당 API는 채널 내 채널 채팅방에 입장시 JOIN해야 하며, 방을 나갈경우 LEAVE를 보내야함

  command

  required

  string

  Allowed values:
  • "join"

  channelId

  required

  string

  Additional properties are allowed.

  Or to 채널채팅방 Leave API:

  Expand all

  object [채널채팅방 Leave API]

  해당 채널 채팅방에서 퇴장. 방을 나갈경우 LEAVE를 보내야함

  command

  required

  string

  Allowed values:
  • "leave"

  channelId

  required

  string

  Additional properties are allowed.

  Or to GetMessages API:

  Expand all

  object [GetMessages API]

  해당 방의 메세지를 불러오기 위해 사용

  command

  required

  string

  Allowed values:
  • "get_messages"

  channelId

  required

  string

  seq

  required

  integer

  Message Seq

  take

  integer

  가져올 메세지 개수 [최대 100개] / Default : 100

  Extensions

  x-socketio-ack

  Expand all

  object [GetMessages Callback Payload]

  createdAt

  string

  deletedAt

  string

  mentions

  Expand all

  array<integer>

  유저 아이디 배열

  Items:

  integer

  message

  string

  reply

  number

  Reply Message Seq

  seq

  integer

  type

  string

  Allowed values:
  • "text"
  • "image"
  • "video"
  • "file"

  userId

  integer

  Additional properties are allowed.

  Additional properties are allowed.

  Or to GetReactions API:

  Expand all

  object [GetReactions API]

  해당 방의 StreamId를 기반으로 Reaction History를 불러옴 방에 접속 시, 방의 정보를 가져와서 lastStreamId와 로컬에 저장된 StreamId를 비교 lastStreamId보다 작다면 서버에 요청 next값이 true이면 더 요청할 값이 있다는 뜻이므로 로컬 StreamId를 갱신하고 해당 값으로 한번 더 요청

  command

  required

  string

  Allowed values:
  • "get_reactions"

  channelId

  required

  string

  streamId

  required

  integer

  저장된 StreamId

  Extensions

  x-socketio-ack

  Expand all

  object [GetReactions Callback Payload]

  historys

  Expand all

  array<object>

  유저 아이디 배열

  object

  reactionCode

  string

  seq

  integer

  userId

  integer

  Additional properties are allowed.

  next

  boolean

  다음 값이 더 있음[최대 100개씩 가져옴]

  Additional properties are allowed.

  Additional properties are allowed.

  Or to 채널 메세지 관련 API:

  Expand all

  object [채널 메세지 관련 API]

  메세지 관련 API[전송/읽기/수정/삭제 등]

  command

  required

  string

  Allowed values:
  • "message"

  messageCommand

  Expand all

  required

  oneOf

  Adheres to 채널 메세지 전송 API:

  Expand all

  object [채널 메세지 전송 API]

  메세지 전송 API

  message

  Expand all

  required

  object

  메세지 DTO

  mentions

  Expand all

  array<integer>

  유저 아이디 배열

  Items:

  integer

  message

  required

  string

  reply

  integer

  답장할 메세지의 seq

  type

  required

  string

  Allowed values:
  • "text"
  • "image"
  • "video"
  • "file"

  Additional properties are allowed.

  messageCommand

  required

  string

  Allowed values:
  • "send"

  Extensions

  x-socketio-ack

  Expand all

  object [채널 메세지 전송 Callback Payload]

  seq

  integer

  Additional properties are allowed.

  Additional properties are allowed.

  Or to 채널 메세지 읽기 API:

  Expand all

  object [채널 메세지 읽기 API]

  메세지 읽기 API

  messageCommand

  required

  string

  Allowed values:
  • "read"

  seq

  required

  integer

  내 Seq보다 해당방의 Seq가 더 클때 해당방의 수신받은 가장 최근 메세지의 seq

  Additional properties are allowed.

  Or to 메세지 수정 API:

  Expand all

  object [메세지 수정 API]

  메세지 수정 API / 해당 이벤트는 본인은 Socket Event가 수신되지 않습니다

  message

  required

  string

  messageCommand

  required

  string

  Allowed values:
  • "edit"

  seq

  required

  integer

  메세지 Seq

  Additional properties are allowed.

  Or to 메세지 삭제 API:

  Expand all

  object [메세지 삭제 API]

  메세지 삭제 API / 해당 이벤트는 본인은 Socket Event가 수신되지 않습니다

  messageCommand

  required

  string

  Allowed values:
  • "delete"

  seq

  required

  integer

  메세지 Seq

  Additional properties are allowed.

  Or to 채널 메세지 리액션 API:

  Expand all

  object [채널 메세지 리액션 API]

  리액션 API

  messageCommand

  required

  string

  Allowed values:
  • "delete"

  reactionCode

  string

  seq

  required

  integer

  메세지 Seq

  Additional properties are allowed.

  Or to 메세지 고정 API:

  Expand all

  object [메세지 고정 API]

  메세지 고정 API [오너/운영자만 사용 가능]/ 해당 이벤트는 본인은 Socket Event가 수신되지 않습니다

  messageCommand

  required

  string

  Allowed values:
  • "hold"

  seq

  required

  integer

  메세지 Seq [ 해제시 -1 ]

  Additional properties are allowed.

  channelId

  string

  접속한 방의 Id

  Additional properties are allowed.

  Extensions

  x-socketio-event

  channel_chat

  Examples

  Payload

  {
    "command": "join",
    "channelId": "string"
  }
  

  This example has been generated automatically.