Classic/VPC環境で利用できます。
ユーザーを指定して利用停止を実行します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| POST | /v2/memberblock |
リクエストヘッダ
GAMEPOT 3.0 APIで共通して使用されるヘッダの詳細は、GAMEPOT 3.0のリクエストヘッダをご参照ください。
リクエストボディ
リクエストボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
memberId |
String | Required | ユーザー ID
|
type |
String | Required | 利用停止の分類
|
status |
Integer | Required | 利用停止状態
|
messageMulti |
Array | Required | 利用停止理由の多言語情報: messageMulti |
startedAt |
String | Required | 利用停止の開始日時
|
endedAt |
String | Required | 利用停止の終了日時
|
messageMulti
messageMultiの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
lang |
String | Required | 言語コード
|
value |
String | Required | 理由のメッセージ |
default |
Boolean | Required | デフォルト言語かどうか
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request POST 'https://dashboard-api.gamepot.ntruss.com/v2/memberblock' \
--header 'x-api-key: {API Key}' \
--header 'x-project-id: {Project ID}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"memberId": "cc5f0f0e-****-****-****-28ffa3cee470",
"type": "manual",
"status": 1,
"messageMulti": [
{
"lang": "ko",
"value": "당신은 정지되었습니다.",
"default": true
},
{
"lang": "en",
"value": "Using the service is blocked by the admin",
"default": false
}
],
"startedAt": "2025-09-24 00:38",
"endedAt": "2025-09-24 06:38"
}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
memberBlock |
Object | - | 利用停止履歴 |
memberBlock.id |
String | - | 利用停止履歴 ID |
memberBlock.member_id |
String | - | ユーザー ID |
memberBlock.deleted |
Boolean | - | 利用停止履歴を削除するか
|
memberBlock.type |
String | - | 利用停止の分類
|
memberBlock.status |
Integer | - | 利用停止状態
|
memberBlock.message |
String | - | 利用停止の理由
|
memberBlock.messageMulti |
Array | - | 利用停止理由の多言語情報: messageMulti |
memberBlock.startedAt |
String | - | 利用停止の開始日時
|
memberBlock.endedAt |
String | - | 利用停止の終了日時
|
memberBlock.createdAt |
String | - | 利用停止履歴の作成日時
|
memberBlock.updatedAt |
String | - | 利用停止履歴の更新日時
|
memberBlock.deletedAt |
String | - | 利用停止履歴の削除日時
|
memberBlock.category_id |
String | - | 利用停止分類 ID |
messageMulti
messageMultiの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
lang |
String | - | 言語コード |
value |
String | - | 理由のメッセージ |
default |
Boolean | - | デフォルト言語かどうか
|
レスポンスステータスコード
GAMEPOT 3.0 APIで共通して使用されるレスポンスステータスコードの詳細は、GAMEPOT 3.0のレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"memberBlock": {
"id": "TWVtYmVyQ*******************************************ZjA1NTRlYWUw",
"member_id": "cc5f0f0e-****-****-****-28ffa3cee470",
"deleted": null,
"type": "manual",
"status": 1,
"message": null,
"messageMulti": [
{
"lang": "ko",
"value": "당신은 정지되었습니다.",
"default": true
},
{
"lang": "en",
"value": "Using the service is blocked by the admin",
"default": false
}
],
"startedAt": "2025-09-24T00:38:00+09:00",
"endedAt": "2025-09-24T06:38:00+09:00",
"createdAt": null,
"updatedAt": null,
"deletedAt": null,
"category_id": null
}
}