채널

채널 생성 및 삭제, 채널 정보 변경, 채널 목록 및 참여자 조회를 위한 API 사용 방법을 안내합니다.

개요¶

채널은 채팅이 이루어지는 개념적 공간을 의미하며, 게임 내 모든 채팅은 채널에서 진행됩니다.

API로 지원하는 채널 유형 및 채널 동작 방식을 설명합니다.

채널 유형¶

API로 요청하여 생성할 수 있는 채널 유형은 아래와 같습니다.

채널 유형	채널 인원	참여 개수 제한	접속 해제 시 채널 퇴장 여부	주요 용도
`PUBLIC`	1 ~ 5000	최대 10개	O	오픈 채널, 이벤트 등 불특정 다수가 참여하는 채널
`GROUP`	1 ~ 500	최대 10개	X	길드, 팀, 파티 등 특정 다수가 참여하는 채널
`PRIVATE`	1 ~ 500	최대 10개	X	개인, 비공개 등 참여 시 비밀번호가 필요한 채널
`ONE_ON_ONE`	2	최대 200개	X	최대 참여 인원이 2인으로 제한되는 1:1 전용 채널

PUBLIC 채널은 불특정 다수가 참여하는 오픈 채팅 용도로 생성하며, 온라인에 접속한 사용자만 참여할 수 있습니다.
GROUP, PRIVATE 채널은 길드, 친구, 파티와 같은 특정 그룹 내 채팅 용도로 생성합니다.
PRIVATE 친구, 개인 그룹 내 채팅 용도로 생성하며 사용자는 비밀번호를 입력해야 입장할 수 있습니다.

채널 동작 방식¶

채널의 기본적인 동작 방식은 아래와 같습니다.

채널 입장, 퇴장이라는 명확한 시점이 존재하여 각 시점마다 채팅 서버에서 일관된 처리를 제공합니다.
채널에 메시지를 전송하면 채널에 참여한 모든 유저에게 메시지가 전송됩니다. (단, 차단된 유저에게는 전송되지 않습니다.)
채널 참여자만 채널에 메시지를 전송할 수 있습니다. (단, 공지 메시지는 예외입니다.)

채널 API 사용에 따른 동작 방식은 아래와 같습니다.

채널 생성 및 삭제¶

채널 생성, 1:1 채널 생성 API를 사용하여 채널을 생성할 수 있습니다.
- 1:1 채널(ONE_ON_ONE)의 경우 1:1 채널 생성 API를 이용하여 생성해야 합니다.
채널이 삭제되는 경우
- 채널 삭제 API를 사용한 경우
- 채널 소유자가 SYSTEM 이 아니면서, 채널 참여자가 없으면 주기적으로 삭제됩니다.
채널 참여자가 있는 상태에서 채널이 삭제되는 경우, 참여자들에게 채널 삭제 이벤트가 전송됩니다.

채널 정보 변경¶

채널 수정 API를 사용하여 채널 정보를 변경할 수 있습니다.
- 변경 가능한 항목: 채널명, 채널 최대 인원, 비밀번호, 채팅 내역 제공 여부
- 채널 참여자가 100명인 상태에서 채널 최대 인원을 50명으로 변경하더라도, 기존 참여자들의 상태에 영향을 주지 않습니다.
- 1:1 채널(ONE_ON_ONE) 정보는 변경할 수 없습니다.

채널 생성 API¶

새로운 채널을 생성합니다.

요청 본문 파라미터에 playerId를 포함하면 해당 playerId의 사용자가 채널 소유자가 되며 채널에 자동으로 입장합니다. playerId를 포함하지 않으면 채널 소유자는 SYSTEM이 됩니다.

아래와 같은 채널은 주기적으로 삭제됩니다.

채널 소유자가 SYSTEM가 아니면서 채널에 참여자가 없는 경우

Request URL¶

서버	URL
LIVE	`https://api-chat.withhive.com/api/v1/games/{gameIndex}/channel`
SANDBOX	`https://sandbox-api-chat.withhive.com/api/v1/games/{gameIndex}/channel`
HTTP METHOD	`POST`
CONTENT-TYPE	`application/json`

Path parameters¶

필드명	설명	타입	필수 여부
gameIndex	하이브 게임 인덱스	integer	Y

Header parameters¶

필드명	설명	타입	필수 여부
Authorization	API 호출을 위한 인증 토큰 (`Bearer`)	string	Y
Content-Type	요청 데이터의 타입 (`application/json`)	string	Y

Request body¶

필드명	설명	타입	필수 여부
channelId	채널 ID (영어 대소문자, 숫자, 일부 특수문자(`-`, `.`, `_`, `~`, `:`) 사용 가능, 최대 100자)	string	Y
playerId	채널 생성자의 Player ID	long	N
password	비밀번호 (`PRIVATE` 채널일 경우 필수) (최대 50자)	string	N
channelName	채널 이름 (최대 50자)	string	Y
maxMemberCount	최대 채널 참여 인원 (최소 2명 ~ 최대 5,000명)	integer	Y
type	채널 타입 (`PRIVATE`, `PUBLIC`, `GROUP`)	string	Y
chatHistoryAllowed	메시지 이력 조회 가능 여부 (기본값: `false`)	boolean	N

Response body¶

필드명	설명	타입
code	응답 결과 코드	integer
message	결과 메시지	string
data	응답 데이터	object

Response body > data¶

필드명	설명	타입
channelId	채널 ID	string
type	채널 타입 (`PRIVATE`, `PUBLIC`, `GROUP`)	string
gameIndex	하이브 게임 인덱스	integer
owner	채널 소유자	string
channelName	채널 이름	string
maxMemberCount	최대 채널 참여 인원	integer
chatHistoryAllowed	메시지 이력 조회 가능 여부	boolean
regTime	채널 생성 일시 (`UTC+0` 기준, `yyyy-MM-dd'T'HH:mm:ss.SSSZ` 형식)	string
regTimeMillis	채널 생성 일시 (UnixTimestamp Millisecond)	long

Request sample¶

curl --request POST 'https://api-chat.withhive.com/api/v1/games/1/channel' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJIaXZlIiwiaWF0IjoxNzAyNDU4MTkzLCJqdGkiOiIxMzY2NDk4MjcxIn0.VSwvsTE-tS0sL_e9p9gNvHRkMCbsycSO4ObE4J2ysjs' \
--header 'Content-Type: application/json' \
--data'{
    "channelId": "open:12345",
    "channelName": "오픈 채팅방",
    "maxMemberCount": 100,
    "type": "PUBLIC",
    "chatHistoryAllowed": true
}'

Response sample¶

{
    "code": 0,
    "message": "Success.",
    "data": {
        "channelId": "open:12345",
        "type": "PUBLIC",
        "gameIndex": 1,
        "owner": "SYSTEM",
        "channelName": "오픈 채팅방",
        "chatHistoryAllowed": true,
        "maxMemberCount": 100,
        "regTime": "2025-07-21T08:39:07.542913300Z",
        "regTimeMillis": 1753087147542
  }
}

1:1 채널 생성 API¶

1:1 채널(ONE_ON_ONE)을 생성하며, 요청 데이터 중 playerId, otherPlayerId에 해당하는 사용자를 채널에 입장시킵니다.

기존에 생성한 1:1 채널에 동일한 사용자가 존재하는 경우, 기존 채널로 입장시킵니다.

Request URL¶

서버	URL
LIVE	`https://api-chat.withhive.com/api/v1/games/{gameIndex}/channels/1on1`
SANDBOX	`https://sandbox-api-chat.withhive.com/api/v1/games/{gameIndex}/channels/1on1`
HTTP METHOD	`POST`
CONTENT-TYPE	`application/json`

Path parameters¶

필드명	설명	타입	필수 여부
gameIndex	하이브 게임 인덱스	integer	Y

Header parameters¶

필드명	설명	타입	필수 여부
Authorization	API 호출을 위한 인증 토큰 (`Bearer`)	string	Y
Content-Type	요청 데이터의 타입 (`application/json`)	string	Y

Request body¶

필드명	설명	타입	필수 여부
channelId	채널 ID (영어 대소문자, 숫자, 일부 특수문자(`-`, `.`, `_`, `~`, `:`) 사용 가능, 최대 100자)	string	Y
channelName	채널 이름 (최대 50자)	string	Y
playerId	Player ID	long	Y
otherPlayerId	상대방 Player ID	long	Y
chatHistoryAllowed	메시지 이력 조회 가능 여부 (기본값: `false`)	boolean	N

Response body¶

필드명	설명	타입
code	응답 결과 코드	integer
message	결과 메시지	string
data	응답 데이터	object

Response body > data¶

필드명	설명	타입
channelId	채널 ID	string
type	채널 타입 (`ONE_ON_ONE`)	string
gameIndex	하이브 게임 인덱스	integer
owner	채널 소유자	string
channelName	채널 이름	string
maxMemberCount	최대 채널 참여 인원	integer
participants	채널 참여자 playerId 목록	array
chatHistoryAllowed	메시지 이력 조회 가능 여부	boolean
regTime	채널 생성 일시 (`UTC+0` 기준, `yyyy-MM-dd'T'HH:mm:ss.SSSZ` 형식)	string
regTimeMillis	채널 생성 일시 (UnixTimestamp Millisecond)	long

Request sample¶

curl --request POST 'https://api-chat.withhive.com/api/v1/games/1/channel/1on1' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJIaXZlIiwiaWF0IjoxNzAyNDU4MTkzLCJqdGkiOiIxMzY2NDk4MjcxIn0.VSwvsTE-tS0sL_e9p9gNvHRkMCbsycSO4ObE4J2ysjs' \
--header 'Content-Type: application/json' \
--data'{
    "channelId": "1on1:test",
    "channelName“: "테스트 1:1 채널",
    "playerId": 1000,
    "otherPlayerId": 2000,
    "chatHistoryAllowed": false
}'

Response sample¶

{
    "code": 0,
    "message": "Success.",
    "data": {
        "channelId": "1on1:test",
        "type": "ONE_ON_ONE",
        "gameIndex": 1,
        "owner": "1000",
        "channelName": "테스트 1:1 채널",
        "chatHistoryAllowed": false,
        "maxMemberCount": 2,
        "participants": [1000, 2000],
        "regTime": "2025-07-18T09:37:36.697035738Z",
        "regTimeMillis": 1752831456697
    }
}

채널 수정 API¶

생성한 채널을 수정합니다.

아래 유형의 채널만 수정할 수 있습니다.

PUBLIC
PRIVATE
GROUP

Request URL¶

서버	URL
LIVE	`https://api-chat.withhive.com/api/v1/games/{gameIndex}/channels/{channelId}`
SANDBOX	`https://sandbox-api-chat.withhive.com/api/v1/games/{gameIndex}/channels/{channelId}`
HTTP METHOD	`PATCH`
CONTENT-TYPE	`application/json`

Path parameters¶

필드명	설명	타입	필수 여부
gameIndex	하이브 게임 인덱스	integer	Y
channelId	채널 ID	string	Y

Header parameters¶

필드명	설명	타입	필수 여부
Authorization	API 호출을 위한 인증 토큰 (`Bearer`)	string	Y
Content-Type	요청 데이터의 타입 (`application/json`)	string	Y

Request body¶

필드명	설명	타입	필수 여부
channelName	채널 이름 (최대 50자)	string	N
password	비밀번호 (`PRIVATE` 채널일 경우 필수) (최대 50자)	string	N
maxMemberCount	최대 채널 참여 인원	integer	N
type	채널 타입 (`PRIVATE`, `PUBLIC`, `GROUP`)	string	N
chatHistoryAllowed	메시지 이력 조회 가능 여부 (기본값: `false`)	boolean	N

Response body¶

필드명	설명	타입
code	응답 결과 코드	integer
message	결과 메시지	string
data	응답 데이터	object

Request sample¶

curl --request PATCH 'https://api-chat.withhive.com/api/v1/games/1/channels/testchannel' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJIaXZlIiwiaWF0IjoxNzAyNDU4MTkzLCJqdGkiOiIxMzY2NDk4MjcxIn0.VSwvsTE-tS0sL_e9p9gNvHRkMCbsycSO4ObE4J2ysjs' \
--header 'Content-Type: application/json' \
--data'{
    "channelName": "오픈 채팅방",
    "maxMemberCount": 100,
    "type": "PUBLIC",
    "chatHistoryAllowed": true
}'

Response sample¶

{
    "code": 0,
    "message": "Success."
}

채널 삭제 API¶

생성한 채널을 삭제하고 해당 채널에 참여한 유저에게 채널 삭제 이벤트를 발송합니다.

Request URL¶

서버	URL
LIVE	`https://api-chat.withhive.com/api/v1/games/{gameIndex}/channels/{channelId}`
SANDBOX	`https://sandbox-api-chat.withhive.com/api/v1/games/{gameIndex}/channels/{channelId}`
HTTP Method	`DELETE`

Path parameters¶

필드명	설명	타입	필수 여부
gameIndex	하이브 게임 인덱스	integer	Y
channelId	삭제할 채널 ID	string	Y

Header parameters¶

필드명	설명	타입	필수 여부
Authorization	API 호출을 위한 인증 토큰 (`Bearer`)	string	Y

Response body¶

필드명	설명	타입
code	응답 결과 코드	integer
message	결과 메시지	string

Request sample¶

curl --request DELETE 'https://api-chat.withhive.com/api/v1/games/1/channels/open:12345' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJIaXZlIiwiaWF0IjoxNzAyNDU4MTkzLCJqdGkiOiIxMzY2NDk4MjcxIn0.VSwvsTE-tS0sL_e9p9gNvHRkMCbsycSO4ObE4J2ysjs'

Response sample¶

{
    "code": 0,
    "message": "Success."
}

채널 목록 조회 API¶

생성한 채널 목록을 조회합니다. 조회 가능한 채널 타입은 아래와 같습니다.

PUBLIC
PRIVATE
GROUP

Request URL¶

서버	URL
LIVE	`https://api-chat.withhive.com/api/v1/games/{gameIndex}/channels`
SANDBOX	`https://sandbox-api-chat.withhive.com/api/v1/games/{gameIndex}/channels`
HTTP METHOD	`GET`

Path parameters¶

필드명	설명	타입	필수 여부
gameIndex	하이브 게임 인덱스	integer	Y

Header parameters¶

필드명	설명	타입	필수 여부
Authorization	API 호출을 위한 인증 토큰 (`Bearer`)	string	Y

Query parameters¶

필드명	설명	타입	필수 여부
type	채널 타입 (`PRIVATE`, `PUBLIC`, `GROUP`)	string	N
channelId	채널 ID로 시작하는 채널 조회	string	N
channelName	채널 이름을 포함하는 채널 조회	string	N
sort	정렬 기준 (`channelId`, `channelName`, `regTime`) (기본값: `regTime`)	string	N
order	정렬 방식 (`ASC`, `DESC`) (기본값: `DESC`)	string	N
size	한 페이지당 조회할 채널 수 (최소 1개 ~ 최대 10개, 기본값: `10`)	integer	N
page	조회할 페이지 번호 (1부터 시작, 기본값: `1`)	integer	N

Response body¶

필드명	설명	타입
code	응답 결과 코드	integer
message	결과 메시지	string
data	응답 데이터	object

Response body > data¶

필드명	설명	타입
content	채널 목록	object array
page	페이지 정보	object

Response body > data > content¶

필드명	설명	타입
channelId	채널 ID	string
type	채널 타입 (`PRIVATE`, `PUBLIC`, `GROUP`)	string
gameIndex	하이브 게임 인덱스	integer
owner	채널 소유자의 Player ID	string
channelName	채널 이름	string
memberCount	현재 채널 참여 인원	integer
maxMemberCount	최대 채널 참여 인원	integer
chatHistoryAllowed	메시지 이력 조회 가능 여부	boolean
regTime	채널 생성 일시 (`UTC+0` 기준, `yyyy-MM-dd'T'HH:mm:ss.SSSZ` 형식)	string
regTimeMillis	채널 생성 일시 (UnixTimestamp Millisecond)	long

Response body > data > page¶

필드명	설명	타입
size	한 페이지당 항목 수	integer
currentPage	현재 페이지 번호	integer
totalElements	전체 항목 수	integer
totalPages	전체 페이지 수	integer

Request sample¶

curl --request GET 'https://api-chat.withhive.com/api/v1/games/1/channels?type=PUBLIC&sort=regTime&order=DESC&size=10&page=1' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJIaXZlIiwiaWF0IjoxNzAyNDU4MTkzLCJqdGkiOiIxMzY2NDk4MjcxIn0.VSwvsTE-tS0sL_e9p9gNvHRkMCbsycSO4ObE4J2ysjs'

Response sample¶

{
  "code": 0,
  "message": "Success.",
  "data": {
    "content": [
      {
        "channelId": "open:12345",
        "type": "PUBLIC",
        "gameIndex": 1,
        "owner": "1000",
        "channelName": "오픈 채팅방",
        "memberCount": 2,
        "maxMemberCount": 50,
        "chatHistoryAllowed": true,
        "regTime": "2024-12-30T15:01:01.004Z",
        "regTimeMillis": 1731306364351
      },
      /// ... 채널 정보
    ],
    "page": {
      "size": 10,
      "currentPage": 1,
      "totalElements": 100,
      "totalPages": 10
    }
  }
}

채널 조회 API¶

생성한 채널의 상세 정보를 조회합니다.

Request URL¶

서버	URL
LIVE	`https://api-chat.withhive.com/api/v1/games/{gameIndex}/channels/{channelId}`
SANDBOX	`https://sandbox-api-chat.withhive.com/api/v1/games/{gameIndex}/channels/{channelId}`
HTTP METHOD	`GET`

Path parameters¶

필드명	설명	타입	필수 여부
gameIndex	하이브 게임 인덱스	integer	Y
channelId	조회할 채널 ID	string	Y

Header parameters¶

필드명	설명	타입	필수 여부
Authorization	API 호출을 위한 인증 토큰 (`Bearer`)	string	Y

Response body¶

필드명	설명	타입
code	응답 결과 코드	integer
message	결과 메시지	string
data	응답 데이터	object

Response body > data¶

필드명	설명	타입
info	채널 정보	object
members	참여자 목록	object array

Response body > data > info¶

필드명	설명	타입
channelId	채널 ID	string
type	채널 타입 (`PRIVATE`, `PUBLIC`, `GROUP`, `ONE_ON_ONE`)	string
gameIndex	하이브 게임 인덱스	integer
owner	채널 소유자	string
channelName	채널 이름	string
memberCount	현재 채널 참여 인원	integer
maxMemberCount	최대 채널 참여 인원	integer
chatHistoryAllowed	메시지 이력 조회 가능 여부	boolean
regTime	채널 생성 일시 (`UTC+0` 기준, `yyyy-MM-dd'T'HH:mm:ss.SSSZ` 형식)	string
regTimeMillis	채널 생성 일시 (UnixTimestamp Millisecond)	long

Response body > data > members¶

필드명	설명	타입
playerId	Player ID	long

Request sample¶

curl --request GET 'https://api-chat.withhive.com/api/v1/games/1/channels/open:12345' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJIaXZlIiwiaWF0IjoxNzAyNDU4MTkzLCJqdGkiOiIxMzY2NDk4MjcxIn0.VSwvsTE-tS0sL_e9p9gNvHRkMCbsycSO4ObE4J2ysjs'

Response sample¶

{
  "code": 0,
  "message": "Success.",
  "data": {
    "info": {
      "channelId": "open:12345",
      "type": "PUBLIC",
      "gameIndex": 1,
      "owner": "SYSTEM",
      "channelName": "오픈채팅방",
      "memberCount": 2,
      "maxMemberCount": 50,
      "chatHistoryAllowed": true,
      "regTime": "2024-12-30T15:01:01.004Z",
      "regTimeMillis": 1731306364351
    },
    "members": [
      {
        "playerId": 1
      },
      {
        "playerId": 2
      }
    ]
  }
}

채널 참여자 조회 API¶

채널 참여한 유저의 정보를 조회합니다.

Request URL¶

서버	URL
LIVE	`https://api-chat.withhive.com/api/v1/games/{gameIndex}/channels/{channelId}/members`
SANDBOX	`https://sandbox-api-chat.withhive.com/api/v1/games/{gameIndex}/channels/{channelId}/members`
HTTP METHOD	`GET`

Path parameters¶

필드명	설명	타입	필수 여부
gameIndex	하이브 게임 인덱스	integer	Y
channelId	조회할 채널 ID	string	Y

Header parameters¶

필드명	설명	타입	필수 여부
Authorization	API 호출을 위한 인증 토큰 (`Bearer`)	string	Y

Response body¶

필드명	설명	타입
code	응답 결과 코드	integer
message	결과 메시지	string
data	응답 데이터	object

Response body > data¶

필드명	설명	타입
members	채널 참여자 목록	object array

Response Body > data > members¶

필드명	설명	타입
playerId	Player ID	long

Request sample¶

curl --request GET 'https://api-chat.withhive.com/api/v1/games/1/channels/open:12345/members' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJIaXZlIiwiaWF0IjoxNzAyNDU4MTkzLCJqdGkiOiIxMzY2NDk4MjcxIn0.VSwvsTE-tS0sL_e9p9gNvHRkMCbsycSO4ObE4J2ysjs'

Response sample¶

{
  "code": 0,
  "message": "Success.",
  "data": {
    "members": [
      {
        "playerId": 1
      },
      {
        "playerId": 2
      }
    ]
  }
}

채널 입장 API¶

채널에 특정 유저가 참여하도록 입장시킵니다.

Request URL¶

서버	URL
LIVE	`https://api-chat.withhive.com/api/v1/games/{gameIndex}/channels/{channelId}/enter`
SANDBOX	`https://sandbox-api-chat.withhive.com/api/v1/games/{gameIndex}/channels/{channelId}/enter`
HTTP METHOD	`POST`
CONTENT-TYPE	`application/json`

Path parameters¶

필드명	설명	타입	필수 여부
gameIndex	하이브 게임 인덱스	integer	Y
channelId	채널 ID	string	Y

Header parameters¶

필드명	설명	타입	필수 여부
Authorization	API 호출을 위한 인증 토큰 (`Bearer`)	string	Y
Content-Type	요청 데이터의 타입 (`application/json`)	string	Y

Request body¶

필드명	설명	타입	필수 여부
playerId	입장시킬 사용자의 Player ID	long	Y
password	비밀번호 (`PRIVATE` 채널일 경우 필수)	string	N

Response body¶

필드명	설명	타입
code	응답 결과 코드	integer
message	결과 메시지	string

Request sample¶

curl --request POST 'https://api-chat.withhive.com/api/v1/games/1/channels/guild:12345/enter' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJIaXZlIiwiaWF0IjoxNzAyNDU4MTkzLCJqdGkiOiIxMzY2NDk4MjcxIn0.VSwvsTE-tS0sL_e9p9gNvHRkMCbsycSO4ObE4J2ysjs' \
--header 'Content-Type: application/json' \
--data '{
    "playerId": 1001,
    "password": "guildPass123"
}'

Response sample¶

{
    "code": 0,
    "message": "Success."
}

채널 퇴장 API¶

채널에 참여한 유저를 퇴장시킵니다.

채널 소유자가 퇴장하더라도 해당 채널은 유지됩니다. 단, 채널 소유자가 SYSTEM이 아니면서 참여자가 없는 채널은 주기적으로 삭제됩니다.

Request URL¶

서버	URL
LIVE	`https://api-chat.withhive.com/api/v1/games/{gameIndex}/channels/{channelId}/exit`
SANDBOX	`https://sandbox-api-chat.withhive.com/api/v1/games/{gameIndex}/channels/{channelId}/exit`
HTTP METHOD	`POST`
CONTENT-TYPE	`application/json`

Path parameters¶

필드명	설명	타입	필수 여부
gameIndex	하이브 게임 인덱스	integer	Y
channelId	채널 ID	string	Y

Header parameters¶

필드명	설명	타입	필수 여부
Authorization	API 호출을 위한 인증 토큰 (`Bearer`)	string	Y
Content-Type	요청 데이터의 타입 (`application/json`)	string	Y

Request body¶

필드명	설명	타입	필수 여부
playerId	퇴장시킬 유저 Player ID	long	Y

Response body¶

필드명	설명	타입
code	응답 결과 코드	integer
message	결과 메시지	string

Request sample¶

curl --request POST 'https://sandbox-api-chat.withhive.com/api/v1/games/1/channels/guild:12345/exit' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJIaXZlIiwiaWF0IjoxNzAyNDU4MTkzLCJqdGkiOiIxMzY2NDk4MjcxIn0.VSwvsTE-tS0sL_e9p9gNvHRkMCbsycSO4ObE4J2ysjs' \
--header 'Content-Type: application/json' \
--data '{
    "playerId": 1001
}'

Response sample¶

{
    "code": 0,
    "message": "Success."
}