Skip to content
Provisioning API/
/KakaoTalk Templates

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

List all templates in projectGA

Request

Returns a paginated list of templates for the specified project. If no page token is supplied then the first 50 templates are returned in alphabetical order.

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
filterStatesArray of strings(KakaotalkTemplateStatesEnum)

Optionally query for template by states.

Items Enum"APPROVED""REJECTED"
filterStatusesArray of strings(KakaotalkTemplateStatusesEnum)

Optionally query for template by statuses.

Items Enum"DRAFT""IN_PROGRESS""REJECTED"
pageSizenumber[ 1 .. 1000 ]

The page size requested.

pageTokenstring

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

templateNamestring

Optionally query for template by name. Will return all templates with names that begin with the query string.

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

Responses

List of templates

Bodyapplication/json
totalSizenumberrequired

Total size of the entries matching the search query.

pageSizenumberrequired

Requested size of the page.

templatesArray of objects(KakaotalkTemplateDto)required

List of templates

templates[].​codestringrequired

Registered delivery template code

templates[].​idstring

The unique ID of the template.

templates[].​statestring

The current state of the template.

Enum"APPROVED""REJECTED"
templates[].​changesobject

Any pending changes to the template.

templates[].​detailsobject

Template details and information.

templates[].​createdstring

The UTC Date Time in ISO 8601 for when the template was created.

templates[].​modifiedstring

The UTC Date Time in ISO 8601 for when the template was last modified.

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 templates.

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

Create a template in projectGA

Request

Creates a new template with the request data.

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.

Bodyapplication/jsonrequired

Template data

detailsobjectrequired

Template details and information.

details.​namestring[ 1 .. 150 ] charactersrequired

Button name

details.​languagestringrequired

Template language

Enum"AF""AR""AZ""BG""BN""CA""CS""DA""DE""EL"
details.​contentstring[ 1 .. 1000 ] charactersrequired

Template body Not required for draft.

details.​messageTypestring

Types of template message

Default "BASIC"
Enum"AD_INCLUDED""BASIC""EXTRA_INFORMATION""MIXED"
details.​emphasizeTypestring

Types of emphasized template

Default "EMPHASIZE_TYPE_NONE"
Enum"EMPHASIZE_TYPE_IMAGE""EMPHASIZE_TYPE_NONE""EMPHASIZE_TYPE_TEXT"
details.​categoryCodestring[ 1 .. 6 ] characters

Template category code

Default "999999"
details.​securityFlagboolean

Security template Set for security messages such as OTP If set, message text is unexposed to all devices except for the main device at the time of sending

Default false
details.​extrastring[ 1 .. 500 ] characters

Additional template information

details.​titlestring[ 1 .. 50 ] characters

Template Title (No more than 50 characters, Android: To be abbreviated if it exceeds 2 lines with more than 23 characters, iOS: To be abbreviated if it exceeds 2 lines with more than 27 characters)

details.​subtitlestring[ 1 .. 50 ] characters

Auxiliary Template Phrase (No more than 50 characters, Android: To be abbreviated if it exceeds 18 characters, iOS: To be abbreviated if it exceeds 21 characters)

details.​imageNamestring[ 1 .. 250 ] characters

Image name (name of uploaded file)

details.​imageUrlstring(url)

Image URL

  • Supported mime types: image/jpeg or image/png.
  • Maximum file size: 500KB.
  • Minimum image dimensions: 500 x 250 px.
  • Aspect ratio: 2 x 1.
details.​buttonsArray of objects(KakaotalkInputButtonDto)[ 0 .. 5 ] itemsunique

List of buttons Field 'type' must have unique values across items.

statusstring

Create as draft or submit. Defaults to submit.

Default "SUBMIT"
Enum"DRAFT""SUBMIT"
saveDraftOnFailureboolean

Flag to save template as draft if submission fails. Defaults to false.

Default false
curl -i -X POST \
  -u <username>:<password> \
  'https://provisioning.api.sinch.com/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/templates' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "details": {
      "name": "Example name",
      "content": "Example content",
      "language": "EN"
    }
  }'

Responses

Created template

Bodyapplication/json
codestringrequired

Registered delivery template code

idstring

The unique ID of the template.

statestring

The current state of the template.

Enum"APPROVED""REJECTED"
changesobject

Any pending changes to the template.

detailsobject

Template details and information.

createdstring

The UTC Date Time in ISO 8601 for when the template was created.

modifiedstring

The UTC Date Time in ISO 8601 for when the template was last modified.

Response
application/json

Response when successfully creating a template.

{
  "id": "1a76b24e-bead-4c72-b468-6c3bdfff0ee6",
  "code": "S7yFqaKqJ8tsnBZH2CEd",
  "changes": {
    "status": "IN_PROGRESS",
    "details": { … }
  },
  "created": "2023-02-24T10:19:31.372Z",
  "modified": "2023-02-24T10:19:31.372Z"
}

Callbacks

KakaoTalk Template received a comment
post
KakaoTalk Template approved
post
KakaoTalk Template rejected
post

Get template in projectGA

Request

Returns a template for a project, with the specified name and language.

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.

templateCodestringrequired

The unique name of the template.

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

Responses

Template

Bodyapplication/json
codestringrequired

Registered delivery template code

idstring

The unique ID of the template.

statestring

The current state of the template.

Enum"APPROVED""REJECTED"
changesobject

Any pending changes to the template.

detailsobject

Template details and information.

createdstring

The UTC Date Time in ISO 8601 for when the template was created.

modifiedstring

The UTC Date Time in ISO 8601 for when the template was last modified.

Response
application/json

Response when successfully creating a template.

{
  "id": "1a76b24e-bead-4c72-b468-6c3bdfff0ee6",
  "code": "S7yFqaKqJ8tsnBZH2CEd",
  "state": "APPROVED",
  "details": {
    "language": "EN",
    "messageType": "BASIC",
    "emphasizeType": "EMPHASIZE_TYPE_NONE",
    "categoryCode": "001001",
    "securityFlag": false,
    "name": "Example name",
    "content": "Example content",
    "extra": "Example extra",
    "ad": "Example ad",
    "title": "Example title",
    "subtitle": "Example subtitle",
    "imageName": "Example image name",
    "imageUrl": "https://example-image-url.com",
    "buttons": [ … ]
  },
  "created": "2023-02-24T10:19:31.372Z",
  "modified": "2023-02-24T10:19:31.372Z"
}

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

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