Channel

Kakao. Namespace

Channel

Description:

  • 카카오톡 채널 API 모듈
    Module for Kakao Talk Channel APIs

Methods

(static) addChannel(settings)

Description:

  • 카카오톡 채널 친구 추가하기
    Add Kakao Talk Channel

See:
Parameters:
Name Type Description
settings Object
Properties
Name Type Description
channelPublicId String

카카오톡 채널 프로필 ID
Kakao Talk Channel profile ID

(static) chat(settings)

Description:

  • 카카오톡 채널 채팅하기
    Start Kakao Talk Channel chat

See:
Parameters:
Name Type Description
settings Object
Properties
Name Type Description
channelPublicId String

카카오톡 채널 프로필 ID
Kakao Talk Channel profile ID

(static) cleanup()

Description:

  • 사용한 카카오톡 채널 모듈 리소스 해제
    Cleans up used Kakao Talk Channel module resources

(static) createAddChannelButton(settings)

Description:

  • 카카오톡 채널 친구 추가하기 버튼 생성
    Creates a button to add Kakao Talk Channel

See:
Parameters:
Name Type Description
settings Object
Properties
Name Type Attributes Default Description
container String | HTMLElement

DOM Element 또는 Element의 ID Selector
ID Selector for DOM Element or Element
channelPublicId String

카카오톡 채널 프로필 ID
Kakao Talk Channel profile ID
size String <optional>
 "small"

버튼 크기 (small | large)
Button size (small | large)
supportMultipleDensities Boolean <optional>
 false

화면 배율에 맞는 크기의 이미지 사용 여부, IE 미지원
Whether to support multiple densities, except for IE

(static) createChatButton(settings)

Description:

  • 카카오톡 채널 채팅하기 버튼 생성
    Creates a button to start Kakao Talk Channel chat

See:
Parameters:
Name Type Description
settings Object
Properties
Name Type Attributes Default Description
container String | HTMLElement

DOM Element 또는 Element의 ID Selector
ID Selector for DOM Element or Element
channelPublicId String

카카오톡 채널 프로필 ID
Kakao Talk Channel profile ID
title String <optional>
 "consult"

버튼 문구 설정 (consult | question)
Button label (consult | question)
size String <optional>
 "small"

버튼 크기 (small | large)
Button size (small | large)
color String <optional>
 "yellow"

버튼 배경색 (yellow | black)
Button background color (yellow | black)
shape String <optional>
 "pc"

버튼 모양 (pc | mobile)
Button shape (pc | mobile)
supportMultipleDensities Boolean <optional>
 false

화면 배율에 맞는 크기의 이미지 사용 여부, IE 미지원
Whether to support multiple densities, except for IE

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

Description:

  • 카카오톡 채널 간편 추가하기
    Follow Kakao Talk Channel

Parameters:
Name Type Description
settings Object
Properties
Name Type Description
channelPublicId String

카카오톡 채널 프로필 ID
Kakao Talk Channel profile ID
Returns:
Type
Promise.<(FollowChannelResponse|FollowChannelError)>

Type Definitions

FollowChannelError

Description:

  • 카카오톡 채널 간편 추가하기 에러
    Errors for Follow Kakao Talk Channel

Properties:
Name Type Description
error Object
Properties
Name Type Description
error_code String

에러 코드
Error code
error_msg String

에러 메시지
Error message
status String

요청 결과, error로 고정
Request result, fixed as error

카카오톡 채널 간편 추가하기 에러
Errors for Follow Kakao Talk Channel

Type:
  • Object

FollowChannelResponse

Description:

  • 카카오톡 채널 간편 추가하기 응답
    Response for Follow Kakao Talk Channel

Properties:
Name Type Description
response Object
Properties
Name Type Description
status String

요청 결과 (success: 성공 | fail: 실패)
Request result (success: Success | fail: Fail)
channel_public_id String

카카오톡 채널 프로필 ID
Kakao Talk Channel ID

카카오톡 채널 간편 추가하기 응답
Response for Follow Kakao Talk Channel

Type:
  • Object