알림톡연동문서ppt_v5.0.1_

Size: px

Start display at page:

Download "알림톡연동문서ppt_v5.0.1_"

한선 호
5 years ago
Views:

1 이제문자보내듯카카오톡의알림톡, 친구톡을오렌지메시지와함께!! 비즈메시지를어려운 API 연동개발없이바로발송!! Orangemsg API 연동메뉴얼 2018 오렌지메시지 API 연동매뉴얼 Copyright c ORANGEMSG Corp. (orangemsg.com)

2 목차 1. 버전안내 요구사항 알림톡발송 알림톡대량발송 친구톡발송 SMS / LMS 발송 발송그룹기록조회 발송리스트기록조회 Copyright c ORANGEMSG Corp. 02

3 1. 오렌지메세지 API 연동메뉴얼 Version 추가 / 수정사항작성날짜작성자 V 알림톡매뉴얼작성 이지용 V 조회서비스추가 이지용 V 보안서버인증서추가 이지용 V SMS, LMS 추가 이지용 V 친구톡, 대량발송추가 박한영 V API 문서수정 박한영 Copyright c ORANGEMSG Corp. 03

4 2. 요구사항 1. API key 발급 1 발급 URL : 2 API key 발급신청및조회버튼클릭 3 API key는유출되지않도록주의하셔야합니다. 2. 발신번호등록 비즈메세지, 각종문자발송시사용하실발신번호를사전에등록하셔야됩니다 비즈메세지선결조건 플러스친구생성플러스친구 ( 구, 옐로아이디 ) 는비즈메세지발송을하기위한사용자계정입니다. 플러스친구가없는고객님은먼저카카오페이지에서플러스친구를생성해주시기바랍니다. * 플러스친구생성페이지 Copyright c ORANGEMSG Corp. 04

5 템플릿등록및승인 1 알림톡, 대량발송템플릿등록 * 알림톡은보내실내용을사전에심사받아승인된경우에만발송이가능합니다. 다음카카오에서의사전심사기간은대략적으로약 1~3일정도가소요됩니다. 2 친구톡템플릿등록 * 별도의승인과정없이바로사용가능합니다. 템플릿번호확인 API 키발급이후에템플릿번호조회가가능합니다. ( 템플릿하단 API 번호 ) 4. 주의사항 비즈메세지 1 총가능문자수는 1,000자입니다. 글자수초과시발송이되지않을수있습니다. 2 변수내용에는특수문자 "[", "]" 를사용하실수없습니다. * 친구톡템플릿에이미지가있을경우가능문자수는 400자입니다. 문자 1 SMS는최대 90byte입니다. LMS는최대 1,000byte입니다. * 90byte 초과시에는자동으로 LMS로발송됩니다. Copyright c ORANGEMSG Corp. 05

6 3. 알림톡발송 알림톡연동 1 요청 URL : 2 method : POST 3 URL Encoding : UTF-8 4 요청변수 Authorization tmp_number kakao_sender kakao_phone kakao_name kakao_080 kakao_res kakao_res_date TRAN_REPLACE_TYPE kakao_add1 kakao_add2 오렌지메세지웹사이트에서발급받은 KEY 템플릿번호 발신번호 수신자번호 알림톡받는고객명 080 무료수신거부 예약발송 예약발송시간 대체문자 추가정보 1 추가정보 2 오렌지메시지에서확인 오렌지메시지에서등록하신번호 N / Y 예약발송인인경우에만 Y :08:09 ( 예약인경우에만필요 ) S:SMS, L:LMS Copyright c ORANGEMSG Corp. 06

7 kakao_add3 kakao_add4 kakao_add5 kakao_add6 kakao_add7 kakao_add8 kakao_add9 kakao_add10 추가정보3 추가정보4 추가정보5 추가정보6 추가정보7 추가정보8 추가정보9 추가정보10 아래의버튼url 변수값은 url에변수를사용하시는경우에만필요합니다. ex) 변수값을사용하지않는경우, API 로발송시 orangemsg.com 에서등록하신템플릿에있는버튼url이자동으로적용됩니다. kakao_url1_1 kakao_url1_2 kakao_url2_1 kakao_url2_2 kakao_url3_1 kakao_url3_2 kakao_url4_1 kakao_url4_2 kakao_url5_1 kakao_url5_2 모바일링크또는 ios링크 pc링크또는안드로이드링크모바일링크또는 ios링크 pc링크또는안드로이드링크모바일링크또는 ios링크 pc링크또는안드로이드링크모바일링크또는 ios링크 pc링크또는안드로이드링크모바일링크또는 ios링크 pc링크또는안드로이드링크 모바일링크사용시필수 Copyright c ORANGEMSG Corp. 07

8 결과코드 (JSON) OK 비밀번호오류발신키가존재하지않음존재하지않는템플릿등록되지않은발신번호오렌지부족수신자번호가없음 * 전송후성공, 실패등의조회는오렌지메시지웹사이트에서확인이가능하십니다. Copyright c ORANGEMSG Corp. 08

9 4. 알림톡대량발송 알림톡대량발송연동 1 요청 URL : 2 method : POST 3 URL Encoding : UTF-8 4 요청변수 ( 특정변수는배열로작성 ) Authorization tmp_number total_ea kakao_sender kakao_phone kakao_name kakao_080 kakao_res kakao_res_date TRAN_REPLACE_TYPE kakao_add1 오렌지메세지웹사이트에서발급받은 KEY 템플릿번호 발송건수 발신번호 수신자번호 알림톡받는고객명 080 무료수신거부 예약발송 예약발송시간 대체문자 추가정보 1 오렌지메시지에서확인 1000 건제한 오렌지메시지에서등록하신번호 N / Y 예약발송인인경우에만 Y :08:09 ( 예약인경우에만필요 ) S:SMS, L:LMS Copyright c ORANGEMSG Corp. 09

10 kakao_add2 kakao_add3 kakao_add4 kakao_add5 kakao_add6 kakao_add7 kakao_add8 kakao_add9 kakao_add10 추가정보2 추가정보3 추가정보4 추가정보5 추가정보6 추가정보7 추가정보8 추가정보9 추가정보10 아래의버튼url 변수값은 url에변수를사용하시는경우에만필요합니다. ex) 변수값을사용하지않는경우, API 로발송시 orangemsg.com 에서등록하신템플릿에있는버튼url이자동으로적용됩니다. kakao_url1_1 kakao_url1_2 kakao_url2_1 kakao_url2_2 kakao_url3_1 kakao_url3_2 kakao_url4_1 kakao_url4_2 kakao_url5_1 kakao_url5_2 모바일링크또는 ios링크 pc링크또는안드로이드링크모바일링크또는 ios링크 pc링크또는안드로이드링크모바일링크또는 ios링크 pc링크또는안드로이드링크모바일링크또는 ios링크 pc링크또는안드로이드링크모바일링크또는 ios링크 pc링크또는안드로이드링크 모바일링크사용시필수 Copyright c ORANGEMSG Corp. 10

11 결과코드 (JSON) OK 비밀번호오류발신키가존재하지않음존재하지않는템플릿등록되지않은발신번호오렌지부족수신자번호가없음 * 전송후성공, 실패등의조회는오렌지메시지웹사이트에서확인이가능하십니다. Copyright c ORANGEMSG Corp. 11

12 5. 친구톡발송 친구톡연동 1 요청 URL : 2 method : POST 3 URL Encoding : UTF-8 4 요청변수 Authorization tmp_number kakao_sender kakao_phone kakao_name kakao_080 kakao_res kakao_res_date TRAN_REPLACE_TYPE kakao_add1 kakao_add2 오렌지메세지웹사이트에서발급받은 KEY 템플릿번호 발신번호 수신자번호 알림톡받는고객명 080 무료수신거부 예약발송 예약발송시간 대체문자 추가정보 1 추가정보 2 오렌지메시지에서확인 오렌지메시지에서등록하신번호 N / Y 예약발송인인경우에만 Y :08:09 ( 예약인경우에만필요 ) S:SMS, L:LMS, M:MMS Copyright c ORANGEMSG Corp. 12

13 kakao_add1 kakao_add2 kakao_add3 kakao_add4 kakao_add5 kakao_add6 kakao_add7 kakao_add8 kakao_add9 kakao_add10 추가정보1 추가정보2 추가정보3 추가정보4 추가정보5 추가정보6 추가정보7 추가정보8 추가정보9 추가정보10 아래의버튼url 변수값은 url에변수를사용하시는경우에만필요합니다. ex) 변수값을사용하지않는경우, API 로발송시 orangemsg.com 에서등록하신템플릿에있는버튼url이자동으로적용됩니다. kakao_url1_1 kakao_url1_2 kakao_url2_1 kakao_url2_2 kakao_url3_1 kakao_url3_2 kakao_url4_1 kakao_url4_2 모바일링크또는 ios링크 pc링크또는안드로이드링크모바일링크또는 ios링크 pc링크또는안드로이드링크모바일링크또는 ios링크 pc링크또는안드로이드링크모바일링크또는 ios링크 pc링크또는안드로이드링크 모바일링크사용시필수 Copyright c ORANGEMSG Corp. 13

14 kakao_url5_1 kakao_url5_2 모바일링크또는 ios 링크 pc 링크또는안드로이드링크 결과코드 (JSON) OK 비밀번호오류발신키가존재하지않음존재하지않는템플릿등록되지않은발신번호오렌지부족수신자번호가없음 * 전송후성공, 실패등의조회는오렌지메시지웹사이트에서확인이가능하십니다. Copyright c ORANGEMSG Corp. 14

15 6. SMS, LMS 발송 SMS, LMS 문자연동 1 요청 URL : 2 method : POST 3 URL Encoding : UTF-8 4 요청변수 Authorization sender name phone subject msg use_reject res_ok res_date 오렌지메세지웹사이트에서발급받은 KEY 발신번호 수신자이름 수신번호 제목 메세지내용 080 무료수신거부 예약발송 예약발송시간 오렌지메시지에서확인 N / Y 예약발송인인경우에만 Y :08:09 ( 예약인경우에만필요 ) Copyright c ORANGEMSG Corp. 15

16 결과코드 (JSON) OK 등록되지않은발신번호오렌지부족수신자번호가없음 * 전송후성공, 실패등의조회는오렌지메시지웹사이트에서확인이가능하십니다. Copyright c ORANGEMSG Corp. 16

17 7. 발송그룹기록조회 발송그룹기록조회연동 1 요청 URL : 2 method : POST 3 URL Encoding : UTF-8 4 요청변수 Authorization type year month api res 오렌지메세지웹사이트에서발급받은 KEY 메세지타입 조회년도 조회월 API 구분 예약구분 atalk : 알림톡, ftalk : 친구톡, lms : LMS, mms : MMS, sms : SMS yyyy mm Y : API 발송건만조회 Y : 예약건만조회 Copyright c ORANGEMSG Corp. 17

18 RESPONSE response_code 키 설명 결과코드 ( 성공 : 200) list date res count replace api group 발송일자 Y : 예약발송 발송건수 대체문자사용여부 ( L:LMS, M:MMS, S:SMS ) Y : API 발송 발송그룹번호 결과코드 (JSON) OK 인증오류 년또는월값의오류 Copyright c ORANGEMSG Corp. 18

19 결과예제 stdclass Object ( [response_code] => 200 [list] => Array ( [0] => stdclass Object ( [date] => :21:42 [res] => N [count] => 1 [replace] => [api] => N [group] => ) ) ) [1] => stdclass Object ( [date] => :38:50 [res] => N [count] => 1 [replace] => [api] => N [group] => ) [2] => stdclass Object ( [date] => :36:30 [res] => N [count] => 1 [replace] => [api] => N [group] => ) Copyright c ORANGEMSG Corp. 19

20 8. 발송리스트기록조회 발송리스트기록조회연동 1 요청 URL : 2 method : POST 3 URL Encoding : UTF-8 4 요청변수 Authorization 오렌지메세지웹사이트에서발급받은 KEY group 그룹번호 group API 에서확보한그룹번호 type limit api res 메세지타입조회갯수 API 구분예약구분 atalk : 알림톡, ftalk : 친구톡, lms : LMS, mms : MMS, sms : SMS 1~100 개조회 : 0,99 101~200 개조회 : 100,199 Y : API 발송건만조회 Y : 예약건만조회 Copyright c ORANGEMSG Corp. 20

21 RESPONSE 키 설명 response_code rows 결과코드 ( 성공 : 200) 총발송수 list msg date tmp_number replace_result_code replace replace_date_send atalk_result_code date_send phone replace_date_report callback date_report idx replace_msg 알림톡내용 발송요청일자 템플릿번호 대체문자발송시결과코드 대체문자사용여부 ( L:LMS, M:MMS, S:SMS ) 대체문자발송일자 알림톡발송결과코드 발송일자 고객수신번호 대체문자결과코드수신일자 발신번호 알림톡결과코드수신일자 고유번호 대체문자내용 Copyright c ORANGEMSG Corp. 21

22 결과예제 stdclass Object ( [response_code] => 200 [list] => Array ( [0] => stdclass Object ( [msg] => 안녕하세요 OO 학원입니다. 임윤아학생의숙제미제출로안내드립니다. - 숙제기간 : CYCLE 5 DAY 5 - 숙제명 : VE review 학원 : 02) 감사합니다. [date] => :38:50 [tmp_number] => 2488 [replace_result_code] => [replace] => L [replace_date_send] => [atalk_result_code] => 1000 [date_send] => :38:50 [phone] => [replace_date_report] => [callback] => [date_report] => :38:50 [idx] => [replace_msg] => ) [1] => stdclass Object ( [msg] => 임윤아학부모님안녕하세요 OO 어학원입니다. 임윤아학생의숙제미제출로안내드립니다. - 숙제기간 : CYCLE 5 DAY 5 - 숙제명 : Creative Writing draft 2 학원 : 02) 감사합니다. [date] => :38:50 [tmp_number] => 2488 [replace_result_code] => [replace] => L [replace_date_send] => [atalk_result_code] => 1000 [date_send] => :38:50 [phone] => [replace_date_report] => [callback] => [date_report] => :38:50 [idx] => [replace_msg] => ) ) ) [rows] => 2 * 전송결과코드보기 Copyright c ORANGEMSG Corp. 22

23 결과코드 (JSON) OK 인증오류그룹번호오류메세지타입오류쿼리갯수오류 * 전송후성공, 실패등의조회는오렌지메시지웹사이트에서확인이가능하십니다. Copyright c ORANGEMSG Corp. 23

24 Kakaotalk, Message and Biz Message API ORANGEMSG가함께하겠습니다. 감사합니다. 오렌지메시지사이트담당문의연락처 대표번호 : 이메일 : orangemsg@com-home.co.kr 연동및기술관련문의연구원박한영이메일 : dp-phy@com-home.co.kr ( 주 ) 컴홈서울시송파구오금로 17 길 4 ( 방이동 ) 예인빌딩 2 층 TEL FAX orangewave.co.kr orangemsg.com orangesoft.kr

알림톡연동문서ppt_v3.1.0_

알림톡연동문서ppt_v3.1.0_ 이제문자보내듯카카오톡의알림톡, 친구톡을오렌지메시지와함께!! 비즈메시지를어려운 API 연동개발없이바로발송!! Orangemsg 알림톡연동매뉴얼 2018 오렌지메시지알림톡연동매뉴얼 orangemsg.com 오렌지메시지알림톡연동메뉴얼 Version 추가 / 수정사항 작성날짜 작성자 V 2.0.0 알림톡매뉴얼작성 2018.01.26 이지용 V 3.0.0 조회서비스추가