チャンネル

このガイドでは、チャンネルの作成と削除、チャンネル情報の更新、チャンネルリストと参加者の取得に関するAPIの使用方法を説明します。

概要¶

チャネルは、チャットが行われる概念的な空間であり、すべてのゲーム内チャットはチャネル内で行われます。

このセクションでは、APIがサポートするチャネルタイプとチャネル操作方法について説明します。

チャンネルの種類¶

以下のチャネルタイプは、APIリクエストを介して作成できます。

チャンネルタイプ	メンバー	参加制限	切断時の離脱	主な使用ケース
`PUBLIC`	1 ~ 5000	最大10	O	オープンチャット、イベント
`GROUP`	1 ~ 500	最大10	X	ギルド、チーム、パーティ
`PRIVATE`	1 ~ 500	最大10	X	友達、プライベートグループ
`ONE_ON_ONE`	2	最大200	X	1:1チャット

PUBLIC チャンネルは、未指定の参加者とのオープンチャットに適しています。
ソケットサーバーに接続されているユーザーのみがチャンネルに参加できます。
GROUP および PRIVATE チャンネルは、ギルド、友人、またはパーティーなどのグループチャットに適しています。
PRIVATE チャンネルに参加するにはパスワードが必要です。

チャンネル操作¶

チャネルの基本的な操作は次のとおりです：

チャンネルには明確な入出力ポイントがあり、チャットサーバーは各ポイントで一貫した処理を提供します。
メッセージがチャンネルに送信されると、それはチャンネル内のすべてのユーザーに配信されます（ブロックされたユーザーを除く）。
チャンネルの参加者のみがチャンネルにメッセージを送信できます（通知メッセージは例外です）。

次に、チャネルAPIを使用したときの動作について説明します。

チャンネルの作成と削除¶

チャンネルを作成または1:1チャンネルを作成APIを使用してチャンネルを作成できます。
- 1:1チャンネル（ONE_ON_ONE）の場合は、1:1チャンネルを作成APIを使用します。
チャンネルは以下のケースで削除されます。
- チャンネルを削除APIが使用されたとき
- チャンネルの所有者がSYSTEMでなく、参加者がいない場合、チャンネルは定期的に削除されます。
参加者がいる間にチャンネルが削除された場合、参加者にチャンネル削除イベントが送信されます。

チャンネル情報の更新¶

チャンネル更新 APIを使用してチャンネル情報を更新できます。
- 更新可能な項目: チャンネル名、最大メンバー数、パスワード、チャット履歴の可用性
- 現在の参加者数を下回る最大メンバー数に減らした場合、既存の参加者は強制的に削除されません。
- 1:1チャンネル（ONE_ON_ONE）の情報は更新できません。

チャンネル作成API¶

新しいチャンネルを作成します。

リクエストボディパラメータ playerId が含まれている場合、その playerId を持つユーザーがチャンネルのオーナーとなり、自動的にチャンネルに参加します。 playerId が含まれていない場合、チャンネルのオーナーは SYSTEM に設定されます。

以下の種類のチャネルは定期的に削除されます:

所有者がSYSTEMでなく、参加者がいないチャンネル

リクエスト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 メソッド	`POST`
コンテンツタイプ	`application/json`

パスパラメータ¶

フィールド名	説明	タイプ	必須
gameIndex	Hive ゲームインデックス	整数	Y

ヘッダーパラメータ¶

フィールド名	説明	型	必須
Authorization	API呼び出しの認証トークン (`Bearer`)	文字列	Y
Content-Type	リクエストデータのタイプ (`application/json`)	文字列	Y

リクエストボディ¶

フィールド名	説明	タイプ	必須
channelId	チャンネルID (英字、数字、一部の特殊文字(`-`, `.`, `_`, `~`, `:`)が許可され、最大100文字)	string	Y
playerId	チャンネル作成者のプレイヤー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

レスポンスボディ¶

フィールド名	説明	型
code	レスポンス結果コード	整数
message	結果メッセージ	文字列
data	レスポンスデータ	オブジェクト

レスポンスボディ > データ¶

フィールド名	説明	型
channelId	チャンネルID	文字列
type	チャンネルタイプ (`PRIVATE`, `PUBLIC`, `GROUP`)	文字列
gameIndex	Hive ゲームインデックス	整数
owner	チャンネルオーナー	文字列
channelName	チャンネル名	文字列
maxMemberCount	チャンネル参加者の最大数	整数
chatHistoryAllowed	メッセージ履歴の表示可否	ブール
regTime	チャンネル作成日時 (`UTC+0` 標準, `yyyy-MM-dd'T'HH:mm:ss.SSSZ` 形式)	文字列
regTimeMillis	チャンネル作成日時 (UnixTimestamp ミリ秒)	長整数

リクエストサンプル¶

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": "Open Chat Room",
    "maxMemberCount": 100,
    "type": "PUBLIC",
    "chatHistoryAllowed": true
}'

応答サンプル¶

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

1:1 チャンネル API を作成¶

playerId と otherPlayerId に対応するユーザーを 1:1 チャンネル (ONE_ON_ONE) に参加させる 1:1 チャンネルを作成します。すでに 1:1 チャンネル (ONE_ON_ONE) が存在する場合は、既存のチャンネルに参加します。

各ユーザーは最大200の1:1チャネル（ONE_ON_ONE）を持つことができます。

リクエスト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`

パスパラメータ¶

フィールド名	説明	タイプ	必須
gameIndex	Hive ゲームインデックス	整数	Y

ヘッダーパラメータ¶

フィールド名	説明	タイプ	必須
Authorization	API呼び出しの認証トークン (`Bearer`)	文字列	Y
Content-Type	リクエストデータのタイプ (`application/json`)	文字列	Y

リクエストボディ¶

フィールド名	説明	タイプ	必須
playerId	プレイヤーID	long	Y
otherPlayerId	対戦相手のプレイヤーID	long	Y
chatHistoryAllowed	メッセージ履歴の表示可否（デフォルト: `false`）	boolean	N

レスポンスボディ¶

フィールド名	説明	タイプ
code	レスポンス結果コード	整数
message	結果メッセージ	文字列
data	レスポンスデータ	オブジェクト

レスポンスボディ > データ¶

フィールド名	説明	タイプ
channelId	チャンネルID	文字列
type	チャンネルタイプ (`ONE_ON_ONE`)	文字列
gameIndex	Hive ゲームインデックス	整数
owner	チャンネルオーナー	文字列
channelName	チャンネル名	文字列
maxMemberCount	チャンネル参加者の最大数	整数
chatHistoryAllowed	メッセージ履歴の表示可否	ブール値
regTime	チャンネル作成日時 (`UTC+0` 標準, `yyyy-MM-dd'T'HH:mm:ss.SSSZ` 形式)	文字列
regTimeMillis	チャンネル作成日時 (UnixTimestamp ミリ秒)	長整数

リクエストサンプル¶

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'{
    "playerId": 1000,
    "otherPlayerId": 2000,
    "chatHistoryAllowed": false
}'

応答サンプル¶

{
    "code": 0,
    "message": "Success.",
    "data": {
        "channelId": "V0FQBKSa9bWC33v",
        "type": "ONE_ON_ONE",
        "gameIndex": 1,
        "owner": "100",
        "channelName": "100&200",
        "chatHistoryAllowed": true,
        "maxMemberCount": 2,
        "regTime": "2025-07-18T09:37:36.697035738Z",
        "regTimeMillis": 1752831456697
    }
}

更新チャネルAPI¶

既存のチャンネルを更新します。

次のタイプのチャンネルのみが更新できます:

PUBLIC
PRIVATE
GROUP

チャットチャンネルの最大参加者数を更新する際、新しい制限よりも多くのユーザーが現在チャンネルにいる場合でも、既存のユーザーは強制的に削除されません。したがって、最大参加者数を現在の数よりも少なくすると、一時的に参加者数が最大制限を超える状態になります。

リクエスト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 メソッド	`PATCH`
コンテンツタイプ	`application/json`

パスパラメータ¶

フィールド名	説明	タイプ	必須
gameIndex	Hive ゲームインデックス	整数	Y
channelId	チャンネルID	文字列	Y

ヘッダーパラメータ¶

フィールド名	説明	タイプ	必須
Authorization	API呼び出しの認証トークン (`Bearer`)	文字列	Y
Content-Type	リクエストデータのタイプ (`application/json`)	文字列	Y

リクエストボディ¶

フィールド名	説明	タイプ	必須
channelName	チャンネル名 (最大50文字)	文字列	N
password	パスワード（`PRIVATE` チャンネルに必要） (最大50文字)	文字列	N
maxMemberCount	チャンネル参加者の最大数	整数	N
type	チャンネルタイプ（`PRIVATE`, `PUBLIC`, `GROUP`）	文字列	N
chatHistoryAllowed	メッセージ履歴の表示 (デフォルト: `false`)	ブール	N

レスポンスボディ¶

フィールド名	説明	タイプ
code	レスポンス結果コード	整数
message	結果メッセージ	文字列
data	レスポンスデータ	オブジェクト

リクエストサンプル¶

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": "Open Chat Room",
    "maxMemberCount": 100,
    "type": "PUBLIC",
    "chatHistoryAllowed": true
}'

レスポンスサンプル¶

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

チャンネル削除API¶

チャンネルを削除し、チャンネルに参加しているユーザーにチャンネル削除イベントを送信します。

リクエスト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 メソッド	`DELETE`

パスパラメータ¶

フィールド名	説明	タイプ	必須
gameIndex	Hive ゲームインデックス	整数	Y
channelId	チャンネルID	文字列	Y

ヘッダーパラメータ¶

フィールド名	説明	タイプ	必須
Authorization	API呼び出しの認証トークン (`Bearer`)	文字列	Y

レスポンスボディ¶

フィールド名	説明	タイプ
code	レスポンス結果コード	整数
message	結果メッセージ	文字列

リクエストサンプル¶

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

レスポンスサンプル¶

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

チャンネルを取得するAPI¶

作成されたチャンネルのリストを取得します。取得できるチャンネルの種類は以下の通りです：

PUBLIC
PRIVATE
GROUP

リクエスト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`

パスパラメータ¶

フィールド名	説明	型	必須
gameIndex	Hive ゲームインデックス	整数	Y

ヘッダーパラメータ¶

フィールド名	説明	タイプ	必須
Authorization	API呼び出しの認証トークン (`Bearer`)	文字列	Y

クエリパラメータ¶

フィールド名	説明	タイプ	必須
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

レスポンスボディ¶

フィールド名	説明	種類
code	レスポンス結果コード	整数
message	結果メッセージ	文字列
data	レスポンスデータ	オブジェクト

レスポンスボディ > データ¶

フィールド名	説明	タイプ
content	チャンネルのリスト	オブジェクト配列
page	ページ情報	オブジェクト

レスポンスボディ > データ > コンテンツ¶

フィールド名	説明	タイプ
channelId	チャンネルID	文字列
type	チャンネルタイプ（`PRIVATE`, `PUBLIC`, `GROUP`）	文字列
gameIndex	Hive ゲームインデックス	整数
owner	チャンネルオーナーのプレイヤーID	文字列
channelName	チャンネル名	文字列
memberCount	チャンネルの現在の参加者数	整数
maxMemberCount	チャンネルの最大参加者数	整数
chatHistoryAllowed	メッセージ履歴の表示可否	ブール
regTime	チャンネル作成日時（`UTC+0`標準、`yyyy-MM-dd'T'HH:mm:ss.SSSZ`形式）	文字列
regTimeMillis	チャンネル作成日時（UnixTimestampミリ秒）	長整数

レスポンスボディ > データ > ページ¶

フィールド名	説明	タイプ
size	ページあたりのアイテム数	整数
currentPage	現在のページ番号	整数
totalElements	アイテムの総数	整数
totalPages	ページの総数	整数

リクエストサンプル¶

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'

応答サンプル¶

{
  "code": 0,
  "message": "Success.",
  "data": {
    "content": [
      {
        "channelId": "open:12345",
        "type": "PUBLIC",
        "gameIndex": 1,
        "owner": "1000",
        "channelName": "Open Chat Room",
        "memberCount": 2,
        "maxMemberCount": 50,
        "chatHistoryAllowed": true,
        "regTime": "2024-12-30T15:01:01.004Z",
        "regTimeMillis": 1731306364351
      },
      /// ... Channel information
    ],
    "page": {
      "size": 10,
      "currentPage": 1,
      "totalElements": 100,
      "totalPages": 10
    }
  }
}

チャンネルAPIを取得¶

特定のチャンネルに関する詳細情報を取得します。

リクエスト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 メソッド	`GET`

パスパラメータ¶

フィールド名	説明	タイプ	必須
gameIndex	Hive ゲームインデックス	整数	Y
channelId	チャンネルID	文字列	Y

ヘッダーパラメータ¶

フィールド名	説明	タイプ	必須
Authorization	API呼び出しの認証トークン (`Bearer`)	文字列	Y

レスポンスボディ¶

フィールド名	説明	タイプ
code	レスポンス結果コード	整数
message	結果メッセージ	文字列
data	レスポンスデータ	オブジェクト

レスポンスボディ > データ¶

フィールド名	説明	タイプ
info	チャンネル情報	オブジェクト
members	参加者のリスト	オブジェクト配列

レスポンスボディ > データ > 情報¶

フィールド名	説明	タイプ
channelId	チャンネルID	文字列
type	チャンネルタイプ（`PRIVATE`, `PUBLIC`, `GROUP`, `ONE_ON_ONE`）	文字列
gameIndex	Hive ゲームインデックス	整数
owner	チャンネルオーナー	文字列
channelName	チャンネル名	文字列
memberCount	チャンネル内の現在の参加者数	整数
maxMemberCount	チャンネル参加者の最大数	整数
chatHistoryAllowed	メッセージ履歴の表示可否	ブール
regTime	チャンネル作成日時（`UTC+0`標準、`yyyy-MM-dd'T'HH:mm:ss.SSSZ`形式）	文字列
regTimeMillis	チャンネル作成日時（UnixTimestampミリ秒）	長整数

レスポンスボディ > データ > メンバー¶

フィールド名	説明	型
playerId	プレイヤーID	long

リクエストサンプル¶

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

応答サンプル¶

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

チャンネルメンバー取得API¶

チャンネルに参加しているユーザーに関する情報を取得します。

リクエスト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`

パスパラメータ¶

フィールド名	説明	タイプ	必須
gameIndex	Hive ゲームインデックス	整数	Y
channelId	チャンネルID	文字列	Y

ヘッダーパラメータ¶

フィールド名	説明	タイプ	必須
Authorization	API呼び出しの認証トークン (`Bearer`)	文字列	Y

応答本文¶

フィールド名	説明	タイプ
code	レスポンス結果コード	整数
message	結果メッセージ	文字列
data	レスポンスデータ	オブジェクト

レスポンスボディ > データ¶

フィールド名	説明	タイプ
members	チャンネル参加者のリスト	オブジェクト配列

レスポンスボディ > データ > メンバー¶

フィールド名	説明	タイプ
playerId	プレイヤーID	long

リクエストサンプル¶

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

応答サンプル¶

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

チャンネルAPIに入る¶

特定のユーザーがチャンネルに参加できるようにします。

リクエスト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`

パスパラメータ¶

フィールド名	説明	タイプ	必須
gameIndex	Hive ゲームインデックス	整数	Y
channelId	チャンネルID	文字列	Y

ヘッダーパラメータ¶

フィールド名	説明	タイプ	必須
Authorization	API呼び出しの認証トークン（`Bearer`）	文字列	Y
Content-Type	リクエストデータのタイプ（`application/json`）	文字列	Y

リクエストボディ¶

フィールド名	説明	タイプ	必須
playerId	参加するユーザーのプレイヤーID	long	Y
password	パスワード（`PRIVATE` チャンネルに必要）	string	N

レスポンスボディ¶

フィールド名	説明	タイプ
code	レスポンス結果コード	整数
message	結果メッセージ	文字列

リクエストサンプル¶

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"
}'

レスポンスサンプル¶

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

エグジットチャネルAPI¶

ユーザーがチャンネルを退出することを許可します。

所有者が退出しても、所有者がSYSTEMでなく、参加者がいない場合を除いて、チャンネルは削除されません。

リクエスト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`

パスパラメータ¶

フィールド名	説明	タイプ	必須
gameIndex	Hive ゲームインデックス	整数	Y
channelId	チャンネルID	文字列	Y

ヘッダーパラメータ¶

フィールド名	説明	タイプ	必須
Authorization	API呼び出しの認証トークン (`Bearer`)	文字列	Y
Content-Type	リクエストデータのタイプ (`application/json`)	文字列	Y

リクエストボディ¶

フィールド名	説明	タイプ	必須
playerId	退出するユーザーのプレイヤーID	long	Y

応答本文¶

フィールド名	説明	型
code	レスポンス結果コード	整数
message	結果メッセージ	文字列

リクエストサンプル¶

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
}'

応答サンプル¶

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