Index


Kakao

Include functions in which it has been used commonly.

Kakao.init(appKey)

Initialize Kakao JavaScript SDK. Must be called before using SDK.

Parameters
  • appKey : String
    JavaScript Key of App that has been registered in developer site

  • Kakao.isInitialized()

    Return that Kakao JavaScript SDK is initialized.

    Kakao.cleanup()

    Deactivate resource that has been used previously in JavaScript SDK.

    Kakao.VERSION

    Return version of Kakao JavaScript SDK.


    Kakao.Auth

    Include functions related to user authentication.

    Kakao.Auth.createLoginButton(settings)

    Create Kakao login button. It is suggested to use Kakao.Auth.login when creating button manually.

    Parameters
  • settings : Object
    Attributes of login button are passed by 'key/value' format.

    • container : String | DOMElement (required)
      ID Selector or DOM Element of a container that will be displayed in login button

    • lang : String
      'kr', 'en' (default: 'kr')
      Language to be used in login button

    • size : String
      'small', 'medium', 'large' (default: 'medium')
      Size of login button

    • success : Function(authObj)
      authObj: { access_token:"...", refresh_token:"..." token_type:"bearer", expires_in:43199, scope:"Basic_Profile"}
      The callback function is called to get user token, when login succeed.

    • fail : Function(errorObj)
      errorObj: { error: "access_denied", error_description: "..."}
      The callback function is called to get errorMessage, when login failed.

    • always : Function(authObj | errorObj)
      The callback function is called, when login failed or succeed.

    • persistAccessToken : Boolean
      (default: true)
      Even if session expires, Access Token will be saved in local storage for later use. Save Access Token to local storage, in order to use Access Token after session expires.

    • persistRefreshToken : Boolean
      (default: false)
      Even if session expires, Refresh Token will be saved in local storage for later use. Save Refresh Token to local storage, in order to use Refresh Token after session expires.

    • throughTalk : Boolean
      (default: true)
      간편 로그인 사용 여부

  • Kakao.Auth.login(settings)

    This is a function for helping App login through login pop up window. this must be called after users click event in order to make sure that browser does not block window.if it is not necessary to make custom login button refer Kakao.Auth.createLoginButton.

    Parameters
  • settings : Object
    Attributes of login button are passed by 'key/value' format.

    • success : Function(authObj)
      authObj: { access_token:"...", refresh_token:"..." token_type:"bearer", expires_in:43199, scope:"Basic_Profile"}
      The callback function is called to get user token, when login succeed.

    • fail : Function(errorObj)
      errorObj: { error: "access_denied", error_description: "..."}
      The callback function is called to get errorMessage, when login failed.

    • always : Function(authObj | errorObj)
      The callback function is called, when login failed or succeed.

    • persistAccessToken : Boolean
      (default: true)
      Even if session expires, Access Token will be saved in local storage for later use. Save Access Token to local storage, in order to use Access Token after session expires.

    • persistRefreshToken : Boolean
      (default: false)
      Even if session expires, Refresh Token will be saved in local storage for later use. Save Refresh Token to local storage, in order to use Refresh Token after session expires.

    • throughTalk : Boolean
      (default: true)
      간편 로그인 사용 여부

  • Kakao.Auth.logout()

    Log out currently logged in user and delete both Access Token and Refresh Token.

    Parameters
  • callback : Function
    The callback function is called after logout

  • Kakao.Auth.loginForm(settings)

    다른 계정으로 로그인할 수 있도록 로그인 팝업창을 띄우는 함수입니다. 사용자의 클릭 이벤트 이후에 호출되어야 브라우저에 의해 팝업이 차단되지 않습니다.

    Parameters
  • settings : Object
    로그인과 관련된 설정을 key/value로 전달합니다.

    • success : Function(authObj)
      authObj: { access_token:"...", refresh_token:"..." token_type:"bearer", expires_in:43199, scope:"Basic_Profile"}
      로그인이 성공할 경우 사용자 토큰을 받을 콜백 함수

    • fail : Function(errorObj)
      errorObj: { error: "access_denied", error_description: "..."}
      로그인이 실패할 경우 에러를 받을 콜백 함수

    • always : Function(authObj | errorObj)
      로그인이 성공한 경우 및 실패한 경우 모두 호출할 콜백 함수

    • persistAccessToken : Boolean
      (default: true)
      세션이 종료된 뒤에도 Access Token을 사용할 수 있도록 로컬 스토리지에 저장합니다.

    • persistRefreshToken : Boolean
      (default: false)
      세션이 종료된 뒤에도 Refresh Token을 사용할 수 있도록 로컬 스토리지에 저장합니다.

  • Kakao.Auth.getAccessToken()

    Return Access Token in use.

    Returns

    String
    Access Token in use

    Kakao.Auth.getRefreshToken()

    This API is deprecated due to security policies.

    Kakao.Auth.setAccessToken(token, persist)

    Set Access Token that wil be used, when calling API.

    Parameters
  • token : String
    Access Token that will be used

  • persist : Boolean
    Even if session expires, Access Token will be saved in local storage for later use. Save Access Token to local storage, in order to use Access Token after session expires.

  • Kakao.Auth.setRefreshToken(token, persist)

    This API is deprecated due to security policies.

    Kakao.Auth.getAppKey()

    Return App Key in use.

    Returns

    String
    App Key in use

    [Deprecated] Kakao.Auth.getStatus(callback)

    Return current login status.

    Parameters
  • callback : Function(statusObj)
    statusObj: { status: "connected" | "not_connected", user: userObj }
    The callback function to return login status

  • Kakao.Auth.getStatusInfo(callback)

    Return current login status.

    Parameters
  • callback : Function(statusObj)
    statusObj: { status: "connected" | "not_connected", user: userObj }
    The callback function to return login status

  • Kakao.Auth.cleanup()

    Deactivate resource and delete iframe inserted for creating login button.


    카카오링크와 관련된 함수들이 포함되어 있습니다.

    링크 타입(Feed, Link, Location)에 맞는 Object를 구성하여 링크를 쉽게 전송할 수 있습니다.

    Parameters

    Feed Type

  • Arguments : Object
    카카오링크와 관련된 설정을 key/value로 전달합니다.

    • container : String | DOMElement (required)
      DOM Element 또는 Element의 ID Selector를 넘기면, 해당 Element를 클릭할 때 카카오링크가 전송됩니다.

    • objectType : String (required)
      (objectType: 'feed')

    • content : Object (required)
      메인 콘텐츠

      • title : String (required)
        콘텐츠의 타이틀

      • imageUrl : String (required)
        이미지 경로, [앱 설정]에 등록된 도메인만 허용

      • link : Object (required)

        • webUrl : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 PC버전에서 이용, [앱 설정]에 등록된 도메인만 허용

        • mobileWebUrl : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 Mobile버전에서 이용, [앱 설정]에 등록된 도메인만 허용

        • androidExecParams : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 Android버전에서 이용, 해당 값이 없을 경우 mobileWebUrl로 적용

        • iosExecParams : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 IOS버전에서 이용, 해당 값이 없을 경우 mobileWebUrl로 적용

      • description : String
        콘텐츠의 상세 내용

      • imageWidth : Number
        이미지 넓이

      • imageHeight : Number
        이미지 높이

    • social : Object
      소셜 정보

      • likeCount : Number
        좋아요 수

      • commentCount : Number
        댓글 수

      • sharedCount : Number
        공유 수

      • viewCount : Number
        조회 수

      • subscriberCount : Number
        구독 수

    • buttonTitle : String
      버튼명, [앱 설정]에 따른 기본 링크 사용, buttonTitle과 buttons 함께 있을 경우 buttons가 적용됨

    • buttons : Array[Object]
      버튼, 링크 설정 가능, buttonTitle과 buttons 함께 있을 경우 buttons가 적용됨

      • title : String (required)

      • link : Object (required)

        • webUrl : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 PC버전에서 이용, [앱 설정]에 등록된 도메인만 허용

        • mobileWebUrl : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 Mobile버전에서 이용, [앱 설정]에 등록된 도메인만 허용

        • androidExecParams : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 Android버전에서 이용, 해당 값이 없을 경우 mobileWebUrl로 적용

        • iosExecParams : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 IOS버전에서 이용, 해당 값이 없을 경우 mobileWebUrl로 적용

    • installTalk : Boolean
      (default: false)
      카카오톡이 설치되어 있지 않은 경우 마켓의 카카오톡 설치 페이지로 이동합니다.

    • fail : Function
      카카오 링크를 지원하지 않는 플랫폼(iOS/Android 외의 플랫폼)에서 함수를 호출했을 경우 불리는 콜백 함수

    • success : Function(messageObj)
      카카오 링크 요청에 대한 응답을 확인하기 위한 콜백 함수(warning message 포함)

      • messageObj : Object
        warning message

        • template_msg : Object
          링크 메시지 (Link JSON 참고용)

        • warning_msg : Object
          링크 메시지를 검증한 결과

        • argument_msg : Object
          argument를 검증한 결과

    • callback : Function
      카카오링크 웹공유에서 공유 버튼 클릭 시 호출되는 콜백 함수 (IE 제외)

  • List Type

  • Arguments : Object
    카카오링크와 관련된 설정을 key/value로 전달합니다

    • container : String | DOMElement (required)
      DOM Element 또는 Element의 ID Selector를 넘기면, 해당 Element를 클릭할 때 카카오링크가 전송됩니다.

    • objectType : String (required)
      (objectType: 'list')

    • headerTitle : String (required)
      헤더 타이틀

    • headerLink : Object (required)
      헤더 링크

      • webUrl : String
        (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
        카카오톡 PC버전에서 이용, [앱 설정]에 등록된 도메인만 허용

      • mobileWebUrl : String
        (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
        카카오톡 Mobile버전에서 이용, [앱 설정]에 등록된 도메인만 허용

      • androidExecParams : String
        (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
        카카오톡 Android버전에서 이용, 해당 값이 없을 경우 mobileWebUrl로 적용

      • iosExecParams : String
        (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
        카카오톡 IOS버전에서 이용, 해당 값이 없을 경우 mobileWebUrl로 적용

    • contents : Array[Object] (required)
      메인 콘텐츠

      • title : String (required)
        콘텐츠의 타이틀

      • imageUrl : String (required)
        이미지 경로, [앱 설정]에 등록된 도메인만 허용

      • link : Object (required)

        • webUrl : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 PC버전에서 이용, [앱 설정]에 등록된 도메인만 허용

        • mobileWebUrl : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 Mobile버전에서 이용, [앱 설정]에 등록된 도메인만 허용

        • androidExecParams : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 Android버전에서 이용, 해당 값이 없을 경우 mobileWebUrl로 적용

        • iosExecParams : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 IOS버전에서 이용, 해당 값이 없을 경우 mobileWebUrl로 적용

      • description : String
        콘텐츠의 상세 내용

      • imageWidth : Number
        이미지 넓이

      • imageHeight : Number
        이미지 높이

    • buttonTitle : String
      버튼명, [앱 설정]에 따른 기본 링크 사용, buttonTitle과 buttons 함께 있을 경우 buttons가 적용됨

    • buttons : Array[Object]
      버튼, 링크 설정 가능, buttonTitle과 buttons 함께 있을 경우 buttons가 적용됨

      • title : String (required)

      • link : Object (required)

        • webUrl : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 PC버전에서 이용, [앱 설정]에 등록된 도메인만 허용

        • mobileWebUrl : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 Mobile버전에서 이용, [앱 설정]에 등록된 도메인만 허용

        • androidExecParams : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 Android버전에서 이용, 해당 값이 없을 경우 mobileWebUrl로 적용

        • iosExecParams : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 IOS버전에서 이용, 해당 값이 없을 경우 mobileWebUrl로 적용

    • installTalk : Boolean
      (default: false)
      카카오톡이 설치되어 있지 않은 경우 마켓의 카카오톡 설치 페이지로 이동합니다.

    • fail : Function
      카카오 링크를 지원하지 않는 플랫폼(iOS/Android 외의 플랫폼)에서 함수를 호출했을 경우 불리는 콜백 함수

    • success : Function(messageObj)
      카카오 링크 요청에 대한 응답을 확인하기 위한 콜백 함수(warning message 포함)

      • messageObj : Object
        warning message

        • template_msg : Object
          링크 메시지 (Link JSON 참고용)

        • warning_msg : Object
          링크 메시지를 검증한 결과

        • argument_msg : Object
          argument를 검증한 결과

    • callback : Function
      카카오링크 웹공유에서 공유 버튼 클릭 시 호출되는 콜백 함수 (IE 제외)

  • Location Type

  • Arguments : Object
    카카오링크와 관련된 설정을 key/value로 전달합니다.

    • container : String | DOMElement (required)
      DOM Element 또는 Element의 ID Selector를 넘기면, 해당 Element를 클릭할 때 카카오링크가 전송됩니다.

    • objectType : String (required)
      (objectType: 'location')

    • content : Object (required)
      메인 콘텐츠

      • title : String (required)
        콘텐츠의 타이틀

      • imageUrl : String (required)
        이미지 경로, [앱 설정]에 등록된 도메인만 허용

      • link : Object (required)

        • webUrl : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 PC버전에서 이용, [앱 설정]에 등록된 도메인만 허용

        • mobileWebUrl : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 Mobile버전에서 이용, [앱 설정]에 등록된 도메인만 허용

        • androidExecParams : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 Android버전에서 이용, 해당 값이 없을 경우 mobileWebUrl로 적용

        • iosExecParams : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 IOS버전에서 이용, 해당 값이 없을 경우 mobileWebUrl로 적용

      • description : String
        콘텐츠의 상세 내용

      • imageWidth : Number
        이미지 넓이

      • imageHeight : Number
        이미지 높이

    • address : String (required)
      지도 뷰에서 사용 할 주소, ex.성남시 분당구 판교역로 235

    • addressTitle : String
      지도 뷰에서 사용될 주소명, ex.카카오 본사

    • social : Object
      소셜 정보

      • likeCount : Number
        좋아요 수

      • commentCount : Number
        댓글 수

      • sharedCount : Number
        공유 수

      • viewCount : Number
        조회 수

      • subscriberCount : Number
        구독 수

    • buttonTitle : String
      버튼명, [앱 설정]에 따른 기본 링크 사용, buttonTitle과 buttons 함께 있을 경우 buttons 사용

    • buttons : Array[Object]
      버튼, 링크 설정 가능, buttonTitle과 buttons 함께 있을 경우 buttons 사용

      • title : String (required)

      • link : Object (required)

        • webUrl : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 PC버전에서 이용, [앱 설정]에 등록된 도메인만 허용

        • mobileWebUrl : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 Mobile버전에서 이용, [앱 설정]에 등록된 도메인만 허용

        • androidExecParams : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 Android버전에서 이용, 해당 값이 없을 경우 mobileWebUrl로 적용

        • iosExecParams : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 IOS버전에서 이용, 해당 값이 없을 경우 mobileWebUrl로 적용

    • installTalk : Boolean
      (default: false)
      카카오톡이 설치되어 있지 않은 경우 마켓의 카카오톡 설치 페이지로 이동합니다.

    • fail : Function
      카카오 링크를 지원하지 않는 플랫폼(iOS/Android 외의 플랫폼)에서 함수를 호출했을 경우 불리는 콜백 함수

    • success : Function(messageObj)
      카카오 링크 요청에 대한 응답을 확인하기 위한 콜백 함수(warning message 포함)

      • messageObj : Object
        warning message

        • template_msg : Object
          링크 메시지 (Link JSON 참고용)

        • warning_msg : Object
          링크 메시지를 검증한 결과

        • argument_msg : Object
          argument를 검증한 결과

    • callback : Function
      카카오링크 웹공유에서 공유 버튼 클릭 시 호출되는 콜백 함수 (IE 제외)

  • Commerce Type

  • Arguments : Object
    카카오링크와 관련된 설정을 key/value로 전달합니다.

    • container : String | DOMElement (required)
      DOM Element 또는 Element의 ID Selector를 넘기면, 해당 Element를 클릭할 때 카카오링크가 전송됩니다.

    • objectType : String (required)
      (objectType: 'commerce')

    • content : Object (required)
      메인 콘텐츠

      • title : String (required)
        상품명

      • imageUrl : String (required)
        이미지 경로, [앱 설정]에 등록된 도메인만 허용

      • link : Object (required)

        • webUrl : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 PC버전에서 이용, [앱 설정]에 등록된 도메인만 허용

        • mobileWebUrl : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 Mobile버전에서 이용, [앱 설정]에 등록된 도메인만 허용

        • androidExecParams : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 Android버전에서 이용, 해당 값이 없을 경우 mobileWebUrl로 적용

        • iosExecParams : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 IOS버전에서 이용, 해당 값이 없을 경우 mobileWebUrl로 적용

      • imageWidth : Number
        이미지 넓이

      • imageHeight : Number
        이미지 높이

    • commerce : Object
      가격 정보

      • regularPrice : Number (required)
        정상가격

      • discountPrice : Number
        할인된 가격

      • discountRate : Number
        할인율

      • fixedDiscountPrice : Number
        정액 할인 가격

    • buttonTitle : String
      버튼명, [앱 설정]에 따른 기본 링크 사용, buttonTitle과 buttons 함께 있을 경우 buttons가 적용됨

    • buttons : Array[Object]
      버튼, 링크 설정 가능, buttonTitle과 buttons 함께 있을 경우 buttons가 적용됨

      • title : String (required)

      • link : Object (required)

        • webUrl : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 PC버전에서 이용, [앱 설정]에 등록된 도메인만 허용

        • mobileWebUrl : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 Mobile버전에서 이용, [앱 설정]에 등록된 도메인만 허용

        • androidExecParams : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 Android버전에서 이용, 해당 값이 없을 경우 mobileWebUrl로 적용

        • iosExecParams : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 IOS버전에서 이용, 해당 값이 없을 경우 mobileWebUrl로 적용

    • installTalk : Boolean
      (default: false)
      카카오톡이 설치되어 있지 않은 경우 마켓의 카카오톡 설치 페이지로 이동합니다.

    • fail : Function
      카카오 링크를 지원하지 않는 플랫폼(iOS/Android 외의 플랫폼)에서 함수를 호출했을 경우 불리는 콜백 함수

    • success : Function(messageObj)
      카카오 링크 요청에 대한 응답을 확인하기 위한 콜백 함수(warning message 포함)

      • messageObj : Object
        warning message

        • template_msg : Object
          링크 메시지 (Link JSON 참고용)

        • warning_msg : Object
          링크 메시지를 검증한 결과

        • argument_msg : Object
          argument를 검증한 결과

    • callback : Function
      카카오링크 웹공유에서 공유 버튼 클릭 시 호출되는 콜백 함수 (IE 제외)

  • Text Type

  • Arguments : Object
    카카오링크와 관련된 설정을 key/value로 전달합니다.

    • container : String | DOMElement (required)
      DOM Element 또는 Element의 ID Selector를 넘기면, 해당 Element를 클릭할 때 카카오링크가 전송됩니다.

    • objectType : String (required)
      (objectType: 'text')

    • text : String (required)
      최대 200자의 텍스트

    • link : Object (required)

      • webUrl : String
        (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
        카카오톡 PC버전에서 이용, [앱 설정]에 등록된 도메인만 허용

      • mobileWebUrl : String
        (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
        카카오톡 Mobile버전에서 이용, [앱 설정]에 등록된 도메인만 허용

      • androidExecParams : String
        (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
        카카오톡 Android버전에서 이용, 해당 값이 없을 경우 mobileWebUrl로 적용

      • iosExecParams : String
        (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
        카카오톡 IOS버전에서 이용, 해당 값이 없을 경우 mobileWebUrl로 적용

    • buttonTitle : String
      버튼명, [앱 설정]에 따른 기본 링크 사용, buttonTitle과 buttons 함께 있을 경우 buttons가 적용됨

    • buttons : Array[Object]
      버튼, 링크 설정 가능, buttonTitle과 buttons 함께 있을 경우 buttons가 적용됨

      • title : String (required)

      • link : Object (required)

        • webUrl : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 PC버전에서 이용, [앱 설정]에 등록된 도메인만 허용

        • mobileWebUrl : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 Mobile버전에서 이용, [앱 설정]에 등록된 도메인만 허용

        • androidExecParams : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 Android버전에서 이용, 해당 값이 없을 경우 mobileWebUrl로 적용

        • iosExecParams : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 IOS버전에서 이용, 해당 값이 없을 경우 mobileWebUrl로 적용

    • installTalk : Boolean
      (default: false)
      카카오톡이 설치되어 있지 않은 경우 마켓의 카카오톡 설치 페이지로 이동합니다.

    • fail : Function
      카카오 링크를 지원하지 않는 플랫폼(iOS/Android 외의 플랫폼)에서 함수를 호출했을 경우 불리는 콜백 함수

    • success : Function(messageObj)
      카카오 링크 요청에 대한 응답을 확인하기 위한 콜백 함수(warning message 포함)

      • messageObj : Object
        warning message

        • template_msg : Object
          링크 메시지 (Link JSON 참고용)

        • warning_msg : Object
          링크 메시지를 검증한 결과

        • argument_msg : Object
          argument를 검증한 결과

    • callback : Function
      카카오링크 웹공유에서 공유 버튼 클릭 시 호출되는 콜백 함수 (IE 제외)

  • 사이트의 메타 정보를 활용하여 링크를 전송합니다.

    Parameters
  • Arguments : Object
    카카오링크와 관련된 설정을 key/value로 전달합니다.

    • container : String | DOMElement (required)
      DOM Element 또는 Element의 ID Selector를 넘기면, 해당 Element를 클릭할 때 카카오링크가 전송됩니다.

    • requestUrl : String (required)
      스크랩 할 사이트 URL, 해당 사이트의 메타 정보를 토대로 링크를 생성

    • templateId : Number
      메시지 아이디, [앱 설정] - [메시지 템플릿 v2] 확인

    • templateArgs : Object
      메시지에 전달할 Argument, {'name':'kakao', 'url':'https://developers.kakao.com'}

    • installTalk : Boolean
      (default: false)
      카카오톡이 설치되어 있지 않은 경우 마켓의 카카오톡 설치 페이지로 이동합니다.

    • fail : Function
      카카오 링크를 지원하지 않는 플랫폼(iOS/Android 외의 플랫폼)에서 함수를 호출했을 경우 불리는 콜백 함수

    • success : Function(messageObj)
      카카오 링크 요청에 대한 응답을 확인하기 위한 콜백 함수(warning message 포함)

      • messageObj : Object
        warning message

        • template_msg : Object
          링크 메시지 (Link JSON 참고용)

        • warning_msg : Object
          링크 메시지를 검증한 결과

        • argument_msg : Object
          argument를 검증한 결과

    • callback : Function
      카카오링크 웹공유에서 공유 버튼 클릭 시 호출되는 콜백 함수 (IE 제외)

  • 원하는 형태의 커스텀링크를 만든 후 전송합니다.(커스텀링크 생성가이드로 이동)

    Parameters
  • Arguments : Object
    카카오링크와 관련된 설정을 key/value로 전달합니다.

    • container : String | DOMElement (required)
      DOM Element 또는 Element의 ID Selector를 넘기면, 해당 Element를 클릭할 때 카카오링크가 전송됩니다.

    • templateId : Number (required)
      메시지 아이디, [앱 설정] - [메시지 템플릿 v2] 확인

    • templateArgs : Object
      메시지에 전달할 Argument, {'name':'kakao', 'url':'https://developers.kakao.com'}

    • installTalk : Boolean
      (default: false)
      카카오톡이 설치되어 있지 않은 경우 마켓의 카카오톡 설치 페이지로 이동합니다.

    • fail : Function
      카카오 링크를 지원하지 않는 플랫폼(iOS/Android 외의 플랫폼)에서 함수를 호출했을 경우 불리는 콜백 함수

    • success : Function(messageObj)
      카카오 링크 요청에 대한 응답을 확인하기 위한 콜백 함수(warning message 포함)

      • messageObj : Object
        warning message

        • template_msg : Object
          링크 메시지 (Link JSON 참고용)

        • warning_msg : Object
          링크 메시지를 검증한 결과

        • argument_msg : Object
          argument를 검증한 결과

    • callback : Function
      카카오링크 웹공유에서 공유 버튼 클릭 시 호출되는 콜백 함수 (IE 제외)

  • 링크 타입(Feed, Link, Location)에 맞는 Object를 구성하여 링크를 쉽게 전송할 수 있습니다.

    Parameters

    Feed Type

  • Arguments : Object
    카카오링크와 관련된 설정을 key/value로 전달합니다.

    • objectType : String (required)
      (objectType: 'feed')

    • content : Object (required)
      메인 콘텐츠

      • title : String (required)
        콘텐츠의 타이틀

      • imageUrl : String (required)
        이미지 경로, [앱 설정]에 등록된 도메인만 허용

      • link : Object (required)

        • webUrl : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 PC버전에서 이용, [앱 설정]에 등록된 도메인만 허용

        • mobileWebUrl : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 Mobile버전에서 이용, [앱 설정]에 등록된 도메인만 허용

        • androidExecParams : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 Android버전에서 이용, 해당 값이 없을 경우 mobileWebUrl로 적용

        • iosExecParams : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 IOS버전에서 이용, 해당 값이 없을 경우 mobileWebUrl로 적용

      • description : String
        콘텐츠의 상세 내용

      • imageWidth : Number
        이미지 넓이

      • imageHeight : Number
        이미지 높이

    • social : Object
      소셜 정보

      • likeCount : Number
        좋아요 수

      • commentCount : Number
        댓글 수

      • sharedCount : Number
        공유 수

      • viewCount : Number
        조회 수

      • subscriberCount : Number
        구독 수

    • buttonTitle : String
      버튼명, [앱 설정]에 따른 기본 링크 사용, buttonTitle과 buttons 함께 있을 경우 buttons가 적용됨

    • buttons : Array[Object]
      버튼, 링크 설정 가능, buttonTitle과 buttons 함께 있을 경우 buttons가 적용됨

      • title : String (required)

      • link : Object (required)

        • webUrl : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 PC버전에서 이용, [앱 설정]에 등록된 도메인만 허용

        • mobileWebUrl : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 Mobile버전에서 이용, [앱 설정]에 등록된 도메인만 허용

        • androidExecParams : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 Android버전에서 이용, 해당 값이 없을 경우 mobileWebUrl로 적용

        • iosExecParams : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 IOS버전에서 이용, 해당 값이 없을 경우 mobileWebUrl로 적용

    • installTalk : Boolean
      (default: false)
      카카오톡이 설치되어 있지 않은 경우 마켓의 카카오톡 설치 페이지로 이동합니다.

    • fail : Function
      카카오 링크를 지원하지 않는 플랫폼(iOS/Android 외의 플랫폼)에서 함수를 호출했을 경우 불리는 콜백 함수

    • success : Function(messageObj)
      카카오 링크 요청에 대한 응답을 확인하기 위한 콜백 함수(warning message 포함)

      • messageObj : Object
        warning message

        • template_msg : Object
          링크 메시지 (Link JSON 참고용)

        • warning_msg : Object
          링크 메시지를 검증한 결과

        • argument_msg : Object
          argument를 검증한 결과

    • callback : Function
      카카오링크 웹공유에서 공유 버튼 클릭 시 호출되는 콜백 함수 (IE 제외)

  • List Type

  • Arguments : Object
    카카오링크와 관련된 설정을 key/value로 전달합니다.

    • objectType : String (required)
      (objectType: 'list')

    • headerTitle : String (required)
      헤더 타이틀

    • headerLink : Object (required)
      헤더 링크

      • webUrl : String
        (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
        카카오톡 PC버전에서 이용, [앱 설정]에 등록된 도메인만 허용

      • mobileWebUrl : String
        (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
        카카오톡 Mobile버전에서 이용, [앱 설정]에 등록된 도메인만 허용

      • androidExecParams : String
        (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
        카카오톡 Android버전에서 이용, 해당 값이 없을 경우 mobileWebUrl로 적용

      • iosExecParams : String
        (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
        카카오톡 IOS버전에서 이용, 해당 값이 없을 경우 mobileWebUrl로 적용

    • contents : Array[Object] (required)
      메인 콘텐츠

      • title : String (required)
        콘텐츠의 타이틀

      • imageUrl : String (required)
        이미지 경로, [앱 설정]에 등록된 도메인만 허용

      • link : Object (required)

        • webUrl : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 PC버전에서 이용, [앱 설정]에 등록된 도메인만 허용

        • mobileWebUrl : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 Mobile버전에서 이용, [앱 설정]에 등록된 도메인만 허용

        • androidExecParams : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 Android버전에서 이용, 해당 값이 없을 경우 mobileWebUrl로 적용

        • iosExecParams : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 IOS버전에서 이용, 해당 값이 없을 경우 mobileWebUrl로 적용

      • description : String
        콘텐츠의 상세 내용

      • imageWidth : Number
        이미지 넓이

      • imageHeight : Number
        이미지 높이

    • buttonTitle : String
      버튼명, [앱 설정]에 따른 기본 링크 사용, buttonTitle과 buttons 함께 있을 경우 buttons가 적용됨

    • buttons : Array[Object]
      버튼, 링크 설정 가능, buttonTitle과 buttons 함께 있을 경우 buttons가 적용됨

      • title : String (required)

      • link : Object (required)

        • webUrl : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 PC버전에서 이용, [앱 설정]에 등록된 도메인만 허용

        • mobileWebUrl : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 Mobile버전에서 이용, [앱 설정]에 등록된 도메인만 허용

        • androidExecParams : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 Android버전에서 이용, 해당 값이 없을 경우 mobileWebUrl로 적용

        • iosExecParams : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 IOS버전에서 이용, 해당 값이 없을 경우 mobileWebUrl로 적용

    • installTalk : Boolean
      (default: false)
      카카오톡이 설치되어 있지 않은 경우 마켓의 카카오톡 설치 페이지로 이동합니다.

    • fail : Function
      카카오 링크를 지원하지 않는 플랫폼(iOS/Android 외의 플랫폼)에서 함수를 호출했을 경우 불리는 콜백 함수

    • success : Function(messageObj)
      카카오 링크 요청에 대한 응답을 확인하기 위한 콜백 함수(warning message 포함)

      • messageObj : Object
        warning message

        • template_msg : Object
          링크 메시지 (Link JSON 참고용)

        • warning_msg : Object
          링크 메시지를 검증한 결과

        • argument_msg : Object
          argument를 검증한 결과

    • callback : Function
      카카오링크 웹공유에서 공유 버튼 클릭 시 호출되는 콜백 함수 (IE 제외)

  • Location Type

  • Arguments : Object
    카카오링크와 관련된 설정을 key/value로 전달합니다.

    • objectType : String (required)
      (objectType: 'location')

    • content : Object (required)
      메인 콘텐츠

      • title : String (required)
        콘텐츠의 타이틀

      • imageUrl : String (required)
        이미지 경로, [앱 설정]에 등록된 도메인만 허용

      • link : Object (required)

        • webUrl : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 PC버전에서 이용, [앱 설정]에 등록된 도메인만 허용

        • mobileWebUrl : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 Mobile버전에서 이용, [앱 설정]에 등록된 도메인만 허용

        • androidExecParams : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 Android버전에서 이용, 해당 값이 없을 경우 mobileWebUrl로 적용

        • iosExecParams : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 IOS버전에서 이용, 해당 값이 없을 경우 mobileWebUrl로 적용

      • description : String
        콘텐츠의 상세 내용

      • imageWidth : Number
        이미지 넓이

      • imageHeight : Number
        이미지 높이

    • address : String (required)
      지도 뷰에서 사용 할 주소, ex.성남시 분당구 판교역로 235

    • addressTitle : String
      지도 뷰에서 사용될 주소명, ex.카카오 본사

    • social : Object
      소셜 정보

      • likeCount : Number
        좋아요 수

      • commentCount : Number
        댓글 수

      • sharedCount : Number
        공유 수

      • viewCount : Number
        조회 수

      • subscriberCount : Number
        구독 수

    • buttonTitle : String
      버튼명, [앱 설정]에 따른 기본 링크 사용, buttonTitle과 buttons 함께 있을 경우 buttons 사용

    • buttons : Array[Object]
      버튼, 링크 설정 가능, buttonTitle과 buttons 함께 있을 경우 buttons 사용

      • title : String (required)

      • link : Object (required)

        • webUrl : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 PC버전에서 이용, [앱 설정]에 등록된 도메인만 허용

        • mobileWebUrl : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 Mobile버전에서 이용, [앱 설정]에 등록된 도메인만 허용

        • androidExecParams : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 Android버전에서 이용, 해당 값이 없을 경우 mobileWebUrl로 적용

        • iosExecParams : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 IOS버전에서 이용, 해당 값이 없을 경우 mobileWebUrl로 적용

    • installTalk : Boolean
      (default: false)
      카카오톡이 설치되어 있지 않은 경우 마켓의 카카오톡 설치 페이지로 이동합니다.

    • fail : Function
      카카오 링크를 지원하지 않는 플랫폼(iOS/Android 외의 플랫폼)에서 함수를 호출했을 경우 불리는 콜백 함수

    • success : Function(messageObj)
      카카오 링크 요청에 대한 응답을 확인하기 위한 콜백 함수(warning message 포함)

      • messageObj : Object
        warning message

        • template_msg : Object
          링크 메시지 (Link JSON 참고용)

        • warning_msg : Object
          링크 메시지를 검증한 결과

        • argument_msg : Object
          argument를 검증한 결과

    • callback : Function
      카카오링크 웹공유에서 공유 버튼 클릭 시 호출되는 콜백 함수 (IE 제외)

  • Commerce Type

  • Arguments : Object
    카카오링크와 관련된 설정을 key/value로 전달합니다.

    • objectType : String (required)
      (objectType: 'commerce')

    • content : Object (required)
      메인 콘텐츠

      • title : String (required)
        상품명

      • imageUrl : String (required)
        이미지 경로, [앱 설정]에 등록된 도메인만 허용

      • link : Object (required)

        • webUrl : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 PC버전에서 이용, [앱 설정]에 등록된 도메인만 허용

        • mobileWebUrl : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 Mobile버전에서 이용, [앱 설정]에 등록된 도메인만 허용

        • androidExecParams : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 Android버전에서 이용, 해당 값이 없을 경우 mobileWebUrl로 적용

        • iosExecParams : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 IOS버전에서 이용, 해당 값이 없을 경우 mobileWebUrl로 적용

      • imageWidth : Number
        이미지 넓이

      • imageHeight : Number
        이미지 높이

    • commerce : Object
      가격 정보

      • regularPrice : Number (required)
        정상가격

      • discountPrice : Number
        할인된 가격

      • discountRate : Number
        할인율

      • fixedDiscountPrice : Number
        정액 할인 가격

    • buttonTitle : String
      버튼명, [앱 설정]에 따른 기본 링크 사용, buttonTitle과 buttons 함께 있을 경우 buttons가 적용됨

    • buttons : Array[Object]
      버튼, 링크 설정 가능, buttonTitle과 buttons 함께 있을 경우 buttons가 적용됨

      • title : String (required)

      • link : Object (required)

        • webUrl : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 PC버전에서 이용, [앱 설정]에 등록된 도메인만 허용

        • mobileWebUrl : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 Mobile버전에서 이용, [앱 설정]에 등록된 도메인만 허용

        • androidExecParams : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 Android버전에서 이용, 해당 값이 없을 경우 mobileWebUrl로 적용

        • iosExecParams : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 IOS버전에서 이용, 해당 값이 없을 경우 mobileWebUrl로 적용

    • installTalk : Boolean
      (default: false)
      카카오톡이 설치되어 있지 않은 경우 마켓의 카카오톡 설치 페이지로 이동합니다.

    • fail : Function
      카카오 링크를 지원하지 않는 플랫폼(iOS/Android 외의 플랫폼)에서 함수를 호출했을 경우 불리는 콜백 함수

    • success : Function(messageObj)
      카카오 링크 요청에 대한 응답을 확인하기 위한 콜백 함수(warning message 포함)

      • messageObj : Object
        warning message

        • template_msg : Object
          링크 메시지 (Link JSON 참고용)

        • warning_msg : Object
          링크 메시지를 검증한 결과

        • argument_msg : Object
          argument를 검증한 결과

    • callback : Function
      카카오링크 웹공유에서 공유 버튼 클릭 시 호출되는 콜백 함수 (IE 제외)

  • Text Type

  • Arguments : Object
    카카오링크와 관련된 설정을 key/value로 전달합니다.

    • objectType : String (required)
      (objectType: 'text')

    • text : String (required)
      최대 200자의 텍스트

    • link : Object (required)

      • webUrl : String
        (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
        카카오톡 PC버전에서 이용, [앱 설정]에 등록된 도메인만 허용

      • mobileWebUrl : String
        (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
        카카오톡 Mobile버전에서 이용, [앱 설정]에 등록된 도메인만 허용

      • androidExecParams : String
        (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
        카카오톡 Android버전에서 이용, 해당 값이 없을 경우 mobileWebUrl로 적용

      • iosExecParams : String
        (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
        카카오톡 IOS버전에서 이용, 해당 값이 없을 경우 mobileWebUrl로 적용

    • buttonTitle : String
      버튼명, [앱 설정]에 따른 기본 링크 사용, buttonTitle과 buttons 함께 있을 경우 buttons가 적용됨

    • buttons : Array[Object]
      버튼, 링크 설정 가능, buttonTitle과 buttons 함께 있을 경우 buttons가 적용됨

      • title : String (required)

      • link : Object (required)

        • webUrl : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 PC버전에서 이용, [앱 설정]에 등록된 도메인만 허용

        • mobileWebUrl : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 Mobile버전에서 이용, [앱 설정]에 등록된 도메인만 허용

        • androidExecParams : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 Android버전에서 이용, 해당 값이 없을 경우 mobileWebUrl로 적용

        • iosExecParams : String
          (constraint: webUrl, mobileWebUrl, androidExecParams, iosExecParams 중 하나는 필수)
          카카오톡 IOS버전에서 이용, 해당 값이 없을 경우 mobileWebUrl로 적용

    • installTalk : Boolean
      (default: false)
      카카오톡이 설치되어 있지 않은 경우 마켓의 카카오톡 설치 페이지로 이동합니다.

    • fail : Function
      카카오 링크를 지원하지 않는 플랫폼(iOS/Android 외의 플랫폼)에서 함수를 호출했을 경우 불리는 콜백 함수

    • success : Function(messageObj)
      카카오 링크 요청에 대한 응답을 확인하기 위한 콜백 함수(warning message 포함)

      • messageObj : Object
        warning message

        • template_msg : Object
          링크 메시지 (Link JSON 참고용)

        • warning_msg : Object
          링크 메시지를 검증한 결과

        • argument_msg : Object
          argument를 검증한 결과

    • callback : Function
      카카오링크 웹공유에서 공유 버튼 클릭 시 호출되는 콜백 함수 (IE 제외)


  • Returns

    Promise
    호출 결과에 대한 Promise를 반환합니다. 순차적으로 API를 호출하는 경우, Promise를 이용하여 간결한 코드를 작성할 수 있습니다. Promise에 대한 전반적인 설명은 여기를 참조하세요.


  • Response : Object
    warning message

    • template_msg : Object
      링크 메시지 (Link JSON 참고용)

    • warning_msg : Object
      링크 메시지를 검증한 결과

    • argument_msg : Object
      argument를 검증한 결과

  • 사이트의 메타 정보를 활용하여 링크를 전송합니다.

    Parameters
  • Arguments : Object
    카카오링크와 관련된 설정을 key/value로 전달합니다.

    • requestUrl : String (required)
      스크랩 할 사이트 URL, 해당 사이트의 메타 정보를 토대로 링크를 생성

    • templateId : Number
      메시지 아이디, [앱 설정] - [메시지 템플릿 v2] 확인

    • templateArgs : Object
      메시지에 전달할 Argument, {'name':'kakao', 'url':'https://developers.kakao.com'}

    • installTalk : Boolean
      (default: false)
      카카오톡이 설치되어 있지 않은 경우 마켓의 카카오톡 설치 페이지로 이동합니다.

    • fail : Function
      카카오 링크를 지원하지 않는 플랫폼(iOS/Android 외의 플랫폼)에서 함수를 호출했을 경우 불리는 콜백 함수

    • success : Function(messageObj)
      카카오 링크 요청에 대한 응답을 확인하기 위한 콜백 함수(warning message 포함)

      • messageObj : Object
        warning message

        • template_msg : Object
          링크 메시지 (Link JSON 참고용)

        • warning_msg : Object
          링크 메시지를 검증한 결과

        • argument_msg : Object
          argument를 검증한 결과

    • callback : Function
      카카오링크 웹공유에서 공유 버튼 클릭 시 호출되는 콜백 함수 (IE 제외)


  • Returns

    Promise
    호출 결과에 대한 Promise를 반환합니다. 순차적으로 API를 호출하는 경우, Promise를 이용하여 간결한 코드를 작성할 수 있습니다. Promise에 대한 전반적인 설명은 여기를 참조하세요.


  • Response : Object
    warning message

    • template_msg : Object
      링크 메시지 (Link JSON 참고용)

    • warning_msg : Object
      링크 메시지를 검증한 결과

    • argument_msg : Object
      argument를 검증한 결과

  • 원하는 형태의 커스텀링크를 만든 후 전송합니다.(커스텀링크 생성가이드로 이동)

    Parameters
  • Arguments : Object
    카카오링크와 관련된 설정을 key/value로 전달합니다.

    • templateId : Number (required)
      메시지 아이디, [앱 설정] - [메시지 템플릿 v2] 확인

    • templateArgs : Object
      메시지에 전달할 Argument, {'name':'kakao', 'url':'https://developers.kakao.com'}

    • installTalk : Boolean
      (default: false)
      카카오톡이 설치되어 있지 않은 경우 마켓의 카카오톡 설치 페이지로 이동합니다.

    • fail : Function
      카카오 링크를 지원하지 않는 플랫폼(iOS/Android 외의 플랫폼)에서 함수를 호출했을 경우 불리는 콜백 함수

    • success : Function(messageObj)
      카카오 링크 요청에 대한 응답을 확인하기 위한 콜백 함수(warning message 포함)

      • messageObj : Object
        warning message

        • template_msg : Object
          링크 메시지 (Link JSON 참고용)

        • warning_msg : Object
          링크 메시지를 검증한 결과

        • argument_msg : Object
          argument를 검증한 결과

    • callback : Function
      카카오링크 웹공유에서 공유 버튼 클릭 시 호출되는 콜백 함수 (IE 제외)


  • Returns

    Promise
    호출 결과에 대한 Promise를 반환합니다. 순차적으로 API를 호출하는 경우, Promise를 이용하여 간결한 코드를 작성할 수 있습니다. Promise에 대한 전반적인 설명은 여기를 참조하세요.


  • Response : Object
    warning message

    • template_msg : Object
      링크 메시지 (Link JSON 참고용)

    • warning_msg : Object
      링크 메시지를 검증한 결과

    • argument_msg : Object
      argument를 검증한 결과

  • 카카오링크에 필요한 이미지를 업로드 합니다. (이미지는 20일 동안 보관됩니다.)

    Parameters
  • Arguments : Object
    카카오링크 이미지와 관련된 설정을 key/value로 전달합니다.

    • file : FileList (required)
      HTMLInputElement의 files property


  • Returns

    Promise
    호출 결과에 대한 Promise를 반환합니다. 순차적으로 API를 호출하는 경우, Promise를 이용하여 간결한 코드를 작성할 수 있습니다. Promise에 대한 전반적인 설명은 여기를 참조하세요.


  • infos : Object
    이미지 정보

    • original : Object

      • url : String
        이미지 Full URL

      • length : Number
        이미지 사이즈, 단위: Byte

      • content_type : String
        이미지 포맷

      • width : Number
        이미지 가로 크기

      • height : Number
        이미지 세로 크기

  • 삭제할 이미지의 경로를 전달하면 이미지를 삭제할 수 있습니다.

    Parameters
  • Arguments : Object
    카카오링크 이미지와 관련된 설정을 key/value로 전달합니다.

    • imageUrl : String (required)

  • 스크랩 하고 싶은 이미지의 경로를 전달하면 스크랩 후 업로드 합니다. (이미지는 20일 동안 보관됩니다.)

    Parameters
  • Arguments : Object
    카카오링크 이미지와 관련된 설정을 key/value로 전달합니다.

    • imageUrl : String (required)


  • Returns

    Promise
    호출 결과에 대한 Promise를 반환합니다. 순차적으로 API를 호출하는 경우, Promise를 이용하여 간결한 코드를 작성할 수 있습니다. Promise에 대한 전반적인 설명은 여기를 참조하세요.


  • infos : Object
    이미지 정보

    • original : Object

      • url : String
        이미지 Full URL

      • length : Number
        이미지 사이즈, 단위: Byte

      • content_type : String
        이미지 포맷

      • width : Number
        이미지 가로 크기

      • height : Number
        이미지 세로 크기

  • 카카오 링크 전송과 관련된 리소스를 해제합니다.


    Kakao.API

    Include functions related to Kakao API.
    * Kakao.API.request function return Promise.

    Each API's request parameter and response is identical to REST API. REST API simple reference
    Kakao.API.request(settings)

    Request Kakao API.

    Parameters
  • settings : Object
    Attributes of API are passed by 'key/value' format.

    • url : String (required)
      API URL that will be requested

    • data : Object
      Parameter that will be passed in API

    • files : FileList | Array[File] | Array[Blob]
      Parameter that will be used, when request API to attach a file.

    • success : Function(resultObj)
      The callback function is called to get result, when API requests succeed.

    • fail : Function(errorObj)
      The callback function is called to get result, when API requests failed.

    • always : Function(resultObj | errorObj)
      The callback function is called, when API requests failed or succeed.


  • Returns

    Promise
    Return Promise about response. When sequentially calling API, you can code simply using Promise.For detail about Promise please refer here.

    Kakao.API.cleanup()

    Deactivate resource that has been used previously for API requests.


    Kakao.Navi

    카카오내비 앱을 실행시키는 API입니다. 목적지 길안내, 목적지 공유 기능을 제공합니다.

    Kakao.Navi.start(settings)

    카카오내비 앱을 실행 후 길안내를 시작합니다.

    Parameters
  • settings : Object
    카카오내비 앱을 실행할 때의 옵션

    • name : String (required)
      목적지명

    • x : Number (required)
      목적지의 x 좌표(경도). wgs84 또는 katec 좌표계의 값.

    • y : Number (required)
      목적지의 y 좌표(위도). wgs84 또는 katec 좌표계의 값.

    • coordType : String
      default: katec
      좌표타입(wgs84, katec)

    • vehicleType : Number
      default: 1
      차종(1: 1종(승용차/소형승합차/소형화물화), 2: 2종(중형승합차/중형화물차), 3: 3종(대형승합차/2축 대형화물차), 4: 4종(3축 대형화물차), 5: 5종(4축이상 특수화물차), 6: 6종(경차), 7: 이륜차)

    • rpOption : Number
      default: 1
      경로옵션(1:빠른길, 2:무료도로, 3:최단거리, 4:자동전용제회, 5:큰길우선, 6:고속도로우선, 8:일반도로우선)

    • routeInfo : Boolean
      default: false
      전체 경로보기 보기 여부

    • sX : Number
      시작좌표 x

    • sY : Number
      시작좌표 y

    • sAngle : Number
      시작앵글(0~359)

    • returnUri : String
      길안내 종료(전체 경로보기시 종료) 후 호출 될 URI

    • viaPoints : Array
      경유지 정보 (최대 3개까지)

      • name : String
        경유지 명칭

      • x : Number
        경유지 x 좌표

      • y : Number
        경유지 y 좌표

  • Kakao.Navi.share(settings)

    카카오내비 앱을 실행 후 목적지룰 공유합니다.

    Parameters
  • settings : Object
    카카오내비 앱을 실행할 때의 옵션

    • name : String (required)
      목적지명

    • x : Number (required)
      목적지의 x 좌표(경도). wgs84 또는 katec 좌표계의 값.

    • y : Number (required)
      목적지의 y 좌표(위도). wgs84 또는 katec 좌표계의 값.

    • coordType : String
      default: katec
      좌표타입(wgs84, katec)


  • Kakao.Story

    Include functions related to KakaoStory share button.

    Kakao.Story.createShareButton(settings)

    Open KakaoStory share popup when specified element is clicked.

    Parameters
  • settings : Object
    Attributes of KakaoStory share button are passed by 'key/value' format.

    • container : String | DOMElement (required)
      ID Selector or DOM Element of a container that will open the KakaoStory share popup when clicked.

    • url : String
      (default: current page's URL)
      The URL to share in KakaoStory. Alternatively, data-url attribute in 'container' element can be used.

    • text : String
      (default: empty)
      Default text to display in share popup

  • Kakao.Story.share(settings)

    Open KakaoStory share popup.

    Parameters
  • settings : Object
    Attributes of KakaoStory share button are passed by 'key/value' format.

    • url : String
      (default: current page's URL)
      The URL to share in KakaoStory

    • text : String
      (default: empty)
      Default text to display in share popup

  • Kakao.Story.open(settings)

    Open KakaoStory mobile App.

    Parameters
  • settings : Object
    Attributes of KakaoStory share button are passed by 'key/value' format.

    • install : Boolean
      (default: false)
      카카오스토리 앱이 설치되어 있지 않은 경우 마켓의 카카오스토리 설치 페이지로 이동합니다.

    • url : String
      (default: current page's URL)
      The web page URL to share in KakaoStory

    • text : String
      (default: empty)
      Default text to display in share popup

    • urlInfo : String
      (default: created by scrap server
      Additional info of the shared web page

      • title : String (required)
        Title of shared web page

      • desc : String
        Description of shared web page

      • name : String
        Display name of shared web page

      • imageurl : Array[String]
        An Image url which represent shared web page

  • Kakao.Story.createFollowButton(settings)

    Follow KakaoStory Channel when specified element is clicked.

    Parameters
  • settings : Object
    Attributes of KakaoStory follow button are passed by 'key/value' format.

    • container : String | DOMElement (required)
      ID Selector or DOM Element of a container that will contain the KakaoStory follow button.

    • id : String (required)
      KakaoStory Channel ID to follow. ex) kakao

    • showFollowerCount : Boolean
      (default: true)
      Show follower count. Alternatively, data-show-follower-count attribute in 'container' element can be used instead.

    • type : String
      'horizontal', 'vertical' (default: 'horizontal')
      Select style for showing follower count. Alternatively, data-type attribute in 'container' element can be used instead.

  • Kakao.Story.cleanup()

    Deactivate resource related to KakaoStory share button.


    Kakao.PlusFriend

    [Deprecated] This module was replaced by the Channel module. use the Channel module.

    [Deprecated] Kakao.PlusFriend.createAddFriendButton(settings)

    Create a Add PlusFriend button. Use Kakao.PlusFriend.addFriend when creating button manually.

    Parameters
  • settings : Object
    Attributes of Add PlusFriend button are passed by 'key/value' format.

    • container : String | DOMElement (required)
      ID Selector or DOM Element

    • plusFriendId : String (required)
      Plus Friend ID included in Target Plus Friend Home URL

    • size : String
      'small', 'large' (default: 'small')
      Size of Add PlusFriend button

    • color : String
      'yellow', 'black' (default: 'yellow')
      Size of Add PlusFriend button

    • shape : String
      'rect', 'round' (default: 'rect')
      Shape of Add PlusFriend button

    • supportMultipleDensities : Boolean
      (default: false)
      Use 2x 3x resolution images according to device pixel ratio, unsupported IE

  • [Deprecated] Kakao.PlusFriend.addFriend(settings)

    Opens a popup window about Add PlusFriend. this must be called after users click event in order to make sure that browser does not block window. if it is not necessary to make custom login button refer Kakao.PlusFriend.createAddFriendButton.

    Parameters
  • settings : Object
    Attributes of PlusFriend are passed by 'key/value' format.

    • plusFriendId : String (required)
      Plus Friend ID included in Target Plus Friend Home URL

  • [Deprecated] Kakao.PlusFriend.createChatButton(settings)

    Create a 1:1 Chat PlusFriend button. Use Kakao.PlusFriend.chat when creating button manually.

    Parameters
  • settings : Object
    Attributes of 1:1 Chat PlusFriend button are passed by 'key/value' format.

    • container : String | DOMElement (required)
      ID Selector or DOM Element

    • plusFriendId : String (required)
      Plus Friend ID included in Target Plus Friend Home URL

    • title : String
      'consult', 'question' (default: 'consult')
      Title of 1:1 Chat PlusFriend button

    • size : String
      'small', 'large' (default: 'small')
      Size of 1:1 Chat PlusFriend button

    • color : String
      'yellow', 'mono' (default: 'yellow')
      Color of 1:1 Chat PlusFriend button

    • shape : String
      'pc', 'mobile' (default: 'pc')
      Shape of 1:1 Chat PlusFriend button

    • supportMultipleDensities : Boolean
      (default: false)
      Use 2x 3x resolution images according to device pixel ratio, unsupported IE

  • [Deprecated] Kakao.PlusFriend.chat(settings)

    Start a 1:1 chatting with PlusFriend. this must be called after users click event in order to make sure that browser does not block window. if it is not necessary to make custom login button refer Kakao.PlusFriend.createChatButton.

    Parameters
  • settings : Object
    Attributes of PlusFriend are passed by 'key/value' format.

    • plusFriendId : String (required)
      Plus Friend ID included in Target Plus Friend Home URL


  • Kakao.Channel

    Include functions related to Kakao Talk Channel Plug-in.

    Kakao.Channel.createAddChannelButton(settings)

    Create a Add Kakao Talk Channel button. Use Kakao.Channel.addChannel when creating button manually.

    Parameters
  • settings : Object
    Attributes of Add Kakao Talk Channel button are passed by 'key/value' format.

    • container : String | DOMElement (required)
      ID Selector or DOM Element

    • channelPublicId : String (required)
      Kakao Talk Channel public ID included in Target Kakao Talk Channel Home URL.

    • size : String
      'small', 'large' (default: 'small')
      Size of Add Kakao Talk Channel button

    • supportMultipleDensities : Boolean
      (default: false)
      Use 2x 3x resolution images according to device pixel ratio, unsupported IE

  • Kakao.Channel.addChannel(settings)

    Opens a popup window about Add Kakao Talk Channel. this must be called after users click event in order to make sure that browser does not block window. if it is not necessary to make custom login button refer Kakao.Channel.createAddChannelButton.

    Parameters
  • settings : Object
    Attributes of Kakao Talk Channel are passed by 'key/value' format.

    • channelPublicId : String (required)
      Kakao Talk Channel public ID included in Target Kakao Talk Channel Home URL.

  • Kakao.Channel.createChatButton(settings)

    Create a 1:1 Chat Channel button. Use Kakao.Channel.chat when creating button manually.

    Parameters
  • settings : Object
    Attributes of 1:1 Chat Kakao Talk Channel button are passed by 'key/value' format.

    • container : String | DOMElement (required)
      ID Selector or DOM Element

    • channelPublicId : String (required)
      Kakao Talk Channel public ID included in Target Kakao Talk Channel Home URL.

    • title : String
      'consult', 'question' (default: 'consult')
      Title of 1:1 Chat Kakao Talk Channel button

    • size : String
      'small', 'large' (default: 'small')
      Size of 1:1 Chat Kakao Talk Channel button

    • color : String
      'yellow', 'mono' (default: 'yellow')
      Color of 1:1 Chat Kakao Talk Channel button

    • shape : String
      'pc', 'mobile' (default: 'pc')
      Shape of 1:1 Chat Kakao Talk Channel button

    • supportMultipleDensities : Boolean
      (default: false)
      Use 2x 3x resolution images according to device pixel ratio, unsupported IE

  • Kakao.Channel.chat(settings)

    Start a 1:1 chatting with Kakao Talk Channel. this must be called after users click event in order to make sure that browser does not block window. if it is not necessary to make custom login button refer Kakao.Channel.createChatButton.

    Parameters
  • settings : Object
    Attributes of Kakao Talk Channel are passed by 'key/value' format.

    • channelPublicId : String (required)
      Kakao Talk Channel public ID included in Target Kakao Talk Channel Home URL.


  • 최종 수정일: 2019-03-14