이제문자보내듯카카오톡의알림톡, 친구톡을오렌지메시지와함께!! 비즈메시지를어려운 API 연동개발없이바로발송!! Orangemsg 알림톡연동매뉴얼 2018 오렌지메시지알림톡연동매뉴얼 orangemsg.com
오렌지메시지알림톡연동메뉴얼 Version 추가 / 수정사항 작성날짜 작성자 V 2.0.0 알림톡매뉴얼작성 2018.01.26 이지용 V 3.0.0 조회서비스추가 2018.05.04 이지용 V 3.1.0 보안서버인증서추가 2018.05.15 이지용
1. 알림톡발송 1. 연동을위한준비사항 오렌지메시지는카카오알림톡메시지를별도의프로그램설치가필요없습니다. 설치없이오렌지메시지웹사이트에서발송하실수있으며, 고객사의서버에서도자동발송이가능하십니다. POST 방식으로최소한의파라미터값만을전송하는방식으로쉽고빠르게이용하실수있습니다. 오렌지메시지를이용한카카오알림톡발송을위해서는 " 카카오검색용아이디 @ 알림톡 " 와사용하실템플릿 알림톡 을카카오톡사전심사를통해인증을받으셔야합니다. 이미플러스친구와승인된템플릿이오렌지메시지에존재한다면다음페이지로이동합니다. 2. 플러스친구생성 플러스친구 구, 옐로아이디 는카카오알림톡발송을하기위한사용자계정입니다. 플러스친구가없는고객님은먼저카카오페이지에서플러스친구를생성해주시기바랍니다. * 플러스친구생성페이지 https://center-pf.kakao.com/ * 오렌지메시지에서템플릿생성하기 http://orangemsg.com/mypage/kakao_code_input.html
3. 템플릿사전심사요청 / 등록하기 알림톡은보내실내용을사전에심사받아승인된경우에만발송이가능합니다. 다음카카오에서의사전심사기간은대략적으로약 1~3일정도가소요됩니다. 4. API key 발급 1 발급 URL : http://orangemsg.com/board/api_inquiry.html 2 API key 발급신청및조회버튼클릭 3 API key는유출되지않도록주의하셔야합니다. 5. 알림톡연동및문자메시지대체발송 1 요청 URL : https://www.apiorange.com/api/send/notice.do 2 method : POST 3 URL Encoding : UTF-8 4 요청변수 5 템플릿번호확인 URL : http://orangemsg.com/board/api_list.html 템플릿하단 API 번호 Authorization tmp_number kakao_sender kakao_phone kakao_name kakao_080 kakao_res 오렌지메세지웹사이트에서발급받은 KEY 템플릿번호 발신번호 수신자번호 알림톡받는고객명 080 무료수신거부 예약발송 오렌지메시지에서확인오렌지메시지에서등록하신번호 N / Y 예약발송인인경우에만 Y
kakao_res_date TRAN_REPLACE_TYPE 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 2017-12-24 07:08:09 예약인경우에만필요 S: SMS, L: LMS 아래의버튼 url 변수값은 url 에변수를사용하시는경우에만필요합니다. ex http://www.orangemsg.com/?id=1 변수값을사용하지않는경우, API 로발송시 orangemsg.com 에서등록하신템플릿에있는버튼 url 이자동으로적용됩니다. kakao_url1_1 kakao_url1_2 kakao_url2_1 kakao_url2_2 kakao_url3_1 kakao_url3_2 모바일링크또는 ios링크 pc링크또는안드로이드링크모바일링크또는 ios링크 pc링크또는안드로이드링크모바일링크또는 ios링크 pc링크또는안드로이드링크 모바일링크사용시필수
kakao_url4_1 kakao_url4_2 kakao_url5_1 kakao_url5_2 모바일링크또는 ios링크 pc링크또는안드로이드링크모바일링크또는 ios링크 pc링크또는안드로이드링크 6. 주의사항 알림톡의총가능문자수는 1,000자입니다. 글자수초과시발송이되지않을수있습니다. 반드시변수포함 1,000자이하로작성해주셔야합니다. 변수내용에는특수문자 "[", "]" 를사용하실수없습니다. 발신번호는반드시오렌지메시지웹사이트에등록된번호여야합니다. 7. 결과코드 JSON 200 401 417 451 428 601 602 OK 비밀번호오류발신키가존재하지않음존재하지않는템플릿등록되지않은발신번호오렌지부족수신자번호가없음 * 전송후성공, 실패등의조회는오렌지메시지웹사이트에서확인이가능하십니다. http://orangemsg.com/mypage/kakao_send_list.html
2. 발송그룹기록조회 1. API key 발급 1 발급 URL : http://orangemsg.com/board/api_inquiry.html 2 API key 발급신청및조회버튼클릭 3 API key는유출되지않도록주의하셔야합니다. 2. 발송메세지조회 1 요청 URL : https://www.apiorange.com/api/inquiry/group.do 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 : 예약건만조회
3. RESPONSE 키 response_code 설명 결과코드 성공 : 200 list date res count replace api group 발송일자 Y : 예약발송 발송건수 대체문자사용여부 L:LMS, M:MMS, S:SMS Y : API 발송 발송그룹번호
결과예제 stdclass Object [response_code] => 200 [list] => Array [0] => stdclass Object [date] => 2018-04-30 10:21:42 [res] => N [count] => 1 [replace] => [api] => N [group] => 1525051302369 [1] => stdclass Object [date] => 2018-04-28 23:38:50 [res] => N [count] => 1 [replace] => [api] => N [group] => 1524926329998 [2] => stdclass Object [date] => 2018-04-28 23:36:30 [res] => N [count] => 1 [replace] => [api] => N [group] => 1524926190139 4. 결과코드 JSON 200 401 402 OK 인증오류 년또는월값의오류
3. 발송리스트기록조회 1. API key 발급 1 발급 URL : http://orangemsg.com/board/api_inquiry.html 2 API key 발급신청및조회버튼클릭 3 API key는유출되지않도록주의하셔야합니다. 2. 발송메세지조회 1 요청 URL : https://www.apiorange.com/api/inquiry/list.do 2 method : POST 3 URL Encoding : UTF-8 4 요청변수 Authorization group type limit api res 오렌지메세지웹사이트에서발급받은 KEY 그룹번호 메세지타입 조회갯수 API 구분 예약구분 group API 에서확보한그룹번호 atalk : 알림톡, ftalk : 친구톡, lms : LMS, mms : MMS, sms : SMS 1~100 개조회 : 0,99 101~200 개조회 : 100,199 Y : API 발송건만조회 Y : 예약건만조회
3. 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 대체문자발송일자 알림톡발송결과코드 발송일자 고객수신번호 대체문자결과코드수신일자 발신번호 알림톡결과코드수신일자 고유번호 대체문자내용
결과예제 stdclass Object [response_code] => 200 [list] => Array [0] => stdclass Object [msg] => 안녕하세요 OO 학원입니다. 임윤아학생의숙제미제출로안내드립니다. - 숙제기간 : CYCLE 5 DAY 5 - 숙제명 : VE review 학원 : 02000-0000 감사합니다. [date] => 2018-04-28 23:38:50 [tmp_number] => 2488 [replace_result_code] => [replace] => L [replace_date_send] => [atalk_result_code] => 1000 [date_send] => 2018-04-28 23:38:50 [phone] => 0102345678 [replace_date_report] => [callback] => 15228330 [date_report] => 2018-04-28 23:38:50 [idx] => 2540561 [replace_msg] => [1] => stdclass Object [msg] => 임윤아학부모님안녕하세요 OO 어학원입니다. 임윤아학생의숙제미제출로안내드립니다. - 숙제기간 : CYCLE 5 DAY 5 - 숙제명 : Creative Writing draft 2 학원 : 02525-7522 감사합니다. [date] => 2018-04-28 23:38:50 [tmp_number] => 2488 [replace_result_code] => [replace] => L [replace_date_send] => [atalk_result_code] => 1000 [date_send] => 2018-04-28 23:38:50 [phone] => 0102345678 [replace_date_report] => [callback] => 15228330 [date_report] => 2018-04-28 23:38:50 [idx] => 2540560 [replace_msg] => [rows] => 2 * 전송결과코드보기 http://orangemsg.com/mypage/kakao_errorcode.html
4. 결과코드 JSON 200 401 600 601 602 OK 인증오류그룹번호오류메세지타입오류쿼리갯수오류
Kakaotalk, Message and Biz Message API ORANGEMSG가함께하겠습니다. 감사합니다. 오렌지메시지사이트담당문의연락처대표번호 : 1522-8330 이메일 : orangemsg@com-home.co.kr 연동및기술관련문의연구원이지용팀장이메일 : developer@com-home.co.kr 주 컴홈서울시송파구오금로17길4 방이동 예인빌딩 2층 TEL. 1522-8330 FAX. 0507-489-3354 orangewave.co.kr orangemsg.com orangesoft.kr