Index


Kakao

공통적으로 사용하는 함수들이 포함되어 있습니다.

Kakao.init(appKey)

Kakao JavaScript SDK를 초기화합니다. SDK를 사용하기 전에 호출해 주어야 합니다.

Parameters
  • appKey : String
    개발자 사이트에 등록한 앱의 JavaScript Key

  • Kakao.cleanup()

    Kakao JavaScript SDK에서 사용한 리소스를 해제합니다.

    Kakao.VERSION

    Kakao JavaScript SDK의 버전을 반환합니다.


    Kakao.Auth

    사용자 인증과 관련된 함수들이 포함되어 있습니다.

    Kakao.Auth.createLoginButton(settings)

    카카오 로그인 버튼을 생성합니다. 직접 로그인 버튼을 제작하여 사용하는 경우에는 Kakao.Auth.login을 이용하세요.

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

    • container : String | DOMElement (required)
      DOM Element 또는 Element의 ID Selector를 넘기면, 해당 Element 내부에 로그인 버튼이 생성됩니다.

    • lang : String
      'kr', 'en' (default: 'kr')
      로그인 버튼에 표시할 언어

    • size : String
      'small', 'medium', 'large' (default: 'medium')
      로그인 버튼의 사이즈

    • 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.login(settings)

    사용자가 앱에 로그인할 수 있도록 로그인 팝업창을 띄우는 함수입니다. 사용자의 클릭 이벤트 이후에 호출되어야 브라우저에 의해 팝업이 차단되지 않습니다. 직접 로그인 버튼을 제작하여 사용할 필요가 없는 경우에는 Kakao.Auth.createLoginButton을 이용하는 것이 더 편리합니다.

    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을 사용할 수 있도록 로컬 스토리지에 저장합니다.

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

  • Kakao.Auth.logout()

    현재 로그인되어 있는 사용자를 로그아웃시키고, Access Token과 Refresh 토큰을 삭제합니다.

    Parameters
  • callback : Function
    로그아웃 후 호출할 콜백 함수

  • 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()

    현재 사용중인 Access Token을 반환합니다.

    Returns

    String
    사용중인 Access Token

    Kakao.Auth.getRefreshToken()

    현재 사용중인 Refresh Token을 반환합니다.

    Returns

    String
    사용중인 Refresh Token

    Kakao.Auth.setAccessToken(token, persist)

    API호출시 사용할 Access Token을 설정합니다.

    Parameters
  • token : String
    사용할 Access Token

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

  • Kakao.Auth.setRefreshToken(token, persist)

    API호출시 사용할 Refresh Token을 설정합니다.

    Parameters
  • token : String
    사용할 Refresh Token

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

  • Kakao.Auth.getAppKey()

    현재 사용중인 App Key를 반환합니다.

    Returns

    String
    사용중인 App Key

    Kakao.Auth.getStatus(callback)

    현재 로그인 상태를 반환합니다.

    Parameters
  • callback : Function(statusObj)
    statusObj: { status: "connected" | "not_connected", user: userObj }
    로그인 상태를 반환할 콜백 함수

  • Kakao.Auth.cleanup()

    로그인 버튼을 생성하기 위해 삽입한 iframe을 삭제하고 리소스를 해제합니다.


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

    링크 타입(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를 검증한 결과

  • 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를 검증한 결과

  • 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를 검증한 결과

  • 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를 검증한 결과

  • 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를 검증한 결과

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

    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를 검증한 결과

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

    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를 검증한 결과

  • 링크 타입(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를 검증한 결과

  • 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를 검증한 결과

  • 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를 검증한 결과

  • 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를 검증한 결과

  • 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를 검증한 결과


  • 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를 검증한 결과


  • 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를 검증한 결과


  • 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
        이미지 세로 크기

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

    지정한 Element를 클릭할 때 카카오링크가 전송되도록 합니다.

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

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

    • label : String
      (constraint: 1000자 이상일 경우, 1000자까지만 전송)
      메시지에 표시할 라벨

    • image : Object
      메시지에 표시할 이미지

      • src : String (required)
        (constraint: 1MB이하의 이미지만 표시됨)
        이미지 URL(RFC2396, RFC1034, RFC1123 를 준수 하지 않는 이미지 url은 이미지가 보이지 않습니다.)

      • width : String | Number (required)
        (constraint: 80 이상이어야 함)
        이미지 너비(픽셀)

      • height : String | Number (required)
        (constraint: 80 이상이어야 함)
        이미지 높이(픽셀)

    • webButton : Object
      메시지에 표시할 버튼: 클릭시 등록한 웹사이트로 이동. 웹사이트를 등록하지 않은 경우 오류 발생.

      • text : String
        (default: "앱으로 가기")
        버튼에 표시할 텍스트

      • url : String
        (default: 개발자 사이트에 등록한 웹사이트 중 첫번째 URL)
        이동할 웹사이트의 URL

    • appButton : Object
      메시지에 표시할 버튼: 클릭시 개발자 사이트에 등록한 앱으로 이동. 현재 플랫폼(iOS/Android)에 등록한 앱이 없는 경우 오류 발생.

      • text : String
        (default: "앱으로 가기")
        버튼에 표시할 텍스트

      • webUrl : String
        카카오톡 PC버전에서 버튼을 클릭시 이동할 웹사이트의 URL

      • execParams : Object
        execParams: { iphone: { name: 'vincent', age: 5} } => iPhone 앱 실행시 커스텀 URL 뒤에 name=vincent&age=5의 형태로 추가되어 전달됨
        앱 실행시 전달할 파라미터

        • iphone : Object
          iPhone 앱 실행시 전달할 파라미터

        • ipad : Object
          iPad 앱 실행시 전달할 파라미터

        • android : Object
          Android 앱 실행시 전달할 파라미터

      • marketParams : Object
        marketParams: { iphone: { name: 'vincent', age: 5} } => iPhone 앱이 없을 경우 호출되는 설치 URL 뒤에 name=vincent&age=5의 형태로 추가되어 전달됨
        앱 실행시 전달할 파라미터

        • iphone : Object
          iPhone 앱 설치 URL 호출시 전달할 파라미터

        • ipad : Object
          iPad 앱 설치 URL 호출시 전달할 파라미터

        • android : Object
          Android 앱 설치 URL 호출시 전달할 파라미터

    • horizontalButton : Array
      메시지에 표시할 버튼(webButton, appButton)을 수평으로 배치

      • webButton : Object
        메시지에 표시할 버튼: 클릭시 등록한 웹사이트로 이동. 웹사이트를 등록하지 않은 경우 오류 발생.

      • appButton : Object
        메시지에 표시할 버튼: 클릭시 개발자 사이트에 등록한 앱으로 이동. 현재 플랫폼(iOS/Android)에 등록한 앱이 없는 경우 오류 발생.

    • webLink : Object
      메시지에 표시할 하이퍼링크: 클릭시 웹사이트로 이동. 웹사이트를 등록하지 않은 경우 오류 발생.

      • text : String (required)
        하이퍼링크에 표시할 텍스트

      • url : String
        (default: 개발자 사이트에 등록한 웹사이트 중 첫번째 URL)
        이동할 웹사이트의 URL

    • appLink : Object
      메시지에 표시할 하이퍼링크: 클릭시 개발자 사이트에 등록한 앱으로 이동. 현재 플랫폼(iOS/Android)에 등록한 앱이 없는 경우 오류 발생.

      • text : String (required)
        하이퍼링크에 표시할 텍스트

      • webUrl : String
        카카오톡 PC버전에서 버튼을 클릭시 이동할 웹사이트의 URL

      • execParams : Object
        execParams: { iphone: { name: 'vincent', age: 5} } => iPhone 앱 실행시 커스텀 URL 뒤에 name=vincent&age=5의 형태로 추가되어 전달됨
        앱 실행시 전달할 파라미터

        • iphone : Object
          iOS 앱 실행시 전달할 파라미터

        • ipad : Object
          iPad 앱 실행시 전달할 파라미터

        • android : Object
          Android 앱 실행시 전달할 파라미터

      • marketParams : Object
        marketParams: { iphone: { name: 'vincent', age: 5} } => iPhone 앱이 없을 경우 호출되는 설치 URL 뒤에 name=vincent&age=5의 형태로 추가되어 전달됨
        앱 실행시 전달할 파라미터

        • iphone : Object
          iOS 앱 설치 URL 호출시 전달할 파라미터

        • ipad : Object
          iPad 앱 설치 URL 호출시 전달할 파라미터

        • android : Object
          Android 앱 설치 URL 호출시 전달할 파라미터

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

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

  • 카카오링크를 전송합니다.

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

    • label : String
      (constraint: 1000자 이상일 경우, 1000자까지만 전송)
      메시지에 표시할 라벨

    • image : Object
      메시지에 표시할 이미지

      • src : String (required)
        (constraint: 1MB이하의 이미지만 표시됨)
        이미지 URL(RFC2396, RFC1034, RFC1123 를 준수 하지 않는 이미지 url은 이미지가 보이지 않습니다.)

      • width : String | Number (required)
        (constraint: 80 이상이어야 함)
        이미지 너비(픽셀)

      • height : String | Number (required)
        (constraint: 80 이상이어야 함)
        이미지 높이(픽셀)

    • webButton : Object
      메시지에 표시할 버튼: 클릭시 등록한 웹사이트로 이동. 웹사이트를 등록하지 않은 경우 오류 발생.

      • text : String
        (default: "앱으로 가기")
        버튼에 표시할 텍스트

      • url : String
        (default: 개발자 사이트에 등록한 웹사이트 중 첫번째 URL)
        이동할 웹사이트의 URL

    • appButton : Object
      메시지에 표시할 버튼: 클릭시 개발자 사이트에 등록한 앱으로 이동. 현재 플랫폼(iOS/Android)에 등록한 앱이 없는 경우 오류 발생.

      • text : String
        (default: "앱으로 가기")
        버튼에 표시할 텍스트

      • webUrl : String
        카카오톡 PC버전에서 버튼을 클릭시 이동할 웹사이트의 URL

      • execParams : Object
        execParams: { iphone: { name: 'vincent', age: 5} } => iPhone 앱 실행시 커스텀 URL 뒤에 name=vincent&age=5의 형태로 추가되어 전달됨
        앱 실행시 전달할 파라미터

        • iphone : Object
          iPhone 앱 실행시 전달할 파라미터

        • ipad : Object
          iPad 앱 실행시 전달할 파라미터

        • android : Object
          Android 앱 실행시 전달할 파라미터

      • marketParams : Object
        marketParams: { iphone: { name: 'vincent', age: 5} } => iPhone 앱이 없을 경우 호출되는 설치 URL 뒤에 name=vincent&age=5의 형태로 추가되어 전달됨
        앱 실행시 전달할 파라미터

        • iphone : Object
          iPhone 앱 설치 URL 호출시 전달할 파라미터

        • ipad : Object
          iPad 앱 설치 URL 호출시 전달할 파라미터

        • android : Object
          Android 앱 설치 URL 호출시 전달할 파라미터

    • horizontalButton : Array
      메시지에 표시할 버튼(webButton, appButton)을 수평으로 배치

      • webButton : Object
        메시지에 표시할 버튼: 클릭시 등록한 웹사이트로 이동. 웹사이트를 등록하지 않은 경우 오류 발생.

      • appButton : Object
        메시지에 표시할 버튼: 클릭시 개발자 사이트에 등록한 앱으로 이동. 현재 플랫폼(iOS/Android)에 등록한 앱이 없는 경우 오류 발생.

    • webLink : Object
      메시지에 표시할 하이퍼링크: 클릭시 웹사이트로 이동. 웹사이트를 등록하지 않은 경우 오류 발생.

      • text : String (required)
        하이퍼링크에 표시할 텍스트

      • url : String
        (default: 개발자 사이트에 등록한 웹사이트 중 첫번째 URL)
        이동할 웹사이트의 URL

    • appLink : Object
      메시지에 표시할 하이퍼링크: 클릭시 개발자 사이트에 등록한 앱으로 이동. 현재 플랫폼(iOS/Android)에 등록한 앱이 없는 경우 오류 발생.

      • text : String (required)
        하이퍼링크에 표시할 텍스트

      • webUrl : String
        카카오톡 PC버전에서 버튼을 클릭시 이동할 웹사이트의 URL

      • execParams : Object
        execParams: { iphone: { name: 'vincent', age: 5} } => iPhone 앱 실행시 커스텀 URL 뒤에 name=vincent&age=5의 형태로 추가되어 전달됨
        앱 실행시 전달할 파라미터

        • iphone : Object
          iOS 앱 실행시 전달할 파라미터

        • ipad : Object
          iPad 앱 실행시 전달할 파라미터

        • android : Object
          Android 앱 실행시 전달할 파라미터

      • marketParams : Object
        marketParams: { iphone: { name: 'vincent', age: 5} } => iPhone 앱이 없을 경우 호출되는 설치 URL 뒤에 name=vincent&age=5의 형태로 추가되어 전달됨
        앱 실행시 전달할 파라미터

        • iphone : Object
          iOS 앱 설치 URL 호출시 전달할 파라미터

        • ipad : Object
          iPad 앱 설치 URL 호출시 전달할 파라미터

        • android : Object
          Android 앱 설치 URL 호출시 전달할 파라미터

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

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


  • Kakao.API

    카카오 API와 관련된 함수들이 포함되어 있습니다.
    * Kakao.API.request함수는 Promise를 반환합니다.

    각 API에 대한 요청 파라미터와 응답은 REST API와 동일합니다. REST API 간편한 참조
    Kakao.API.request(settings)

    카카오 API를 호출할 수 있습니다. (oauth와 push 관련 API 제외)

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

    • url : String (required)
      호출할 API URL

    • data : Object
      API에 전달할 파라미터

    • files : FileList | Array[File] | Array[Blob]
      파일 첨부가 필요한 API에서 이용하는 파일 파라미터

    • success : Function(resultObj)
      API 호출이 성공할 경우 결과를 받을 콜백 함수

    • fail : Function(errorObj)
      API 호출이 실패할 경우 결과를 받을 콜백 함수

    • always : Function(resultObj | errorObj)
      API 호출이 성공하거나 실패할 경우 항상 호출할 콜백 함수


  • Returns

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

    Kakao.API.cleanup()

    API를 호출하기 위해 사용한 리소스를 해제합니다.


    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 좌표

      • x : 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

    카카오스토리 플러그인들과 관련된 함수들이 포함되어 있습니다.

    Kakao.Story.createShareButton(settings)

    지정한 Element를 클릭할 때 카카오스토리 공유 창이 열리도록 합니다.

    Parameters
  • settings : Object
    카카오스토리 공유 버튼과 관련된 설정을 key/value로 전달합니다.

    • container : String | DOMElement (required)
      DOM Element 또는 Element의 ID Selector를 넘기면, 해당 Element를 클릭할 때 카카오스토리 공유 창이 열립니다.

    • url : String
      (default: 현재 페이지의 URL)
      카카오스토리로 공유할 웹페이지의 URL. 'container' Element의 data-url Attribute로 대신할 수 있습니다.

    • text : String
      (default: 공백)
      공유 창에 표시할 텍스트

  • Kakao.Story.share(settings)

    카카오스토리 웹(web)공유 창을 엽니다.

    Parameters
  • settings : Object
    카카오스토리 공유 버튼과 관련된 설정을 key/value로 전달합니다.

    • url : String
      (default: 현재 페이지의 URL)
      카카오스토리로 공유할 웹페이지의 URL

    • text : String
      (default: 공백)
      공유 창에 표시할 텍스트

  • Kakao.Story.open(settings)

    모바일 환경에서 카카오스토리 App공유 화면을 엽니다.

    Parameters
  • settings : Object
    카카오스토리 공유 버튼과 관련된 설정을 key/value로 전달합니다.

    • url : String
      (default: 현재 페이지의 URL)
      카카오스토리로 공유할 웹페이지의 URL

    • text : String
      (default: 공백)
      공유 창에 표시할 텍스트

    • urlInfo : Object
      위에 입력한 url에 대한 추가적인 정보. 입력하지 않을 경우 스크랩서버가 자동으로 생성해 줌.

      • title : String
        스크랩에 표시되는 제목

      • desc : String
        스크랩에 표시되는 설명

      • name : String
        스크랩에 표시되는 사이트 이름

      • images : Array[String]
        스크랩에 표시되는 대표이지의 URL

  • // 1. 필수 옵션만 사용. 기타 데이터는 스크랩 서버가 생성해줌
    Kakao.Story.open({
        url: 'http://my.share.url.com',
        text: '공유할 텍스트입니다',
    });
    
    // 2. 스크랩된 url 의 메타 정보를 바꾸고 싶을때
    Kakao.Story.open({
        url: 'http://my.share.url.com',
        text: '공유할 텍스트입니다',
        urlInfo: {
            title: '공유한 사이트의 제목',
            desc: '웹 사이트의 설명',
            name: '하단에 표시되는 이름',
            images: ['http://my.image.url']
        }
    });
    
    Kakao.Story.createFollowButton(settings)

    지정한 Element를 클릭할 때 카카오스토리 채널로부터 소식을 받도록 합니다.

    Parameters
  • settings : Object
    카카오스토리 소식받기 버튼과 관련된 설정을 key/value로 전달합니다.

    • container : String | DOMElement (required)
      DOM Element 또는 Element의 ID Selector를 넘기면, 해당 Element를 클릭할 때 지정한 채널을 구독합니다.

    • id : String (required)
      소식을 받을 카카오스토리 채널 ID. ex) kakao

    • showFollowerCount : Boolean
      (default: true)
      구독자 수를 노출합니다. 'container' Element의 data-show-follower-count Attribute로 대신할 수 있습니다.

    • type : String
      'horizontal', 'vertical' (default: 'horizontal')
      구독자 수를 노출할 형태를 정합니다. 'container' Element의 data-type Attribute로 대신할 수 있습니다.

  • Kakao.Story.cleanup()

    카카오스토리 공유 버튼과 관련된 리소스를 해제합니다.


    최종 수정일: 2017-11-28