사용자 정지 설정

사용자 UID로 사용자를 이용정지 처리합니다.

요청

POST https://dashboard-api.gamepot.ntruss.com/v1/api/project/{projectId}/user/{userId}/block
항목 타입 필수 여부 설명 비고
projectId String O GamePot SDK의 projectId
userId String O GamePot SDK의 userId

요청 헤더

헤더명 필수 여부 설명
x-api-key O GamePot에서 발급하는 인증 키
content-type O Request body content type을 application/json으로 지정
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 이용정지된 아이디

예시

요청 예시

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 프로젝트 아이디가 없는 경우
{
  "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 이미 이용정지가 설정된 사용자의 경우