/ncloud-kakao-alim-api

네이버 NCloud용 카카오톡 알림톡 API

Primary LanguagePHPMIT LicenseMIT

ncloud-kakao-alim-api

저는 영어를 못하는 영알못입니다. 그러므로 번역은 부디 알아서 해주시길..
I can not write English well, so I do not provide English language documentation.
Translation is your part. :-)

네이버 NCloud용 카카오톡 알림톡 API
네이버에서 제공하는 ncloud의 카카오톡 비즈메시지의 알림톡을 쉽게 사용할 수 있게 만든 그누보드 플러그인형 API입니다.

사실 그누보드 호환성만 고려한 것으로, 모듈로 떼어서 사용해도 무방합니다.

본 프로그램은 MIT License를 따르며, PHP 7.x 에서 개발되었으므로, 하위버전의 호환성은 고려하지 않았습니다.

굳이 고려하진 않았지만, 한빛가람의 코드는 대게 PHP 5.2 이상에서도 잘 작동하므로.. 이상 없을거라 생각합니다.

사용 설명서 - 이동마이의 컴퓨터 하루 블로그 ( http://idongmai.wo.tc/640 )

기본 서버 환경

최소 PHP 버전

  • 최소 PHP 버전은 PHP 5.2 이상을 권장합니다.
    • PHP 5.2 버전 미만에서는 그누보드의 안정적인 작동을 보장할 수 없으며,
      일부 함수에서는 함수 지원을 위하여 취약점이 발견되었으므로 사용을 지양합니다.

서버 운영체제

  • 가급적이면 Windows보다 Linux에서 운영되는 편이 더 안정적일 것입니다.

OpenSSL

  • 서버 내에 OpenSSL이 필수로 설치되어 있어야합니다.
  • PHP 모듈에 OpenSSL이 설치되어 있어야 합니다.

cURL

Linux Server 의 경우..

  • 서버 내에 cURL 을(를) 설치해야합니다.
  • PHP에 cURL 확장을 설치해야합니다.
    • cURL 확장에서 OpenSSL을 활성화 시켜야 합니다.

Windows Server 의 경우

  • 서버 내에 cURL 확장을 활성화 시켜야 합니다. 활성화는 php.ini에서 가능합니다.
    • cURL 확장에서 OpenSSL을 활성화 시켜야 합니다.

그누보드 설치 방법

파일 플러그인 폴더 업로드

/plugin/hanbitgaram/nc_alimtalk 을 그누보드 /plugin/ 에 업로드 합니다.
/plugin/hanbitgaram/nc_alimtalk/user_config.php 파일 내에 api키와 설정 값을 집어넣습니다.

파일 extend 폴더 업로드

/extend/ 폴더에 hanbitgaram.ncalimtalk.extend.php 를 업로드합니다.

함수 사용방법

사용방법
ncTalk(String $templateCode, String $PhoneNum, String $content, Array $buttons);

함수 사용 예시

<?php
$templateCode = 'delivery'; // 탬플릿 코드
$phoneNum = '01012345678'; // 받는 이 휴대폰 번호
$content = "안녕하세요. 한빛가람님.
고객님의 주문번호(201810100310234)이 오늘 발송 예정입니다.

물품명 : Applus HackBook 외 3건
주문번호 : 201810100310234
주소 : 사랑광역시 행복구 소망으로가는길로 56길 13, 77호 (화평동)

주문 후 하자품은 이상시 3일 내로 고객센터를 통해 무상 교환해야합니다.
"; // 탬플릿 내용
ncTalk($templateCode, '01012345678', $content); // 알림톡 발송
?>

$buttons 옵션

  • String type
    • 배송조회 - DS
    • 웹 링크 - WL
    • 앱 링크 - AL
    • 봇 키워드 - BK
    • 메시지 전달 - MD
  • String name - 버튼 이름
  • String linkMobile - 모바일 웹 링크
  • String linkPc - PC 웹 링크
  • String schemeIos - 아이폰용 앱 스키마
  • String schemeAndroid - 안드로이드용 앱 스키마

외부 라이브러리 용도 사용방법

상수치환

  • G5_PLUGIN_PATH 은(는) 그누보드의 플러그인 폴더의 절대경로를 의미합니다.
  • G5_PLUGIN_URL 은(는) 그누보드 플러그인 폴더의 웹상 절대주소를 의미합니다.