チャンネル

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

概要¶

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

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

チャンネルタイプ¶

APIを通じて作成できるチャネルタイプは以下の通りです:

チャンネルタイプ	容量	最大参加チャンネル数	切断時にチャンネルを離れる	主な用途
`PUBLIC`	1 – 5,000	最大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を使用して、チャンネル情報を変更できます。
- 変更可能なフィールド: チャンネル名、最大メンバー数、パスワード、およびチャット履歴の可用性
- チャンネルに既に100人の参加者がいる場合でも、最大メンバー数を50に変更しても、既存の参加者のステータスには影響しません。
- 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 METHOD	`POST`
CONTENT-TYPE	`application/json`

パスパラメータ¶

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

ヘッダーパラメータ¶

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

リクエストボディ¶

フィールド	説明	タイプ	必須
channelId	チャンネルID (大文字/小文字の文字、数字、および一部の特殊文字（`-`, `.`, `_`, `~`, `:`）が許可され、最大100文字)	文字列	Y
playerId	チャンネル作成者のプレイヤーID	長整数	N
password	パスワード（`PRIVATE` チャンネルに必要） (最大50文字)	文字列	N
channelName	チャンネル名 (最大50文字)	文字列	Y
maxMemberCount	チャンネル参加者の最大数 (最小2 – 最大5,000)	整数	Y
type	チャンネルタイプ（`PRIVATE`, `PUBLIC`, `GROUP`）	文字列	Y
chatHistoryAllowed	メッセージ履歴が利用可能かどうか (デフォルト: `false`)	ブール値	N

レスポンスボディ¶

フィールド	説明	種類
code	レスポンス結果コード	整数
message	結果メッセージ	文字列
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ミリ秒）	long

リクエストサンプル¶

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チャネルが同じユーザーで既に存在する場合、既存のチャネルに参加します。

リクエスト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 メソッド	`POST`
CONTENT-TYPE	`application/json`

パスパラメータ¶

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

ヘッダーパラメータ¶

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

リクエストボディ¶

フィールド	説明	タイプ	必須
channelId	チャンネルID (大文字/小文字のアルファベット、数字、および一部の特殊文字（`-`, `.`, `_`, `~`, `:`）が許可され、最大100文字)	文字列	はい
channelName	チャンネル名（最大50文字）	文字列	はい
playerId	プレイヤーID	長整数	はい
otherPlayerId	他のプレイヤーのプレイヤーID	長整数	はい
chatHistoryAllowed	メッセージ履歴が利用可能かどうか（デフォルト: `false`）	ブール値	いいえ

レスポンスボディ¶

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

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

フィールド	説明	タイプ
channelId	チャンネルID	string
type	チャンネルタイプ (`ONE_ON_ONE`)	string
gameIndex	ハイブゲームインデックス	integer
owner	チャンネルオーナー	string
channelName	チャンネル名	string
maxMemberCount	チャンネル参加者の最大数	integer
participants	参加者のプレイヤーIDのリスト	array
chatHistoryAllowed	メッセージ履歴が利用可能かどうか	boolean
regTime	チャンネル作成日時（`UTC+0`に基づく、フォーマット: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`）	string
regTimeMillis	チャンネル作成日時（UnixTimestampミリ秒）	long

リクエストサンプル¶

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

応答サンプル¶

{
    "code": 0,
    "message": "Success.",
    "data": {
        "channelId": "1on1:test",
        "type": "ONE_ON_ONE",
        "gameIndex": 1,
        "owner": "1000",
        "channelName": "Test 1:1 Channel",
        "chatHistoryAllowed": false,
        "maxMemberCount": 2,
        "participants": [1000, 2000],
        "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	ハイブゲームインデックス	整数	Y
channelId	チャンネルID	文字列	Y

ヘッダーパラメータ¶

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

リクエストボディ¶

フィールド	説明	タイプ	必須
channelName	チャンネル名 (最大50文字)	string	N
password	パスワード（`PRIVATE` チャンネルに必要） (最大50文字)	string	N
maxMemberCount	チャンネル参加者の最大数	integer	N
type	チャンネルタイプ（`PRIVATE`, `PUBLIC`, `GROUP`）	string	N
chatHistoryAllowed	メッセージ履歴が利用可能かどうか (デフォルト: `false`)	boolean	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	ハイブゲームインデックス	整数	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 メソッド	`GET`

パスパラメータ¶

フィールド	説明	タイプ	必須
gameIndex	ハイブゲームインデックス	整数	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	ハイブゲームインデックス	整数
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 info
    ],
    "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 METHOD	`GET`

パスパラメータ¶

フィールド	説明	タイプ	必須
gameIndex	ハイブゲームインデックス	整数	Y
channelId	取得するチャンネルID	文字列	Y

ヘッダーパラメータ¶

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

レスポンスボディ¶

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

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

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

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

フィールド	説明	タイプ
channelId	チャンネルID	文字列
type	チャンネルタイプ（`PRIVATE`, `PUBLIC`, `GROUP`, `ONE_ON_ONE`）	文字列
gameIndex	ハイブゲームインデックス	整数
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 メソッド	`GET`

パスパラメータ¶

フィールド	説明	タイプ	必須
gameIndex	ハイブゲームインデックス	整数	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

レスポンスボディ¶

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

リクエストサンプル¶

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	ハイブゲームインデックス	整数	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."
}