KakaoTalk Senders

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

List all senders in project GA

Returns a paginated list of senders for the specified project. If no page token is supplied then the first 50 will be returned.

SecurityBasic or OAuth2.0
Request
path Parameters
projectId
required
string

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

query Parameters
pageToken
string

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

pageSize
number [ 1 .. 100 ]

The page size requested.

filterStates
Array of strings (SenderStatesEnum1)

Optionally query for sender by states.

Items Enum: "INACTIVE" "VERIFYING" "ACTIVE" "BLOCKED" "SUSPENDED"
filterStatuses
Array of strings (SenderStatusesEnum1)

Optionally query for sender by statuses.

Items Enum: "DRAFT" "IN_PROGRESS" "REJECTED"
Responses
200

List of senders

Response Schema: application/json
totalSize
required
number

Total size of the entries matching the search query.

pageSize
required
number

Requested size of the page.

required
Array of objects (SenderDto1)

List of senders.

previousPageToken
string

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

nextPageToken
string

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

400

BadRequest

401

Unauthorized

404

NotFound

500

InternalServerError

get/v1/projects/{projectId}/kakaotalk/senders
Request samples 
Response samples 
application/json
Response with senders.


{
  • "totalSize": 2,
  • "pageSize": 50,
  • "senders": [
    • {
      },
    • {
      }
    ]
}
Create sender for project GA 
Creates a sender for a project.


SecurityBasic or OAuth2.0 
Request 
path Parameters
projectId
required
string
The unique ID of the project. You can find this on the Sinch Dashboard.


 
Request Body schema: application/json
required
Sender data


plusFriendId
required
string  [ 1 .. 30 ] characters 
PlusFriend ID


 
required
object
Sender details and information.


 
status
string (ActionsEnum) 
 Default:  "DRAFT"
Create as draft or submit. Defaults to draft.


 Enum: "DRAFT" "SUBMIT"  
saveDraftOnFailure
boolean
 Default:  false
Flag to save template as draft if submission fails. Defaults to false.


 
Responses 
201
Sender


Response Schema: application/json
plusFriendId
required
string
PlusFriend ID


 
id
string
The unique ID of the sender.


 
state
string (SenderStatesEnum1) 
The current state of the sender.


 Enum: "INACTIVE" "VERIFYING" "ACTIVE" "BLOCKED" "SUSPENDED"  
object
Any pending changes to the sender.


 
object
Sender details and information.


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


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


 
400
BadRequest


401
Unauthorized


404
NotFound


409
Conflict


412
PreconditionFailed


500
InternalServerError


Callbacks 
postSender state active
postSender inactive
postSender rejected
postComment on sender
post/v1/projects/{projectId}/kakaotalk/senders
Request samples 
application/json
Example of full body to create a sender.


{
  • "plusFriendId": "plusFriendId",
  • "status": "SUBMIT",
  • "saveDraftOnFailure": true,
  • "details": {
    • "adminPhoneNo": "+48777777777",
    • "name": "Test Name",
    • "logoImage": "https://example-logo-image.com",
    • "topLevelCategoryCode": "019",
    • "midLevelCategoryCode": "0006",
    • "subLevelCategoryCode": "0001"
    }
}
Response samples 
application/json
Response when successfully creating a sender.


{
  • "id": "cf11794a-6a5e-4a12-b103-da79bd378bf1",
  • "plusFriendId": "5WY5zKfY3pB56EmDVUPQ",
  • "changes": {
    • "status": "REJECTED",
    • "details": {
      }
    },
  • "created": "2023-02-23T11:28:51.194Z",
  • "modified": "2023-02-23T11:28:51.194Z"
}
Callback payload samples 
application/json
{
  • "type": "KAKAOTALK_SENDER_ACTIVE",
  • "payload": {
    • "id": "cf11794a-6a5e-4a12-b103-da79bd378bf1",
    • "plusFriendId": "5WY5zKfY3pB56EmDVUPQ",
    • "state": "ACTIVE",
    • "details": {
      },
    • "created": "2023-02-23T11:28:51.194Z",
    • "modified": "2023-02-23T11:28:51.194Z"
    }
}
Get sender for project GA 
Returns a sender for a project.


SecurityBasic or OAuth2.0 
Request 
path Parameters
projectId
required
string
The unique ID of the project. You can find this on the Sinch Dashboard.


 
plusFriendId
required
string
The unique ID of the sender.


 
Responses 
200
sender


Response Schema: application/json
plusFriendId
required
string
PlusFriend ID


 
id
string
The unique ID of the sender.


 
state
string (SenderStatesEnum1) 
The current state of the sender.


 Enum: "INACTIVE" "VERIFYING" "ACTIVE" "BLOCKED" "SUSPENDED"  
object
Any pending changes to the sender.


 
object
Sender details and information.


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


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


 
400
BadRequest


401
Unauthorized


404
NotFound


500
InternalServerError


get/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}
Request samples 
Response samples 
application/json
Response with a sender.


{
  • "id": "cf11794a-6a5e-4a12-b103-da79bd378bf1",
  • "plusFriendId": "5WY5zKfY3pB56EmDVUPQ",
  • "state": "ACTIVE",
  • "details": {
    • "adminPhoneNo": "+48777777777",
    • "name": "Test Name",
    • "logoImage": "https://example-logo-image.com",
    • "topLevelCategoryCode": "019",
    • "midLevelCategoryCode": "0006",
    • "subLevelCategoryCode": "0001"
    },
  • "created": "2023-02-23T11:28:51.194Z",
  • "modified": "2023-02-23T11:28:51.194Z"
}
Lists activities on sender GA 
Paginated list of activities for sender. Ordered from the most recent one to the oldest one.


SecurityBasic or OAuth2.0 
Request 
path Parameters
projectId
required
string
The unique ID of the project. You can find this on the Sinch Dashboard.


 
plusFriendId
required
string
The unique ID of the sender.


 
query Parameters
pageSize
number  [ 1 .. 100 ] 
The page size requested.


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


 
Responses 
200
Recent activities on sender


Response Schema: application/json
totalSize
required
number
Total size of the entries matching the search query.


 
pageSize
required
number
Requested size of the page.


 
required
Array of objects (SenderNotificationDto1) 
 
previousPageToken
string
Encoded token to use in list request to fetch previous batch of entries.


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


 
400
BadRequest


401
Unauthorized


404
NotFound


500
InternalServerError


get/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/activities
Request samples 
Response samples 
application/json
Response for all sender activities.


{
  • "totalSize": 2,
  • "pageSize": 50,
  • "notifications": [
    • {
      },
    • {
      }
    ]
}
Delete pending or rejected changes to a sender GA 
Delete pending or rejected changes to a sender.


SecurityBasic or OAuth2.0 
Request 
path Parameters
projectId
required
string
The unique ID of the project. You can find this on the Sinch Dashboard.


 
plusFriendId
required
string
The unique ID of the sender.


 
Responses 
204
Sender changes deleted


400
BadRequest


401
Unauthorized


404
NotFound


409
Conflict


500
InternalServerError


delete/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/changes
Request samples 
Response samples 
application/json
{
  • "errorCode": "project_not_initialized",
  • "message": "Project not initialized for KakaoTalk.",
  • "resolution": "Verify that the project ID is correct and that it has been onboarded for KakaoTalk."
}
Creates a comment for a sender in project GA 
Creates a comment for a sender.


SecurityBasic or OAuth2.0 
Request 
path Parameters
projectId
required
string
The unique ID of the project. You can find this on the Sinch Dashboard.


 
plusFriendId
required
string
The unique ID of the sender.


 
Request Body schema: application/json
required
Comment data


comment
required
string  [ 1 .. 65535 ] characters 
 
Responses 
201
Created comment for a sender


Response Schema: application/json
type
required
string (CommentTypeEnum) 
 Value: "CREATED"  
comment
required
string
 
created
string
 
400
BadRequest


401
Unauthorized


404
NotFound


500
InternalServerError


post/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/comments
Request samples 
application/json
Example body request to create a comment.


{
  • "comment": "Example comment."
}
Response samples 
application/json
Response when successfully creating a comment.


{
  • "type": "CREATED",
  • "comment": "Example comment",
  • "created": "2023-01-19T13:11:08.204Z"
}
Register sender for project GA 
Requests sender registration for a project.


SecurityBasic or OAuth2.0 
Request 
path Parameters
projectId
required
string
The unique ID of the project. You can find this on the Sinch Dashboard.


 
plusFriendId
required
string
The unique ID of the sender.


 
Responses 
200
Sender


Response Schema: application/json
plusFriendId
required
string
PlusFriend ID


 
id
string
The unique ID of the sender.


 
state
string (SenderStatesEnum1) 
The current state of the sender.


 Enum: "INACTIVE" "VERIFYING" "ACTIVE" "BLOCKED" "SUSPENDED"  
object
Any pending changes to the sender.


 
object
Sender details and information.


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


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


 
400
BadRequest


401
Unauthorized


404
NotFound


409
Conflict


500
InternalServerError


post/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/register
Request samples 
Response samples 
application/json
Response when successfully registering a sender.


{
  • "id": "cf11794a-6a5e-4a12-b103-da79bd378bf1",
  • "plusFriendId": "5WY5zKfY3pB56EmDVUPQ",
  • "state": "VERIFYING",
  • "details": {
    • "adminPhoneNo": "+48777777777",
    • "name": "Test Name",
    • "logoImage": "https://example-logo-image.com",
    • "topLevelCategoryCode": "019",
    • "midLevelCategoryCode": "0006",
    • "subLevelCategoryCode": "0001"
    },
  • "created": "2023-02-23T11:28:51.194Z",
  • "modified": "2023-02-23T11:28:51.194Z"
}
Verify sender for project GA 
Verifies sender with the OTP code received after triggering registration.


SecurityBasic or OAuth2.0 
Request 
path Parameters
projectId
required
string
The unique ID of the project. You can find this on the Sinch Dashboard.


 
plusFriendId
required
string
The unique ID of the sender.


 
Request Body schema: application/json
required
Verify sender data


code
required
number
Numeric code to verify the sender.


 
Responses 
200
Sender


Response Schema: application/json
plusFriendId
required
string
PlusFriend ID


 
id
string
The unique ID of the sender.


 
state
string (SenderStatesEnum1) 
The current state of the sender.


 Enum: "INACTIVE" "VERIFYING" "ACTIVE" "BLOCKED" "SUSPENDED"  
object
Any pending changes to the sender.


 
object
Sender details and information.


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


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


 
400
BadRequest


401
Unauthorized


404
NotFound


409
Conflict


500
InternalServerError


post/v1/projects/{projectId}/kakaotalk/senders/{plusFriendId}/verify
Request samples 
application/json
Example body request to verify.


{
  • "code": 123456
}
Response samples 
application/json
Response when successfully verified a sender.


{
  • "id": "cf11794a-6a5e-4a12-b103-da79bd378bf1",
  • "plusFriendId": "5WY5zKfY3pB56EmDVUPQ",
  • "state": "ACTIVE",
  • "details": {
    • "adminPhoneNo": "+48777777777",
    • "name": "Test Name",
    • "logoImage": "https://example-logo-image.com",
    • "topLevelCategoryCode": "019",
    • "midLevelCategoryCode": "0006",
    • "subLevelCategoryCode": "0001"
    },
  • "created": "2023-02-23T11:28:51.194Z",
  • "modified": "2023-02-23T11:28:51.194Z"
}
SecurityPrivacyLegal & ComplianceCookie Statement
© 2024 Sinch. All rights reserved.