Name

Type

Mandatory

Description

appId

String

Y

앱 아이디

appSecret

String

Y

앱 시크릿

playerId

String

Y

플레이어 아이디

Content-Type

String

Y

"application/json;charset=UTF-8"

Authorization

String

Y

Authorization: KakaoAK {ADMIN_KEY}

예제) Authorization: KakaoAK 11118035a320f23423585acae3ded1111

voucherApiKey

String

Y

발송 교환권 key

isDuplicate

String

Y

중복 허용 여부 ("Y" or "N")

code

String

처리 결과

0인 경우 성공, 기타 값인 경우 실패

message

String

처리 메세지

200

정상 응답

정상

400

Bad Request

파싱되지 않는 요청 데이터. 필수 파라미터 부족 or 파라미터 타입 오류

401

Unauthenticated

인증 실패

406

Not Acceptable

처리 불가

461

Invalid Message Box

messageBoxId로 요청된 메시지 박스가 존재하지 않음.

500

Internal Server Error

서버 시스템 내부 오류

503

Service Unavailable

서비스가 가능하지 않은 상태 (예, 내부 서버간 timeout)

Name

Type

Mandatory

Description

appId

String

Y

앱 아이디

appSecret

String

Y

앱 시크릿

playerId

String

Y

플레이어 아이디

Content-Type

String

Y

"application/json;charset=UTF-8"

Authorization

String

Y

Authorization: KakaoAK {ADMIN_KEY}

예제) Authorization: KakaoAK 11118035a320f23423585acae3ded1111 

rewardEventCode

String

Y

미션달성형 이모티콘 이벤트 코드

code

String

처리 결과

200인 경우 성공, 기타 값인 경우 실패

message

String

처리 메세지

200

정상 응답

정상

400

Bad Request

파싱되지 않는 요청 데이터. 필수 파라미터 부족 or 파라미터 타입 오류

{
"code":-4400,
"msg":"[ApiExceptions::BadRequestError] 'user_id' is required."
}

401

Unauthenticated

인증 실패

403

가입되지 않은 사용자에 대해 요청한 경우

{
"code":-4403,
"msg":"[ApiExceptions::ForbiddenError] 66311 is not a member of the game"
}

403

(이벤트 실제 시작 전, 테스트 기간)
허용된 카카오톡 사용자 계정이 아닌 경우

(이벤트 실제 시작 전, 테스트 기간)
허용된 카카오톡 사용자 계정이 아닌 경우

403

잘못된 event code로 요청한 경우

{
"code":-4403,
"msg":"[ApiExceptions::ForbiddenError] Not acceptable event code ('n9WYM')"
}

404

존재하지 않은 리소스를 요청한 경우

{
"code":-4404,
"msg":"[ApiExceptions::ApiNotFoundError] ApiExceptions::ApiNotFoundError"
}

406

Not Acceptable

처리 불가

{
"code":-4406,
"msg":"[ApiExceptions::NotSupportedFormatError] ApiExceptions::NotSupportedFormatError"
}

406

이미 이모티콘을 지급받은 경우

{
"code":-4601,
"msg":"[ApiExceptions::DuplicatedError] Duplicated Request"
}

410

유효한 이벤트 기간이 아닌 경우

{
"code":-4410,
"msg":"[ApiExceptions::ExpiredError] Event n9WYM is expired"
}

461

Invalid Message Box

messageBoxId로 요청된 메시지 박스가 존재하지 않음.

500

Internal Server Error

서버 시스템 내부 오류

{
"code":-4604,
"msg":"[ApiExceptions::UserNotFoundError] User (71752787) account is not valid KakaoTalk account"
}

503

Service Unavailable

서비스가 가능하지 않은 상태 (예, 내부 서버간 timeout)

이 경우 반드시 차후에 다시 지급할 수 있도록 재지급 로직을 구현 해주시기 바랍니다.

{
"code":-4500,
"internal":{"result":"exceed"},
"msg":"[ApiExceptions::InternalApiResponseStatusError] Emoticon Request Failed"
}