Kakao Developers

Channel

Description:

카카오톡 채널 플러그인과 관련된 함수들이 포함되어 있습니다.

Methods

(static) addChannel(settings)

Description:

카카오톡 채널 추가 팝업창을 띄웁니다. 사용자의 클릭 이벤트 이후에 호출되어야 브라우저에 의해 팝업이 차단되지 않습니다.

See:

Kakao.Channel.createAddChannelButton 직접 버튼을 제작하여 사용할 필요가 없는 경우 유용합니다.
데모 보러가기

Parameters:

Name Type Description

settings

Object

카카오톡 채널 추가와 관련된 설정을 key/value로 전달합니다.

Properties

Name	Type	Description
`channelPublicId`	String	대상 카카오톡 채널 홈 URL에 포함된 카카오톡 채널 공개 ID

(static) chat(settings)

Description:

카카오톡 채널 1:1 채팅을 시작합니다. 사용자의 클릭 이벤트 이후에 호출되어야 브라우저에 의해 팝업이 차단되지 않습니다.

See:

Kakao.Channel.createChatButton 직접 버튼을 제작하여 사용할 필요가 없는 경우 유용합니다.
데모 보러가기

Parameters:

Name Type Description

settings

Object

카카오톡 채널 추가와 관련된 설정을 key/value로 전달합니다.

Properties

Name	Type	Description
`channelPublicId`	String	대상 카카오톡 채널 홈 URL에 포함된 카카오톡 채널 공개 ID

(static) cleanup()

Description:

카카오톡 채널과 관련된 리소스를 해제합니다.

(static) createAddChannelButton(settings)

Description:

카카오톡 채널 추가 버튼을 생성합니다.

See:

Kakao.Channel.addChannel 직접 버튼을 제작하여 사용할 때 이용하세요.
데모 보러가기

Parameters:

Name Type Description

settings

Object

카카오톡 채널 추가 버튼 생성과 관련된 설정을 key/value로 전달합니다.

Properties

Name	Type	Attributes	Default	Description
`container`	String \| HTMLElement			DOM Element 또는 Element의 ID Selector
`channelPublicId`	String			대상 카카오톡 채널 홈 URL에 포함된 카카오톡 채널 ID
`size`	String	<optional>	`"small"`	채널추가 버튼의 사이즈, "small"\|"large"
`supportMultipleDensities`	Boolean	<optional>	`false`	화면 배율에 따라 2x 3x 이미지를 사용, IE 미지원

(static) createChatButton(settings)

Description:

카카오톡 채널 1:1 채팅 버튼을 생성합니다.

See:

Kakao.Channel.chat 직접 버튼을 제작하여 사용할 때 이용하세요.
데모 보러가기

Parameters:

Name Type Description

settings

Object

카카오톡 채널 1:1 채팅 버튼 생성과 관련된 설정을 key/value로 전달합니다.

Properties

Name	Type	Attributes	Default	Description
`container`	String \| HTMLElement			DOM Element 또는 Element의 ID Selector
`channelPublicId`	String			대상 카카오톡 채널 홈 URL에 포함된 카카오톡 채널 ID
`title`	String	<optional>	`"consult"`	1:1 채팅 버튼에 들어갈 제목, "consult"\|"question"
`size`	String	<optional>	`"small"`	1:1 채팅 버튼의 사이즈, "small"\|"large"
`color`	String	<optional>	`"yellow"`	1:1 채팅 버튼의 배경색, "yellow"\|"black"
`shape`	String	<optional>	`"pc"`	1:1 채팅 버튼의 모양, "pc"\|"mobile"
`supportMultipleDensities`	Boolean	<optional>	`false`	화면 배율에 따라 2x 3x 이미지를 사용, IE 미지원

(static) followChannel(settings) → {Promise.<(FollowChannelResponse|FollowChannelError)>}

Description:

사용자에게 지정된 카카오톡 채널의 친구 추가를 요청합니다.

Parameters:

Name Type Description

settings

Object

카카오톡 채널 간편 추가하기와 관련된 설정을 key/value로 전달합니다.

Properties

Name	Type	Description
`channelPublicId`	String	카카오톡 채널 프로필 ID

Returns:

Type: Promise.<(FollowChannelResponse|FollowChannelError)>

Type Definitions

FollowChannelError

Properties:

Name Type Description

error

Object

Properties

Name	Type	Description
`error_code`	String	에러 코드
`error_msg`	String	에러 메시지
`status`	String	채널 추가 요청 결과, `"error"`

FollowChannelResponse

Properties:

Name Type Description

response

Object

Properties

Name	Type	Description
`status`	String	채널 추가 요청 결과, `"success"\|"fail"`
`channel_public_id`	String	요청한 카카오톡 채널 프로필 ID