Usage GuideScope of support
This document guides the scope of support for each Kakao API.
This document uses the notation below.
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 access token information | ✔ | ✔ | ✔ | ✔ | ✔ |
| Refresh token | ✔ | - | ✔ | ✔ | ✔ |
| Retrieve user information | ✔ | ✔ | ✔ | ✔ | ✔ |
| Retrieve user list | ✔ | - | - | - | - |
| Store user property | ✔ | ✔ | ✔ | ✔ | ✔ |
| 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: Get Discovery document | ✔ | - | - | - | - |
| OIDC: Get public key | ✔ | - | - | - | - |
| OIDC: Get ID token information | ✔ | - | - | - | - |
| OIDC: Get user information | ✔ | - | - | - | - |
| Set consent to service terms Permission | ✔ | - | - | - | - |
| Manual signup Permission | ✔ | ✔ | ✔ | ✔ | ✔ |
| 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 | - | ✔ | - | - | - |
REST API not supported: Kakao Talk ShareKakao Talk Share works through the Kakao Talk app or a web page. Thus, Kakao Talk Share does not support REST API.
| 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 | ✔ | - | - | - | - |
Kakao Talk Channel customer management is not supported by Kakao SDK.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 | - | ✔ | ✔ | ✔ | ✔ |