29.1. Server API 예제 (/talk)
- kate.psy (Unlicensed)
/talk/reward/send (kakaogame sdk 3.0 사용 시 사용)
Description
kakaogame sdk 3.0 플레이어의 연결된 카카오톡으로 이모티콘/초코 보상 발송을 요청합니다.
카카오 리워드비즈파트와의 계약 이후 kakaoRewardApiKey를 발급받은 상태에서 API를 사용하실 수 있습니다.
발송 요청은 초당 100건 이하로 설정해주세요.
Method
POST
Request Headers
게임 서버에서 호출하는 경우
Name | Type | Mandatory | Description |
appId | String | Y | 앱 아이디
|
appSecret | String | Y | 앱 시크릿 |
playerId | String | Y | 플레이어 아이디 |
Authorization | String | Y | KakaoAK {ADMIN_KEY} 설정 |
Content-Type | String | Y | "application/json;charset=UTF-8" |
Request Body Parameters
Name | Type | Mandatory | Description |
|---|---|---|---|
kakaoRewardApiKey | String | Y | 카카오톡 이모티콘/초코 보상 정의 키 카카오 리워드비즈파트와의 계약 이후 발급받을 수 있습니다. |
Response Status Code
Status Code | Status Code 설명 | Status Code 상세 설명 |
|---|---|---|
200 | 정상 응답 | 정상 |
400 | Bad Request | 파싱되지 않는 요청 데이터. 필수 파라미터 부족 or 파라미터 타입 오류 |
401 | Unauthenticated | 인증 실패 |
406 | Not Acceptable | 처리 불가 |
461 | Invalid Message Box | messageBoxId로 요청된 메시지 박스가 존재하지 않음. |
500 | Internal Server Error | 서버 시스템 내부 오류 |
503 | Service Unavailable | 서비스가 가능하지 않은 상태 (예, 내부 서버간 timeout) |
Response Content
Name | Type | Description |
|---|---|---|
detail_code | Integer | 응답 코드 Http response code가 200(OK)이 아닌 경우 참고를 위해 사용합니다. |
msg | String | 응답 메세지 Http response code가 200(OK)이 아닌 경우 참고를 위해 사용합니다. |
detail_code / msg
Http response code | detail_code | msg | Description |
|---|---|---|---|
200 | 100 | success | 성공 |
201 | 110 | in_progress | 동시에 중복 요청이 들어온 경우 |
400 | 0 | fail | 실패 |
400 | 999 | invalid_api_key | api key가 올바르지 않습니다. |
400 | 4001 | not_enough_budget | 예산이 다 소진되었습니다. |
400 | 4003 | invalid_parameter | http request 파라미터가 올바르지 않습니다. |
400 | 4004 | already_issue | 이미 리워드가 지급되었습니다. |
400 | 4006 | not_join_account | 플레이어의 연결된 카카오톡 계정이 존재하지 않습니다. |
400 | 4009 | need_active | 아직 검수가 끝나지 않았습니다. |
400 | 4010 | ad_not_configured | 광고를 보여주기 위한 정적 파일이 등록되지 않았습니다. |
400 | 4016 | retry_later | 조금 후 다시 시도해주세요. |
400 | 4017 | issue_long_time_ago | 지난 광고에서 이미 이모티콘을 받았습니다. |
400 | 4018 | invalid_country | 해외 사용자에 대해 이모티콘 지급 요청이 왔습니다.
|
406 | 4006 | invalid player | 플레이어의 연결된 카카오톡 계정이 존재하지 않습니다. |
406 | 5001 | player status is not normal | 해당 계정은 제재 or 탈퇴 대기 상태 입니다. |
500 | 0 | internal server error | 실패 |
Example Request
POST /service/v3/talk/reward/send HTTP/1.1
Host: openapi-zinny3.game.kakao.com:10443
Content-Type: application/json;charset=UTF-8
appId: 103815
appSecret: 951b75bf17fe0885ab5106ba2a9f9bc9
playerId: 332121989177
Authorization: KakaoAK xxxx8035a320f789f585acae3dedxxxx
{
"kakaoRewardApiKey": "87b46dfdc3158c2f31cbcfb31b26ac75"
} |
Example Response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"detail_code": 100,
"msg": "success"
} |
/talk/capri/reward/send (kakaogame sdk 2.0 사용 시 사용)
Description
kakaogame sdk 2.0 플레이어의 연결된 카카오톡으로 이모티콘/초코 보상 발송을 요청합니다.
카카오 리워드비즈파트와의 계약 이후 kakaoRewardApiKey를 발급받은 상태에서 API를 사용하실 수 있습니다.
발송 요청은 초당 100건 이하로 설정해주세요.
Method
POST
Request Headers
게임 서버에서 호출하는 경우
Name | Type | Mandatory | Description |
appId | String | Y | 앱 아이디
|
appSecret | String | Y | 앱 시크릿 |
Authorization | String | Y | KakaoAK {ADMIN_KEY} 설정 |
Content-Type | String | Y | "application/json;charset=UTF-8" |
Request Body Parameters
Name | Type | Mandatory | Description |
|---|---|---|---|
appUserId | Long | Y | 플레이어 앱 유저 아이디 |
kakaoRewardApiKey | String | Y | 카카오톡 이모티콘/초코 보상 정의 키 카카오 리워드비즈파트와의 계약 이후 발급받을 수 있습니다. |
Response Status Code
Status Code | Status Code 설명 | Status Code 상세 설명 |
|---|---|---|
200 | 정상 응답 | 정상 |
400 | Bad Request | 파싱되지 않는 요청 데이터. 필수 파라미터 부족 or 파라미터 타입 오류 |
401 | Unauthenticated | 인증 실패 |
406 | Not Acceptable | 처리 불가 |
461 | Invalid Message Box | messageBoxId로 요청된 메시지 박스가 존재하지 않음. |
500 | Internal Server Error | 서버 시스템 내부 오류 |
503 | Service Unavailable | 서비스가 가능하지 않은 상태 (예, 내부 서버간 timeout) |
Response Content
Name | Type | Description |
|---|---|---|
detail_code | Integer | 응답 코드 Http response code가 200(OK)이 아닌 경우 참고를 위해 사용합니다. |
msg | String | 응답 메세지 Http response code가 200(OK)이 아닌 경우 참고를 위해 사용합니다. |
detail_code / msg
Http response code | detail_code | msg | Description |
|---|---|---|---|
200 | 100 | success | 성공 |
201 | 110 | in_progress | 동시에 중복 요청이 들어온 경우 |
400 | 0 | fail | 실패 |
400 | 999 | invalid_api_key | api key가 올바르지 않습니다. |
400 | 4001 | not_enough_budget | 예산이 다 소진되었습니다. |
400 | 4003 | invalid_parameter | http request 파라미터가 올바르지 않습니다. |
400 | 4004 | already_issue | 이미 리워드가 지급되었습니다. |
400 | 4006 | not_join_account | 플레이어의 연결된 카카오톡 계정이 존재하지 않습니다. |
400 | 4009 | need_active | 아직 검수가 끝나지 않았습니다. |
400 | 4010 | ad_not_configured | 광고를 보여주기 위한 정적 파일이 등록되지 않았습니다. |
400 | 4016 | retry_later | 조금 후 다시 시도해주세요. |
400 | 4017 | issue_long_time_ago | 지난 광고에서 이미 이모티콘을 받았습니다. |
400 | 4018 | invalid_country | 해외 사용자에 대해 이모티콘 지급 요청이 왔습니다.
|
406 | 4006 | invalid player | 플레이어의 연결된 카카오톡 계정이 존재하지 않습니다. |
406 | 5001 | player status is not normal | 해당 계정은 제재 or 탈퇴 대기 상태 입니다. |
500 | 0 | internal server error | 실패 |
Example Request
POST /service/v3/talk/capri/reward/send HTTP/1.1
Host: openapi-zinny3.game.kakao.com:10443
Content-Type: application/json;charset=UTF-8
appId: 103815
appSecret: 951b75bf17fe0885ab5106ba2a9f9bc9
Authorization: KakaoAK c0948035a320f789f585acae3dedcd70
{
"appUserId": 1376016924426669000,
"kakaoRewardApiKey": "87b46dfdc3158c2f31cbcfb31b26ac75"
} |
Example Response
/talk/legacy/reward/send (kakaogame sdk 1.0 사용 시 사용)
Description
kakaogame sdk 1.0 플레이어의 연결된 카카오톡으로 이모티콘/초코 보상 발송을 요청합니다.
카카오 리워드비즈파트와의 계약 이후 kakaoRewardApiKey를 발급받은 상태에서 API를 사용하실 수 있습니다.
발송 요청은 초당 100건 이하로 설정해주세요.
Method
POST
Request Headers
게임 서버에서 호출하는 경우
Name | Type | Mandatory | Description |
Content-Type | String | Y | "application/json;charset=UTF-8" |
Request Body Parameters
Name | Type | Mandatory | Description |
|---|---|---|---|
clientId | String | Y | 클라이언트 아이디 |
secretKey | String | Y | 서버 to 서버 API 호출에 필요한 시크릿 키 |
serviceUserId | Long | Y | 서비스 유저 아이디 |
kakaoRewardApiKey | String | Y | 카카오톡 이모티콘/초코 보상 정의 키 카카오 리워드비즈파트와의 계약 이후 발급받을 수 있습니다. |
Response Status Code
Status Code | Status Code 설명 | Status Code 상세 설명 |
|---|---|---|
200 | 정상 응답 | 정상 |
400 | Bad Request | 파싱되지 않는 요청 데이터. 필수 파라미터 부족 or 파라미터 타입 오류 |
401 | Unauthenticated | 인증 실패 |
406 | Not Acceptable | 처리 불가 |
461 | Invalid Message Box | messageBoxId로 요청된 메시지 박스가 존재하지 않음. |
500 | Internal Server Error | 서버 시스템 내부 오류 |
503 | Service Unavailable | 서비스가 가능하지 않은 상태 (예, 내부 서버간 timeout) |
Response Content
Name | Type | Description |
|---|---|---|
detail_code | Integer | 응답 코드 Http response code가 200(OK)이 아닌 경우 참고를 위해 사용합니다. |
msg | String | 응답 메세지 Http response code가 200(OK)이 아닌 경우 참고를 위해 사용합니다. |
detail_code / msg
Http response code | detail_code | msg | Description |
|---|---|---|---|
200 | 100 | success | 성공 |
201 | 110 | in_progress | 동시에 중복 요청이 들어온 경우 |
400 | 0 | fail | 실패 |
400 | 999 | invalid_api_key | api key가 올바르지 않습니다. |
400 | 4001 | not_enough_budget | 예산이 다 소진되었습니다. |
400 | 4003 | invalid_parameter | http request 파라미터가 올바르지 않습니다. |
400 | 4004 | already_issue | 이미 리워드가 지급되었습니다. |
400 | 4006 | not_join_account | 플레이어의 연결된 카카오톡 계정이 존재하지 않습니다. |
400 | 4009 | need_active | 아직 검수가 끝나지 않았습니다. |
400 | 4010 | ad_not_configured | 광고를 보여주기 위한 정적 파일이 등록되지 않았습니다. |
400 | 4016 | retry_later | 조금 후 다시 시도해주세요. |
400 | 4017 | issue_long_time_ago | 지난 광고에서 이미 이모티콘을 받았습니다. |
400 | 4018 | invalid_country | 해외 사용자에 대해 이모티콘 지급 요청이 왔습니다.
|
406 | 4006 | invalid player | 플레이어의 연결된 카카오톡 계정이 존재하지 않습니다. |
406 | 5001 | player status is not normal | 해당 계정은 제재 or 탈퇴 대기 상태 입니다. |
500 | 0 | internal server error | 실패 |
Example Request
Example Response
/talk/brandEmoticon/send
Description
kakaogame sdk 3.0 플레이어의 연결된 카카오톡으로 프렌즈 이모티콘 발송을 요청합니다.
발송 요청은 초당 100건 이하로 설정해주세요.
Method
POST
Request Headers
게임 서버에서 호출하는 경우
Name | Type | Mandatory | Description |
appId | String | Y | 앱 아이디
|
appSecret | String | Y | 앱 시크릿 |
playerId | String | Y | 플레이어 아이디 |
Authorization | String | Y | Authorization: KakaoAK {ADMIN_KEY} 예제) Authorization: KakaoAK 11118035a320f23423585acae3ded1111 |
Content-Type | String | Y | "application/json;charset=UTF-8" |
Request Body Parameters
Name | Type | Mandatory | Description |
|---|---|---|---|
brandEmoticonKey | String | Y | 지급할 브랜드 이모티콘 키 |
Response Status Code
Status Code | Status Code 설명 | Status Code 상세 설명 |
|---|---|---|
200 | 정상 응답 | 정상 |
400 | Bad Request | 파싱되지 않는 요청 데이터. 필수 파라미터 부족 or 파라미터 타입 오류 |
401 | Unauthenticated | 인증 실패 |
406 | Not Acceptable | 처리 불가 |
461 | Invalid Message Box | messageBoxId로 요청된 메시지 박스가 존재하지 않음. |
500 | Internal Server Error | 서버 시스템 내부 오류 |
503 | Service Unavailable | 서비스가 가능하지 않은 상태 (예, 내부 서버간 timeout) |
Response Content
Name | Type | Description |
|---|---|---|
result | String | 처리 결과 메세지 "ok" : 성공 "invalid_key" : 잘못된 키 값 "expired_key" : 만료된 키 값 "invalid_talkuserid" : 카톡에 가입되지 않은 사용자 "duplicated" : 이미 이모티콘 지급 받음 "exceed" : 지급 수량 초과 "no_such_player" : 존재하지 않는 플레이어 정보 "player_status_is_not_normal" : 플레이어 상태가 정상이 아닌 경우 (탈퇴 대기, 재제 상태) |
Example Request
Example Response