设置用户停用

使用用户UID进行用户停用处理。

请求

---

POST https://dashboard-api.gamepot.ntruss.com/v1/api/project/{projectId}/user/{userId}/block

请求头

报头名称	是否为必填项	描述
x-api-key	O	GamePot发放的认证密钥
accept-language	X	使用语言

请求体

项目	类型	是否为必填项	描述	备注
lang	String	O	停用消息语言
value	String	O	停用原因消息
default	Boolean	O	设置默认语言 设备语言值未在messageMulti时，会默认显示设置为true的消息。	true, false
startedAt	String	O	停用开始日期	YYYY-MM-DD HH:mm
endedAt	String	O	停用结束日期	YYYY-MM-DD HH:mm

响应

---

字段名称	类型	描述
status	Int	结果值\（1：成功\）
id	String	已停用的ID

示例

---

请求示例

curl --request POST \
--url https://dashboard-api.gamepot.ntruss.com/v1/api/project/12a0f2ff-xxxx-xxxx-xxxx-9c13ef02f5fs/user/h43ea8e8-xxxx-xxxx-xxxx-531a46d25eef/block \
--header 'accept-language:ko' \
--header 'content-type:application/json' \
--header 'x-api-key:86dcgffae0641745432as02a8801ce5a5475f764fxxxxxxxxx'
  --data '{
	"messageMulti":[
		{
			"lang":"ko",
			"value":"测试-ko",
			"default":true
		}
	],
	"startedAt":"2020-05-11 12:02",
	"endedAt":"2020-05-25 22:00"
}'

响应示例

{
  "status":1,
  "result":{
    "memberBlock":{
      "id":"xxxxxxxxxxxxx"
    }
  }
}

错误代码

---

发送Gamepot Open API请求时发生的通用错误代码。

参数	描述
status	错误代码\（1：成功，失败时请参考Error code\）
message	错误详细描述

错误代码	描述
-1	使用了仪表盘上没有的密钥时
-2	仪表盘密钥和报头的密钥不同时
-3	使用了仪表盘已删除的密钥时
-4	使用了仪表盘中作为未使用处理的密钥时
-5	密钥到期时
-6	没有项目ID时

{ 
    "status":-6, 
    "message":"projectId was wrong." 
}

发送用户停用设置的API请求时发生的错误代码。

错误代码	描述
-11	body缺少数据
-12	messageMulti值不是JSON Array时
-13	startedAt值的格式有误时，仅可使用YYYY-MM-DD HH:mm形式
-14	endedAt值的格式有误时，仅可使用YYYY-MM-DD HH:mm形式
-15	messageMulti值的data格式有误时，
-16	messageMulti值的data中没有default true或存在多个时
-100	该用户已设置为停用用户时