This document guides the scope of support for each Kakao API.
This document uses the notation below.
Type | Description |
---|---|
REST API | Indicates whether REST API is supported. |
JavaScript | Indicates whether Kakao SDK for JavaScript is supported. |
Android | Indicates whether Kakao SDK for Android is supported. |
iOS | Indicates whether Kakao SDK for iOS is supported. |
Flutter | Indicates whether Kakao SDK for Flutter is supported. |
Below is the meaning of the badges.
Badge | Description |
---|---|
Permission | This feature needs permission to use. |
Feature | REST API | JavaScript | Android | iOS | Flutter |
---|---|---|---|---|---|
Login* | ✔ | ✔ | ✔ | ✔ | ✔ |
Logout | ✔ | ✔ | ✔ | ✔ | ✔ |
Unlink | ✔ | ✔ | ✔ | ✔ | ✔ |
Retrieve token information | ✔ | ✔ | ✔ | ✔ | ✔ |
Refresh tokens | ✔ | ✔ | ✔ | ✔ | |
Retrieve user information | ✔ | ✔ | ✔ | ✔ | ✔ |
Retrieve user list | ✔ | ||||
Store user information | ✔ | ✔ | ✔ | ✔ | ✔ |
Retrieve shipping address | ✔ | ✔ | ✔ | ✔ | ✔ |
Retrieve multiple user information | ✔ | ||||
Retrieve consent details | ✔ | ✔ | ✔ | ✔ | ✔ |
Revoke consent | ✔ | ✔ | ✔ | ✔ | ✔ |
Request additional consent | ✔ | ✔ | ✔ | ✔ | ✔ |
Retrieve consent details for service terms | ✔ | ✔ | ✔ | ✔ | ✔ |
Revoke consent for service terms | ✔ | ✔ | ✔ | ✔ | ✔ |
OIDC: Retrieve Discovery document | ✔ | ||||
OIDC: Get public key | ✔ | ||||
OIDC: Get ID token information | ✔ | ||||
OIDC: Retrieve user information | ✔ | ||||
Set consent to service terms Permission |
✔ | ||||
Manual signup Permission |
✔ | ✔ | ✔ | ✔ | ✔ |
* Login consists of two steps, obtaining an authorization code and a token. Android, iOS, Flutter SDK provide a combined method.
Feature | REST API | JavaScript | Android | iOS | Flutter |
---|---|---|---|---|---|
Send message with default template | ✔ | ✔ | ✔ | ✔ | |
Send message with custom template | ✔ | ✔ | ✔ | ✔ | |
Send scrap message with default template | ✔ | ✔ | ✔ | ✔ | |
Send scrap message with custom template | ✔ | ✔ | ✔ | ✔ | |
Upload image | ✔ | ✔ | ✔ | ✔ | |
Scrap image | ✔ | ✔ | ✔ | ✔ | |
Delete image | ✔ |
Kakao Talk Sharing works through the Kakao Talk app or a web page. Thus, Kakao Talk Sharing does not support REST API. You can set parameters for the callback through Kakao SDKs. You should implement a feature that handles callbacks on your service server.
Feature | REST API | JavaScript | Android | iOS | Flutter |
---|---|---|---|---|---|
Send message with default template Permission |
✔ | ✔ | ✔ | ✔ | ✔ |
Send message with custom template Permission |
✔ | ✔ | ✔ | ✔ | ✔ |
Send scrap message with default template Permission |
✔ | ✔ | ✔ | ✔ | ✔ |
Send scrap message with custom template Permission |
✔ | ✔ | ✔ | ✔ | ✔ |
Feature | REST API | JavaScript | Android | iOS | Flutter |
---|---|---|---|---|---|
Retrieve Kakao Talk profile | ✔ | ✔ | ✔ | ✔ | ✔ |
Retrieve list of friends Permission |
✔ | ✔ | ✔ | ✔ | ✔ |
Feature | REST API | JavaScript | Android | iOS | Flutter |
---|---|---|---|---|---|
Add Kakao Talk Channel | ✔ | ✔ | ✔ | ✔ | |
Start Kakao Talk Channel chat | ✔ | ✔ | ✔ | ✔ | |
Check Kakao Talk Channel relationship | ✔ | ✔ | ✔ | ✔ | ✔ |
Check multiple users' Kakao Talk Channel relationship | ✔ | ||||
Customer management: Register customer file |
✔ | ||||
Customer management: View customer file |
✔ | ||||
Customer management: Add user |
✔ | ||||
Customer management: Delete user |
✔ |
You can only use the REST API method to leverage the Kakao Talk Channel customer management feature for Kakao Talk Channel administrator.
Feature | REST API | JavaScript | Android* | iOS* | Flutter |
---|---|---|---|---|---|
Register push token | ✔ | ||||
Retrieve push token | ✔ | ||||
Delete push token | ✔ | ||||
Send push notifications | ✔ |
Feature | REST API | JavaScript | Android | iOS | Flutter |
---|---|---|---|---|---|
Start navigation | ✔ | ✔ | ✔ | ✔ | |
Share location | ✔ | ✔ | ✔ | ✔ |
* Not including the scope of support of Kakao Navi API and SDK.