29.1. Server API Examples (/talk)
- kate.psy (Unlicensed)
/talk/reward/send
Description
Requests the delivery of emoticons/Choco to the KakaoTalk accounts linked to the Kakaogame SDK 3.0 Player.
API can be used after entering into an agreement with the Kakao Reward Biz Part and having kakaoRewardApiKey issued.
Set the delivery request limit to 100 or less per second.
Method
POST
Request Headers
When requested from the game server
Name | Type | Mandatory | Description |
appId | String | Y | Game app ID
|
appSecret | String | Y | Authentication key issued for each game |
playerId | String | Y | Player ID |
Authorization | String | Y | KakaoAK {ADMIN_KEY} Settings |
Content-Type | String | Y | "application/json;charset=UTF-8" |
Request Body Parameters
Name | Type | Mandatory | Description |
|---|---|---|---|
kakaoRewardApiKey | String | Y | KakaoTalk Emoticon/Choco Reward Definition Key Can be issued after entering into an agreement with the Kakao Reward Biz Part. |
Response Status Code
Status Code | Status Code Description | Status Code Details |
|---|---|---|
200 | Normal Response | Normal |
400 | Bad Request | Request data that is not parsed. Required parameter missing or parameter type error |
401 | Unauthenticated | Authentication failed |
406 | Not Acceptable | Unable to process |
461 | Invalid Message Box | Message box with the requested messageBoxId does not exist. |
500 | Internal Server Error | Server system internal error |
503 | Service Unavailable | When service is not available (ex. timeout between internal servers) |
Response Content
Name | Type | Description |
|---|---|---|
detail_code | Integer | Response Code Used for reference when Http response code is not 200 (OK). |
msg | String | Response Message Used for reference when Http response code is not 200 (OK). |
detail_code / msg
Http response code | detail_code | msg | Description |
|---|---|---|---|
200 | 100 | success | Success |
201 | 110 | in_progress | At the same time, a duplicate request is received |
400 | 0 | fail | Fail |
400 | 999 | invalid_api_key | api key is incorrect. |
400 | 4001 | not_enough_budget | The budget is depleted. |
400 | 4003 | invalid_parameter | http request parameter is not correct. |
400 | 4004 | already_issue | The reward is already issued. |
400 | 4006 | not_join_account | There is no KakaoTalk account linked to the player. |
400 | 4009 | need_active | The review is not completed yet. |
400 | 4010 | ad_not_configured | The static file for displaying advertisements is not registered. |
400 | 4016 | retry_later | Please try again later. |
400 | 4017 | issue_long_time_ago | Emoticon has been issued in the past advertisement. |
400 | 4018 | invalid_country | Received a request to issue an emoticon for an overseas user.
|
406 | 4006 | invalid player | There is no KakaoTalk account linked to the player. |
406 | 5001 | player status is not normal | The account is suspended or pending withdrawal. |
500 | 0 | internal server error | Fail |
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
Description
Requests the delivery of emoticons/Choco to the KakaoTalk accounts linked to the Kakaogame SDK 2.0 Player.
API can be used after entering into an agreement with the Kakao Reward Biz Part and having kakaoRewardApiKey issued.
Set the delivery request limit to 100 or less per second.
Method
POST
Request Headers
When requested from the game server
Name | Type | Mandatory | Description |
appId | String | Y | Game app ID
|
appSecret | String | Y | Authentication key issued for each game |
Authorization | String | Y | KakaoAK {ADMIN_KEY} Settings |
Content-Type | String | Y | "application/json;charset=UTF-8" |
Request Body Parameters
Name | Type | Mandatory | Description |
|---|---|---|---|
appUserId | Long | Y | Player App User ID |
kakaoRewardApiKey | String | Y | KakaoTalk Emoticon/Choco Reward Definition Key Can be issued after entering into an agreement with the Kakao Reward Biz Part. |
Response Status Code
Status Code | Status Code Description | Status Code Details |
|---|---|---|
200 | Normal Response | Normal |
400 | Bad Request | Request data that is not parsed. Required parameter missing or parameter type error |
401 | Unauthenticated | Authentication failed |
406 | Not Acceptable | Unable to process |
461 | Invalid Message Box | Message box with the requested messageBoxId does not exist. |
500 | Internal Server Error | Server system internal error |
503 | Service Unavailable | When service is not available (ex. timeout between internal servers) |
Response Content
Name | Type | Description |
|---|---|---|
detail_code | Integer | Response Code Used for reference when Http response code is not 200 (OK). |
msg | String | Response Message Used for reference when Http response code is not 200 (OK). |
detail_code / msg
Http response code | detail_code | msg | Description |
|---|---|---|---|
200 | 100 | success | Success |
201 | 110 | in_progress | At the same time, a duplicate request is received |
400 | 0 | fail | Fail |
400 | 999 | invalid_api_key | api key is incorrect. |
400 | 4001 | not_enough_budget | The budget is depleted. |
400 | 4003 | invalid_parameter | http request parameter is not correct. |
400 | 4004 | already_issue | The reward is already issued. |
400 | 4006 | not_join_account | There is no KakaoTalk account linked to the player. |
400 | 4009 | need_active | The review is not completed yet. |
400 | 4010 | ad_not_configured | The static file for displaying advertisements is not registered. |
400 | 4016 | retry_later | Please try again later. |
400 | 4017 | issue_long_time_ago | Emoticon has been issued in the past advertisement. |
400 | 4018 | invalid_country | Received a request to issue an emoticon for an overseas user.
|
406 | 4006 | invalid player | There is no KakaoTalk account linked to the player. |
406 | 5001 | player status is not normal | The account is suspended or pending withdrawal. |
500 | 0 | internal server error | Fail |
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
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"detail_code": 100,
"msg": "success"
} |
/talk/legacy/reward/send
Description
Requests the delivery of emoticons/Choco to the KakaoTalk accounts linked to the Kakaogame SDK 1.0 Player.
API can be used after entering into an agreement with the Kakao Reward Biz Part and having kakaoRewardApiKey issued.
Set the delivery request limit to 100 or less per second.
Method
POST
Request Headers
When requested from the game server
Name | Type | Mandatory | Description |
Content-Type | String | Y | "application/json;charset=UTF-8" |
Request Body Parameters
Name | Type | Mandatory | Description |
|---|---|---|---|
clientId | String | Y | Game app ID |
secretKey | String | Y | Secret key required to call Server-to-Server API |
serviceUserId | Long | Y | Service User ID |
kakaoRewardApiKey | String | Y | KakaoTalk Emoticon/Choco Reward Definition Key Can be issued after entering into an agreement with the Kakao Reward Biz Part. |
Response Status Code
Status Code | Status Code Description | Status Code Details |
|---|---|---|
200 | Normal Response | Normal |
400 | Bad Request | Request data that is not parsed. Required parameter missing or parameter type error |
401 | Unauthenticated | Authentication failed |
406 | Not Acceptable | Unable to process |
461 | Invalid Message Box | Message box with the requested messageBoxId does not exist. |
500 | Internal Server Error | Server system internal error |
503 | Service Unavailable | When service is not available (ex. timeout between internal servers) |
Response Content
Name | Type | Description |
|---|---|---|
detail_code | Integer | Response Code Used for reference when Http response code is not 200 (OK). |
msg | String | Response Message Used for reference when Http response code is not 200 (OK). |
detail_code / msg
Http response code | detail_code | msg | Description |
|---|---|---|---|
200 | 100 | success | Success |
201 | 110 | in_progress | At the same time, a duplicate request is received |
400 | 0 | fail | Fail |
400 | 999 | invalid_api_key | api key is incorrect. |
400 | 4001 | not_enough_budget | The budget is depleted. |
400 | 4003 | invalid_parameter | http request parameter is not correct. |
400 | 4004 | already_issue | The reward is already issued. |
400 | 4006 | not_join_account | There is no KakaoTalk account linked to the player. |
400 | 4009 | need_active | The review is not completed yet. |
400 | 4010 | ad_not_configured | The static file for displaying advertisements is not registered. |
400 | 4016 | retry_later | Please try again later. |
400 | 4017 | issue_long_time_ago | Emoticon has been issued in the past advertisement. |
400 | 4018 | invalid_country | Received a request to issue an emoticon for an overseas user.
|
406 | 4006 | invalid player | There is no KakaoTalk account linked to the player. |
406 | 5001 | player status is not normal | The account is suspended or pending withdrawal. |
500 | 0 | internal server error | Fail |
Example Request
POST /service/v3/talk/legacy/reward/send HTTP/1.1
Host: openapi-zinny3.game.kakao.com
Content-Type: application/json;charset=UTF-8
{
"clientId": "11111153620111111",
"secretKey": "1111113913b6e9f07826442ad69da70b1b388ece8b4c604289cee15ada111111",
"serviceUserId": 88253716024128660
"kakaoRewardApiKey": "87b46dfdc3158c2f31cbcfb31b26ac75"
} |
Example Response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"detail_code": 100,
"msg": "success"
} |