Skip to content
Provisioning API/
/KakaoTalk Categories

Provisioning API (1.2.7)

Download OpenAPI description
provisioning-api.json
provisioning-api.yaml
Languages
Servers
Production server

https://provisioning.api.sinch.com/

Webhooks

Webhooks allow the Sinch servers to communicate with your server backend. The webhooks endpoint lets you create, update, and delete webhooks programmatically.

Operations

Bundles

The bundles endpoint allows you to create and manage bundles of account resources.

Operations

Conversation

The Conversation endpoints allows you to retrieve about channels used with Conversation API.

Operations

WhatsApp

The WhatsApp endpoint allows you to programmatically log in to and get details of your WhatsApp account.

Operations

WhatsApp Templates

The WhatsApp template endpoint offers a way for you to manage your WhatsApp templates that can be used with the Conversation API. The WhatsApp templates are a requirement to send the initial outbound messages in the WhatsApp API.

Operations

WhatsApp Senders

A WhatsApp Sender is also referred to as a 'Business Profile' or a WhatsApp channel. The WhatsApp Sender endpoint allows you to create a Sender through Meta's Embedded sign up. A Sender must be provisioned for you as a consumer of the WhatsApp API to send messages to your end users.

Operations

WhatsApp Accounts

The WhatsApp accounts endpoint lets you create and update WhatsApp accounts as well as get account activity and leave comments.

Operations

WhatsApp Flows

The WhatsApp flows endpoint lets you retrieve and manage WhatsApp Flows associated with the project.

Operations

WhatsApp Solutions

The WhatsApp solutions endpoint offers a way for you to manage your WhatsApp solutions.

Operations

KakaoTalk Templates

The KakaoTalk template endpoint offers a way for you to manage your KakaoTalk templates that can be used with the Conversation API.

Operations

KakaoTalk Categories

The KakoaTalk categories endpoint offers a way for you to manage all of the KakaoTalk template categories that you can use with the Conversation API.

Operations

List all sender categories.GA

Request

Returns a list of sender categories.

Security
BasicAuth and BearerAuth
Path
projectIdstringrequired

The unique ID of the project. You can find this on the Sinch Dashboard.

curl -i -X GET \
  -u <username>:<password> \
  'https://provisioning.api.sinch.com/v1/projects/{projectId}/kakaotalk/categories/senders' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of sender categories.

Bodyapplication/json
categoriesArray of objects(KakaotalkSenderCategoryDto)required

List of sender categories.

categories[].​parentCodestring[ 0 .. 4 ] charactersrequired

The code of the parent category.

categories[].​depthnumber[ 1 .. 3 ]required

The depth in category tree.

categories[].​codestring[ 3 .. 4 ] charactersrequired

The code of the category.

categories[].​namestringrequired

The name of the category.

categories[].​subcategoriesArray of objects(KakaotalkSenderCategoryDto)required

List of subcategories.

Response
application/json

Response with sender categories.

{
  "categories": [
    { … },
    { … }
  ]
}

List all template categories in projectGA

Request

Returns a list of template categories for the specified project.

Security
BasicAuth and BearerAuth
Path
projectIdstringrequired

The unique ID of the project. You can find this on the Sinch Dashboard.

plusFriendIdstringrequired

The unique ID of the sender.

Query
pageSizenumber[ 1 .. 100 ]

The page size requested.

pageTokenstring

The page token if retrieving the next page from a previous query.

curl -i -X GET \
  -u <username>:<password> \
  'https://provisioning.api.sinch.com/v1/projects/{projectId}/kakaotalk/categories/senders/{plusFriendId}/templates?pageSize=1&pageToken=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of template categories

Bodyapplication/json
totalSizenumberrequired

Total size of the entries matching the search query.

pageSizenumberrequired

Requested size of the page.

categoriesArray of objects(KakaotalkTemplateCategoryDto)required

List of template categories.

categories[].​namestringrequired

카테고리 이름.

Enum"구매""기타""리포팅""배송""법적고지""서비스이용""업무알림""예약""쿠폰/포인트""회원"
categories[].​nameEnglishstringrequired

English category name.

Enum"Business notification""Coupon/Points""Customer service""Legal notification""Membership""Others""Purchase""Reports""Reservation""Shipping"
categories[].​subcategoriesArray of objects(KakaotalkTemplateSubcategoryDto)required

List of subcategories.

categories[].​subcategories[].​codestringrequired

Subcategory code (Used when registering/modifying templates).

categories[].​subcategories[].​namestringrequired

하위 카테고리 이름.

Enum"인증/비밀번호/로그인""회원가입""회원정보/회원혜택""구매예약/입고알림""구매완료""구매취소""상품가입""진행상태""예약상태""예약알림/리마인드"
categories[].​subcategories[].​nameEnglishstringrequired

English subcategory name.

Enum"Authentication/Password/Login""Join membership""Membership information/Member ship benefits""Pre-order/Stock alerts""Product subscription""Purchase cancellation""Purchase completed""Purchase status""Completed reservations/Reservation history""Notification/Reminder"
categories[].​subcategories[].​groupNamestringrequired

Subcategory group name.

categories[].​subcategories[].​inclusionstringrequired

Description of templates to which the subcategory applies.

categories[].​subcategories[].​exclusionstringrequired

Description of templates to which the subcategory does not apply.

previousPageTokenstring

Encoded token to use in list request to fetch previous batch of entries.

nextPageTokenstring

Encoded token to use in list request to fetch next batch of entries.

Response
application/json

Response with categories.

{
  "totalSize": 2,
  "pageSize": 50,
  "categories": [
    { … }
  ]
}

KakaoTalk Senders

The KakaoTalk sender endpoint offers a way for you to manage your KakaoTalk senders that can be used with the Conversation API.

Operations

RCS Accounts

The RCS endpoint offers you a way to manage your RCS accounts.

Operations

RCS Questionnaire

Manage your RCS questionnaires.

Operations

RCS Senders

The RCS sender endpoint offers a way for you to manage your RCS senders that can be used with the Conversation API.

Operations

RCS Upscales

The RCS upscales endpoint offers a way for you to manage your RCS upscales.

Operations