Package io.sendon.kakao

Class SendonKakao

java.lang.Object

io.sendon.base.SendonClient

io.sendon.kakao.SendonKakao

public class SendonKakao
extends SendonClient

The SendonKakao class provides methods to interact with the Kakao messaging API. It supports operations such as sending messages, managing templates, and handling profiles.

Field Summary

Fields inherited from class io.sendon.base.SendonClient

gson, httpClient

Constructor Summary

Constructors

Constructor	Description
SendonKakao(String userId, String apiKey)	Constructs a new SendonKakao instance with the specified user ID and API key.
SendonKakao(String userId, String apiKey, boolean useOkHttp)	Constructs a new SendonKakao instance with the specified user ID, API key, and HTTP client option.

Method Summary

Modifier and Type	Method	Description
CancelGroup	cancelGroup(String groupId)
CancelReviewTemplate	cancelReviewTemplate(String profileId, String templateId)
BrandMessageTemplateIdResponse	createBrandMessageCarouselFeedTemplate(String sendProfileId, BrandMessageCarouselFeedTemplateRequest request)
BrandMessageTemplateIdResponse	createBrandMessageImageTemplate(String sendProfileId, BrandMessageImageTemplateRequest request)
BrandMessageTemplateIdResponse	createBrandMessageTextTemplate(String sendProfileId, BrandMessageTextTemplateRequest request)
BrandMessageTemplateIdResponse	createBrandMessageWideItemListTemplate(String sendProfileId, BrandMessageWideItemListTemplateRequest request)
BrandMessageTemplateIdResponse	createBrandMessageWideTemplate(String sendProfileId, BrandMessageWideTemplateRequest request)
CreateTemplate	createTemplate(String profileId, Template template)	Creates a new template for a specific profile.
BrandMessageDeleteResponse	deleteBrandMessageTemplate(String sendProfileId, String templateCode)
DeleteTemplate	deleteTemplate(String profileId, String templateId)	Deletes a specific template for a profile.
BrandMessageTemplateDetailResponse	getBrandMessageTemplate(String sendProfileId, String templateCode)
BrandMessageTemplateListResponse	getBrandMessageTemplates(String sendProfileId, BrandMessageTemplateQuery query)
GetGroup	getGroup(String groupId)
GetProfileDetail	getProfileDetail(String profileId)	Retrieves the details of a specific profile.
GetProfiles	getProfiles(int limit, String cursor)	Retrieves a list of profiles with pagination support.
GetTemplateDetail	getTemplateDetail(String profileId, String templateId)
GetTemplates	getTemplates(String profileId, String keyword, int limit, String cursor, TemplateStatus status, TemplateQuerySort sort)	Retrieves a list of templates for a specific profile with filtering and sorting options.
RegisterProfile	registerProfile(Profile profile)	Registers a new profile with the given details.
RequestAuthToken	requestAuthToken(String channelId, String phoneNumber)	Requests an authentication token for a specific channel and phone number.
RequestReviewTemplate	requestReviewTemplate(String profileId, String templateId)	Requests a review for a specific template.
SendAlimtalk	sendAlimtalk(AlimtalkBuilder builder)	Sends an Alimtalk message using a builder.
SendAlimtalk	sendAlimtalk(String profileId, String templateId, List<?> to, Reservation reservation, Fallback fallback)	Sends an Alimtalk message with reservation and fallback options.
BrandMessageSendResponse	sendBrandMessage(BrandMessageSendBuilder builder)
SendFriendtalk	sendFriendtalk(FriendtalkBuilder builder)	Sends a Friendtalk message using a builder.
SendFriendtalk	sendFriendtalk(String profileId, String templateId, List<?> to, FriendtalkMessageType messageType, String message, List<Button> buttons, boolean isAd, Reservation reservation, Fallback fallback, Image image)	Sends a Friendtalk message.
SendGroup	sendGroup(String groupId)
BrandMessageTemplateIdResponse	updateBrandMessageCarouselFeedTemplate(String sendProfileId, String templateCode, BrandMessageCarouselFeedTemplateRequest request)
BrandMessageTemplateIdResponse	updateBrandMessageImageTemplate(String sendProfileId, String templateCode, BrandMessageImageTemplateRequest request)
BrandMessageTemplateIdResponse	updateBrandMessageTextTemplate(String sendProfileId, String templateCode, BrandMessageTextTemplateRequest request)
BrandMessageTemplateIdResponse	updateBrandMessageWideItemListTemplate(String sendProfileId, String templateCode, BrandMessageWideItemListTemplateRequest request)
BrandMessageTemplateIdResponse	updateBrandMessageWideTemplate(String sendProfileId, String templateCode, BrandMessageWideTemplateRequest request)
UpdateTemplate	updateTemplate(String profileId, String templateId, Template template)	Updates an existing template for a specific profile.
UploadAlimtalkImage	uploadAlimtalkImage(File image)
BrandMessageImageUploadResponse	uploadBrandMessageImage(File file)
BrandMessageImageUploadResponse	uploadBrandMessageWideImage(File file)
UploadFallbackImage	uploadFallbackImage(List<File> images)

Methods inherited from class io.sendon.base.SendonClient

delete, get, parseJsonResponse, post, postImagesWithMultipartFormData, postImageWithMultipartFormData, postImageWithMultipartFormData, put

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SendonKakao

public SendonKakao(String userId,
 String apiKey)

Constructs a new SendonKakao instance with the specified user ID and API key.

Parameters:

userId - The user ID for authentication.

apiKey - The API key for authentication.

SendonKakao

public SendonKakao(String userId,
 String apiKey,
 boolean useOkHttp)

Constructs a new SendonKakao instance with the specified user ID, API key, and HTTP client option.

Parameters:

userId - The user ID for authentication.

apiKey - The API key for authentication.

useOkHttp - Whether to use OkHttp as the HTTP client.

Method Details

requestAuthToken

public RequestAuthToken requestAuthToken(String channelId,
 String phoneNumber)

Requests an authentication token for a specific channel and phone number.

Parameters:

channelId - The ID of the channel.

phoneNumber - The phone number to authenticate.

Returns:

The response containing the authentication token. See RequestAuthToken.

registerProfile

public RegisterProfile registerProfile(Profile profile)

Registers a new profile with the given details.

Parameters:

profile - The profile details to register. See Profile.

Returns:

The response of the profile registration. See RegisterProfile.

getProfiles

public GetProfiles getProfiles(int limit,
 String cursor)

Retrieves a list of profiles with pagination support.

Parameters:

limit - The maximum number of profiles to retrieve.

cursor - The cursor for pagination.

Returns:

The response containing the list of profiles. See GetProfiles.

getProfileDetail

public GetProfileDetail getProfileDetail(String profileId)

Retrieves the details of a specific profile.

Parameters:

profileId - The ID of the profile to retrieve.

Returns:

The response containing the profile details. See GetProfileDetail.

createTemplate

public CreateTemplate createTemplate(String profileId,
 Template template)

Creates a new template for a specific profile.

Parameters:

profileId - The ID of the profile.

template - The template details to create. See Template.

Returns:

The response of the template creation. See CreateTemplate.

getTemplates

public GetTemplates getTemplates(String profileId,
 String keyword,
 int limit,
 String cursor,
 TemplateStatus status,
 TemplateQuerySort sort)

Retrieves a list of templates for a specific profile with filtering and sorting options.

Parameters:

profileId - The ID of the profile.

keyword - The keyword to filter templates.

limit - The maximum number of templates to retrieve.

cursor - The cursor for pagination.

status - The status to filter templates. See TemplateStatus.

sort - The sorting option for templates. See TemplateQuerySort.

Returns:

The response containing the list of templates. See GetTemplates.

deleteTemplate

public DeleteTemplate deleteTemplate(String profileId,
 String templateId)

Deletes a specific template for a profile.

Parameters:

profileId - The ID of the profile.

templateId - The ID of the template to delete.

Returns:

The response of the template deletion. See DeleteTemplate.

updateTemplate

public UpdateTemplate updateTemplate(String profileId,
 String templateId,
 Template template)

Updates an existing template for a specific profile.

Parameters:

profileId - The ID of the profile.

templateId - The ID of the template to update.

template - The updated template details. See Template.

Returns:

The response of the template update. See UpdateTemplate.

requestReviewTemplate

public RequestReviewTemplate requestReviewTemplate(String profileId,
 String templateId)

Requests a review for a specific template.

Parameters:

profileId - The ID of the profile.

templateId - The ID of the template to review.

Returns:

The response of the review request. See RequestReviewTemplate.

cancelReviewTemplate

public CancelReviewTemplate cancelReviewTemplate(String profileId,
 String templateId)

getTemplateDetail

public GetTemplateDetail getTemplateDetail(String profileId,
 String templateId)

createBrandMessageTextTemplate

public BrandMessageTemplateIdResponse createBrandMessageTextTemplate(String sendProfileId,
 BrandMessageTextTemplateRequest request)

createBrandMessageImageTemplate

public BrandMessageTemplateIdResponse createBrandMessageImageTemplate(String sendProfileId,
 BrandMessageImageTemplateRequest request)

createBrandMessageWideTemplate

public BrandMessageTemplateIdResponse createBrandMessageWideTemplate(String sendProfileId,
 BrandMessageWideTemplateRequest request)

createBrandMessageWideItemListTemplate

public BrandMessageTemplateIdResponse createBrandMessageWideItemListTemplate(String sendProfileId,
 BrandMessageWideItemListTemplateRequest request)

createBrandMessageCarouselFeedTemplate

public BrandMessageTemplateIdResponse createBrandMessageCarouselFeedTemplate(String sendProfileId,
 BrandMessageCarouselFeedTemplateRequest request)

updateBrandMessageTextTemplate

public BrandMessageTemplateIdResponse updateBrandMessageTextTemplate(String sendProfileId,
 String templateCode,
 BrandMessageTextTemplateRequest request)

updateBrandMessageImageTemplate

public BrandMessageTemplateIdResponse updateBrandMessageImageTemplate(String sendProfileId,
 String templateCode,
 BrandMessageImageTemplateRequest request)

updateBrandMessageWideTemplate

public BrandMessageTemplateIdResponse updateBrandMessageWideTemplate(String sendProfileId,
 String templateCode,
 BrandMessageWideTemplateRequest request)

updateBrandMessageWideItemListTemplate

public BrandMessageTemplateIdResponse updateBrandMessageWideItemListTemplate(String sendProfileId,
 String templateCode,
 BrandMessageWideItemListTemplateRequest request)

updateBrandMessageCarouselFeedTemplate

public BrandMessageTemplateIdResponse updateBrandMessageCarouselFeedTemplate(String sendProfileId,
 String templateCode,
 BrandMessageCarouselFeedTemplateRequest request)

getBrandMessageTemplate

public BrandMessageTemplateDetailResponse getBrandMessageTemplate(String sendProfileId,
 String templateCode)

getBrandMessageTemplates

public BrandMessageTemplateListResponse getBrandMessageTemplates(String sendProfileId,
 BrandMessageTemplateQuery query)

deleteBrandMessageTemplate

public BrandMessageDeleteResponse deleteBrandMessageTemplate(String sendProfileId,
 String templateCode)

sendBrandMessage

public BrandMessageSendResponse sendBrandMessage(BrandMessageSendBuilder builder)

uploadBrandMessageImage

public BrandMessageImageUploadResponse uploadBrandMessageImage(File file)

uploadBrandMessageWideImage

public BrandMessageImageUploadResponse uploadBrandMessageWideImage(File file)

uploadAlimtalkImage

public UploadAlimtalkImage uploadAlimtalkImage(File image)

uploadFallbackImage

public UploadFallbackImage uploadFallbackImage(List<File> images)

getGroup

public GetGroup getGroup(String groupId)

cancelGroup

public CancelGroup cancelGroup(String groupId)

sendGroup

public SendGroup sendGroup(String groupId)

sendAlimtalk

public SendAlimtalk sendAlimtalk(String profileId,
 String templateId,
 List<?> to,
 Reservation reservation,
 Fallback fallback)

Sends an Alimtalk message with reservation and fallback options.

Parameters:

profileId - The profile ID.

templateId - The template ID.

to - The list of recipients. Can be List<String> or List<ToWithVariable>.

reservation - The reservation details for scheduling. See Reservation.

fallback - The fallback options. See Fallback.

Returns:

The response of the Alimtalk send operation. See SendAlimtalk.

sendAlimtalk

public SendAlimtalk sendAlimtalk(AlimtalkBuilder builder)

Sends an Alimtalk message using a builder.

Parameters:

builder - The AlimtalkBuilder containing the Alimtalk message details.

Returns:

The response of the Alimtalk send operation. See SendAlimtalk.

sendFriendtalk

public SendFriendtalk sendFriendtalk(FriendtalkBuilder builder)

Sends a Friendtalk message using a builder.

Parameters:

builder - The FriendtalkBuilder containing the Friendtalk message details.

Returns:

The response of the Friendtalk send operation. See SendFriendtalk.

sendFriendtalk

public SendFriendtalk sendFriendtalk(String profileId,
 String templateId,
 List<?> to,
 FriendtalkMessageType messageType,
 String message,
 List<Button> buttons,
 boolean isAd,
 Reservation reservation,
 Fallback fallback,
 Image image)

Sends a Friendtalk message.

Parameters:

profileId - The profile ID.

templateId - The template ID.

to - The list of recipients. Can be List<String> (phone numbers) or List<ToWithVariable> (recipients with variables).

message - The message content.

buttons - The list of buttons. See Button.

isAd - Whether the message is an advertisement.

reservation - The reservation details for scheduling. See Reservation.

fallback - The fallback options. See Fallback.

image - The image details. See Image.

Returns:

The response of the Friendtalk send operation. See SendFriendtalk.