[URACLE UMS 2.0]
본 문서는 (주)유라클에서 제공하는 “Uracle UMS”의 연동 API 정의서를 설명하고 있다, 본 문서는 성능 개선, 기능 추가 등의 사항으로 내용이 변경될 수 있다.
개요¶
목적¶
본 문서는 UMS 서비스의 연동을 위한 제반 사항을 기술한다.
호출 방법¶
Receiver Server 에 HTTP (POST) 방식으로 연동 API URL 을 호출 하면 JSON Format으로 결과를 반환 합니다.
예) http://[Receiver IP]:[Receiver Port]/[Controll URL]
실패 처리 방법¶
① 인증키 시간만료 (인증키 요청 API 호출)
HTTP Error code = HTTP/1.1 200 OK
JSON Data parsing
HEADER - RESULT_CODE = 0000
BODY ? AUTHKEY 값 저장 및 이후 서버로 호출 시 항상 파라미터로 사용
PUSH API¶
[PUSH] UMS 회원 발송¶
서비스명 |
PUSH 발송 |
Controller URL |
/api/umsSendPushApi.ums |
||
---|---|---|---|---|---|
METHOD |
multipart/form-data or application/x-www-form-urlencoded |
||||
설명 |
푸시 발송 |
||||
Request (POST 방식 호출) |
|||||
항목 |
타입 |
필수 |
설명 |
||
APP_ID |
String |
Y |
어플리케이션 식별 정보 (패키지명) ex) kr.co.morpheus.mobile1 |
||
TITLE |
String |
N |
|||
PUSH_MSG |
String |
Y |
두 가지 타입 작성. 치환 발송 가능 (아이디, 이름) #{아이디}님 안녕하세요. 유라클 푸시메세지 입니다. |
||
SERVICECODE |
String |
Y |
푸시관리페이지에서 푸시서비스 코드 참조. ex) ALL, PUBLISH, PRIVATE 중 택일, |
||
TYPE |
String |
Y |
AP=>전체 푸시유저 MP=>푸시 가입자 아이디로 타겟팅, OU=>전체조직도유저, AU=>전체UMS회원, MU=>회원 발송. 아이디로 타겟팅, |
||
CUIDS |
String |
Y |
TYPE : MU 일 경우 필수 값.
1. MU일 경우 UMS 등록된 회원아이디 만 보냄.
한건 발송 ex) user1 여러명 발송 ex) [“user1”,”user2”…] 최대 2000명 가능 |
||
SENDERID |
String |
Y |
발송자 정보. 통계정보 사용. Ex) MAILSYSTEM. 제약조건 영문 30byte 이하 문자 |
||
SENDGROUPCODE |
String |
N |
발송자 그룹. 통계정보에 사용됨. EX) SYSTEM |
||
MSG_TYPE |
String |
N |
I: 정보성 메시지, A: 광고성 메시지 중 택일 ex) A |
||
EXT_KIND |
String |
N |
EXT 사용시 사용. 값 : D로 보냄. ex) D |
||
EXT |
String |
N |
푸시메세지를 클릭하여 앱실행시 전달 해줄 메시지. 규격 제한 없음. Ex) {“linkUrl”:”http://xxx.com/index.html”, “imgUrl”:”http://xxx.com/test.jpg”} |
||
DB_IN |
String |
N |
푸시 SUCCESS 테이블에 저장 여부 |
||
KKOALT_SVCID |
String |
N |
[푸시실패시 대체발송 알림톡 설정] 확인: 알림톡과 친구톡은 둘중 하나 택일
LGCNS 톡드림에 등록된 카카오알림톡 서비스아이디 ex)1910028xxxx
|
||
ALLIMTOLK_TEMPLCODE |
String |
N |
카카오알림톡 등록템플릿코드 ex) 10138 |
||
REPLACE_VARS |
String |
N |
카카오알림톡 템플릿 대체발송시 사용. - 알림톡 템플릿에 내용에 #{변수명}과 같은 치환변수가 템플릿 내용에 있을 경우 필수값.
- 메시지 형태 JSON Object
메시지 내용 : 안녕하세요. 결제일은 #{날짜} 입니다. #{금액}이 청구됩니다.
넘겨야 될 파라미터값 : {“#{날짜}”:”2019-07-07”, “#{금액}”:”1,000”}
|
||
FRIENDTOLK_SVCID |
String |
N |
[푸시실패시 대체발송 친구톡 설정]
확인: 알림톡과 친구톡은 둘중 하나 택일
LGCNS 톡드림에 등록된 카카오 친구톡 서비스 아이디 |
||
FRIENDTOLK_MSG |
String |
N |
친구톡 메시지 아이디, 이름은 치환발송 가능함. Ex) 안녕하세요. #{이름}님! 당신의 아이디: #{아이디}로 메일발송함. |
||
PLUS_ID |
String |
N |
카카오톡 플러스친구 아이디 |
||
KKO_IMGFILE_PATH |
MultipartFile |
N |
친구톡 이미지전송. NAS가 있는 경우만 가능. 없을경우 아래의 KKO_IMGFILE를 이용 이미지 사이즈 규격 권장사이즈 : 720px X 720px 제한사이즈 : 가로 500px 미만, 가로:세로 비율이 2:1 미만 이거나 3:4 초과 시 업로드 불가 파일 형식 및 크기 : jpg / 최대 500KB” |
||
KKO_IMGFILE |
String |
N |
친구톡 이미지 전송 UR방식. Ex)http://xxx.com/aaa.jpg.
이미지 사이즈 규격
권장사이즈 : 720px X 720px 제한사이즈 : 가로 500px 미만, 가로:세로 비율이 2:1 미만 이거나 3:4 초과 시 업로드 불가 파일 형식 및 크기 : jpg / 최대 500KB” |
||
KKO_IMG_LINK_URL |
String |
N |
친구톡 이미지 링크주소. |
||
KKO_BTN_LINK1 |
String |
N |
카카오톡 챗버블 버튼 버튼 타입: DS: 배송조회, WL: 웹링크, AL: 앱링크, BK: 봇키워드, MD: 메시지전달
|
||
KKO_BTN_LINK2 |
String |
N |
|||
KKO_BTN_LINK3 |
String |
N |
|||
KKO_BTN_LINK4 |
String |
N |
|||
KKO_BTN_LINK5 |
String |
N |
|||
SMS_TITLE |
String |
N |
MMS문자일 경우 타이틀 |
||
SMS_MSG |
String |
N |
보낼 문자내용. 90byte이상은 MMS로 발송됩니다. |
||
CALLBACK_NUM |
String |
N |
회신번호. SMS대체발송일 경우 필수 |
||
MMS_IMGURL |
String |
N |
MMS일 경우 이미지 URL: http://xxxx.com/sample.jpg |
||
TYPE : 일반발송 응답 메세지 |
|||||
구분 |
항목 |
값 |
필수 |
반복 |
설명 |
HEADER |
RESULTCODE |
String |
Y |
N |
0000 : 응답 성공 그외 : 에러 메시지 |
RESULTMSG |
String |
Y |
N |
OK : 응답 성공 그외 : 에러 메시지 |
|
BODY |
processSeqno |
String |
Y |
발송 시퀀스 고유번호. |
|
pushSendCnt |
int |
Y |
푸시 발송수 |
||
kkoAltCnt |
int |
Y |
카카오 알림톡 발송수 |
||
kkoFrtCnt |
int |
Y |
카카오 친구톡 발송수 |
||
smsCnt |
int |
Y |
문자 발송수 |
||
failCnt |
int |
Y |
실패수 |
||
processInfo |
Object |
Y |
발송진행상태 ex) {“processTxt”: “Completed.”, “processPercent”: “100”} |
연동예시
{ "HEADER": { "RESULTCODE": "0000", "RESULTMSG": "OK" }, "BODY": { "kkoAltCnt": "0", "pushSendCnt": 4, "kkoFrtCnt": "0", "smsCnt": "0", "failCnt": 1, "processInfo": { "processTxt": "Completed.", "processPercent": "100" }, "processSeqno": "202" } }
[PUSH] UMS 회원 / 예약발송¶
서비스명 |
PUSH 발송 |
Controller URL |
/api/umsSendPushApi.ums |
||
---|---|---|---|---|---|
METHOD |
multipart/form-data or application/x-www-form-urlencoded |
||||
설명 |
UMS통합 푸시 예약발송 |
||||
Request (POST 방식 호출) |
|||||
항목 |
타입 |
필수 |
설명 |
||
APP_ID |
String |
Y |
어플리케이션 식별 정보 (패키지명) ex) kr.co.morpheus.mobile1 |
||
TITLE |
String |
N |
|||
PUSH_MSG |
String |
Y |
두 가지 타입 작성. 치환 발송 가능 (아이디, 이름) #{아이디}님 안녕하세요. 유라클 푸시메세지 입니다. |
||
SERVICECODE |
String |
Y |
푸시관리페이지에서 푸시서비스 코드 참조. ex) ALL, PUBLISH, PRIVATE 중 택일, |
||
TYPE |
String |
Y |
AP=>전체 푸시유저 MP=>푸시 가입자 아이디로 타겟팅, OU=>전체조직도유저, AU=>전체UMS회원, MU=>회원 발송. 아이디로 타겟팅, |
||
CUIDS |
String |
Y |
TYPE : MU 일 경우 필수 값.
1. MU일 경우 UMS 등록된 회원아이디로 보냄.
한건 발송 ex) user1 여러명 발송 ex) [“user1”,”user2”…] 최대 2000명 가능 |
||
SENDERID |
String |
Y |
발송자 정보. 통계정보 사용. Ex) MAILSYSTEM. 제약조건 영문 30byte 이하 문자 |
||
SENDGROUPCODE |
String |
N |
발송자 그룹. 통계정보에 사용됨. EX) SYSTEM |
||
MSG_TYPE |
String |
N |
I: 정보성 메시지, A: 광고성 메시지 중 택일 ex) A |
||
RESERVEDATE |
String |
N |
발송예약 날자형식 : YYYY-MM-DD HH:MM |
||
EXT_KIND |
String |
N |
EXT 사용시 사용. 값 : D로 보냄. ex) D |
||
EXT |
String |
N |
푸시메세지를 클릭하여 앱실행시 전달 해줄 메시지. 규격 제한 없음. Ex) {“linkUrl”:”http://xxx.com/index.html”, “imgUrl”:”http://xxx.com/test.jpg”} |
||
DB_IN |
String |
N |
푸시 SUCCESS 테이블에 저장 여부 |
||
KKOALT_SVCID |
String |
N |
[푸시실패시 대체발송 알림톡 설정] 확인: 알림톡과 친구톡은 둘중 하나 택일
LGCNS 톡드림에 등록된 카카오알림톡 서비스아이디 ex)1910028xxxx
|
||
ALLIMTOLK_TEMPLCODE |
String |
N |
카카오알림톡 등록템플릿코드 ex) 10138 |
||
REPLACE_VARS |
String |
N |
카카오알림톡 템플릿 대체발송시 사용. - 알림톡 템플릿에 내용에 #{변수명}과 같은 치환변수가 템플릿 내용에 있을 경우 필수값.
- 메시지 형태 JSON Object
메시지 내용 : 안녕하세요. 결제일은 #{날짜} 입니다. #{금액}이 청구됩니다.
넘겨야 될 파라미터값 : {“#{날짜}”:”2019-07-07”, “#{금액}”:”1,000”}
|
||
FRIENDTOLK_SVCID |
String |
N |
[푸시실패시 대체발송 친구톡 설정]
확인: 알림톡과 친구톡은 둘중 하나 택일
LGCNS 톡드림에 등록된 카카오 친구톡 서비스 아이디 |
||
FRIENDTOLK_MSG |
String |
N |
친구톡 메시지 아이디, 이름은 치환발송 가능함. Ex) 안녕하세요. #{이름}님! 당신의 아이디: #{아이디}로 메일발송함. |
||
PLUS_ID |
String |
N |
카카오톡 플러스친구 아이디 |
||
KKO_IMGFILE_PATH |
MultipartFile |
N |
친구톡 이미지전송. NAS가 있는 경우만 가능. 없을경우 아래의 KKO_IMGFILE를 이용 이미지 사이즈 규격 권장사이즈 : 720px X 720px 제한사이즈 : 가로 500px 미만, 가로:세로 비율이 2:1 미만 이거나 3:4 초과 시 업로드 불가 파일 형식 및 크기 : jpg / 최대 500KB” |
||
KKO_IMGFILE |
String |
N |
친구톡 이미지 전송 UR방식. Ex)http://xxx.com/aaa.jpg.
이미지 사이즈 규격
권장사이즈 : 720px X 720px 제한사이즈 : 가로 500px 미만, 가로:세로 비율이 2:1 미만 이거나 3:4 초과 시 업로드 불가 파일 형식 및 크기 : jpg / 최대 500KB” |
||
KKO_IMG_LINK_URL |
String |
N |
친구톡 이미지 링크주소. |
||
KKO_BTN_LINK1 |
String |
N |
카카오톡 챗버블 버튼 버튼 타입: DS: 배송조회, WL: 웹링크, AL: 앱링크, BK: 봇키워드, MD: 메시지전달
MD 예제 : {“name”:”메세지전달”, “type”:”MD”} |
||
KKO_BTN_LINK2 |
String |
N |
|||
KKO_BTN_LINK3 |
String |
N |
|||
KKO_BTN_LINK4 |
String |
N |
|||
KKO_BTN_LINK5 |
String |
N |
|||
SMS_TITLE |
String |
N |
MMS문자일 경우 타이틀 |
||
SMS_MSG |
String |
N |
보낼 문자내용. 90byte이상은 MMS로 발송됩니다. |
||
CALLBACK_NUM |
String |
N |
회신번호. SMS대체발송일 경우 필수 |
||
MMS_IMGURL |
String |
N |
MMS일 경우 이미지 URL: http://xxxx.com/sample.jpg |
||
TYPE : 일반발송 응답 메세지 |
|||||
구분 |
항목 |
값 |
필수 |
반복 |
설명 |
HEADER |
RESULTCODE |
String |
Y |
N |
0000 : 응답 성공 그외 : 에러 메시지 |
RESULTMSG |
String |
Y |
N |
OK : 응답 성공 그외 : 에러 메시지 |
|
BODY |
reserveSeqno |
String |
Y |
예약발송 시퀀스 고유번호. |
|
processInfo |
Object |
Y |
발송진행상태 ex) {“processTxt”: “Completed.”, “processPercent”: “100”} |
연동예시
{ "HEADER": { "RESULTCODE": "0000", "RESULTMSG": "OK" }, "BODY": { "reserveSeqno": "220", "processInfo": { "processTxt": "Completed.", "processPercent": "100" } } }
[PUSH] UMS 비회원 발송¶
서비스명 |
PUSH 발송 |
Controller URL |
/api/umsSendPushMnApi.ums |
||
---|---|---|---|---|---|
METHOD |
multipart/form-data or application/x-www-form-urlencoded |
||||
설명 |
UMS 비회원 통합 푸시 발송 |
||||
Request (POST 방식 호출) |
|||||
항목 |
타입 |
필수 |
설명 |
||
APP_ID |
String |
Y |
어플리케이션 식별 정보 (패키지명) ex) kr.co.morpheus.mobile1 |
||
TITLE |
String |
N |
|||
PUSH_MSG |
String |
Y |
두 가지 타입 작성. 치환 발송 가능 (아이디, 이름) #{아이디}님 안녕하세요. 유라클 푸시메세지 입니다. |
||
SERVICECODE |
String |
Y |
푸시관리페이지에서 푸시서비스 코드 참조. ex) ALL, PUBLISH, PRIVATE 중 택일, |
||
CUIDS |
String |
Y |
한 명 : ex) {“user1”:[“핸드폰번호”,이름””]}
여러명 ex) {“user1”:[“핸드폰번호”,이름””], “user1”:[“핸드폰번호”,이름””]…}
확인 : 반드시 핸드폰번호는 – 없이 숫자만 입력해 주세요. |
||
SENDERID |
String |
Y |
발송자 정보. 통계정보 사용. Ex) MAILSYSTEM. 제약조건 영문 30byte 이하 문자 |
||
SENDGROUPCODE |
String |
N |
발송자 그룹. 통계정보에 사용됨. EX) SYSTEM |
||
MSG_TYPE |
String |
N |
I: 정보성 메시지, A: 광고성 메시지 중 택일 ex) A |
||
EXT_KIND |
String |
N |
EXT 사용시 사용. 값 : D로 보냄. ex) D |
||
EXT |
String |
N |
푸시메세지를 클릭하여 앱실행시 전달 해줄 메시지. 규격 제한 없음. Ex) {“linkUrl”:”http://xxx.com/index.html”, “imgUrl”:”http://xxx.com/test.jpg”} |
||
DB_IN |
String |
N |
푸시 SUCCESS 테이블에 저장 여부 |
||
KKOALT_SVCID |
String |
N |
[푸시실패시 대체발송 알림톡 설정] 확인: 알림톡과 친구톡은 둘중 하나 택일
LGCNS 톡드림에 등록된 카카오알림톡 서비스아이디 ex)1910028xxxx
|
||
ALLIMTOLK_TEMPLCODE |
String |
N |
카카오알림톡 등록템플릿코드 ex) 10138 |
||
REPLACE_VARS |
String |
N |
카카오알림톡 템플릿 대체발송시 사용. - 알림톡 템플릿에 내용에 #{변수명}과 같은 치환변수가 템플릿 내용에 있을 경우 필수값.
- 메시지 형태 JSON Object
메시지 내용 : 안녕하세요. 결제일은 #{날짜} 입니다. #{금액}이 청구됩니다.
넘겨야 될 파라미터값 : {“#{날짜}”:”2019-07-07”, “#{금액}”:”1,000”}
|
||
FRIENDTOLK_SVCID |
String |
N |
[푸시실패시 대체발송 친구톡 설정]
확인: 알림톡과 친구톡은 둘중 하나 택일
LGCNS 톡드림에 등록된 카카오 친구톡 서비스 아이디 |
||
FRIENDTOLK_MSG |
String |
N |
친구톡 메시지 아이디, 이름은 치환발송 가능함. Ex) 안녕하세요. #{이름}님! 당신의 아이디: #{아이디}로 메일발송함. |
||
PLUS_ID |
String |
N |
카카오톡 플러스친구 아이디 |
||
KKO_IMGFILE_PATH |
MultipartFile |
N |
친구톡 이미지전송. NAS가 있는 경우만 가능. 없을경우 아래의 KKO_IMGFILE를 이용 이미지 사이즈 규격 권장사이즈 : 720px X 720px 제한사이즈 : 가로 500px 미만, 가로:세로 비율이 2:1 미만 이거나 3:4 초과 시 업로드 불가 파일 형식 및 크기 : jpg / 최대 500KB” |
||
KKO_IMGFILE |
String |
N |
친구톡 이미지 전송 UR방식. Ex)http://xxx.com/aaa.jpg.
이미지 사이즈 규격
권장사이즈 : 720px X 720px 제한사이즈 : 가로 500px 미만, 가로:세로 비율이 2:1 미만 이거나 3:4 초과 시 업로드 불가 파일 형식 및 크기 : jpg / 최대 500KB” |
||
KKO_IMG_LINK_URL |
String |
N |
친구톡 이미지 링크주소. |
||
KKO_BTN_LINK1 |
String |
N |
카카오톡 챗버블 버튼 버튼 타입: DS: 배송조회, WL: 웹링크, AL: 앱링크, BK: 봇키워드, MD: 메시지전달
MD 예제 : {“name”:”메세지전달”, “type”:”MD”} |
||
KKO_BTN_LINK2 |
String |
N |
|||
KKO_BTN_LINK3 |
String |
N |
|||
KKO_BTN_LINK4 |
String |
N |
|||
KKO_BTN_LINK5 |
String |
N |
|||
SMS_TITLE |
String |
N |
MMS문자일 경우 타이틀 |
||
SMS_MSG |
String |
N |
보낼 문자내용. 90byte이상은 MMS로 발송됩니다. |
||
CALLBACK_NUM |
String |
N |
회신번호. SMS대체발송일 경우 필수 |
||
MMS_IMGURL |
String |
N |
MMS일 경우 이미지 URL: http://xxxx.com/sample.jpg |
||
TYPE : 일반발송 응답 메세지 |
|||||
구분 |
항목 |
값 |
필수 |
반복 |
설명 |
HEADER |
RESULTCODE |
String |
Y |
N |
0000 : 응답 성공 그외 : 에러 메시지 |
RESULTMSG |
String |
Y |
N |
OK : 응답 성공 그외 : 에러 메시지 |
|
BODY |
processSeqno |
String |
Y |
발송 시퀀스 고유번호. |
|
pushSendCnt |
int |
Y |
푸시 발송수 |
||
kkoAltCnt |
int |
Y |
카카오 알림톡 발송수 |
||
kkoFrtCnt |
int |
Y |
카카오 친구톡 발송수 |
||
smsCnt |
int |
Y |
문자 발송수 |
||
failCnt |
int |
Y |
실패수 |
||
processInfo |
Object |
Y |
발송진행상태 ex) {“processTxt”: “Completed.”, “processPercent”: “100”} |
연동예시
{ "HEADER": { "RESULTCODE": "0000", "RESULTMSG": "OK" }, "BODY": { "kkoAltCnt": "0", "pushSendCnt": 4, "kkoFrtCnt": "0", "smsCnt": "0", "failCnt": 1, "processInfo": { "processTxt": "Completed.", "processPercent": "100" }, "processSeqno": "202" } }
[PUSH] UMS 비회원 / 예약발송¶
서비스명 |
PUSH 발송 |
Controller URL |
/api/umsSendPushMnApi.ums |
||
---|---|---|---|---|---|
METHOD |
multipart/form-data or application/x-www-form-urlencoded |
||||
설명 |
UMS비회원 통합 푸시 예약발송 |
||||
Request (POST 방식 호출) |
|||||
항목 |
타입 |
필수 |
설명 |
||
APP_ID |
String |
Y |
어플리케이션 식별 정보 (패키지명) ex) kr.co.morpheus.mobile1 |
||
TITLE |
String |
N |
|||
PUSH_MSG |
String |
Y |
두 가지 타입 작성. 치환 발송 가능 (아이디, 이름) #{아이디}님 안녕하세요. 유라클 푸시메세지 입니다. |
||
SERVICECODE |
String |
Y |
푸시관리페이지에서 푸시서비스 코드 참조. ex) ALL, PUBLISH, PRIVATE 중 택일, |
||
CUIDS |
String |
Y |
한 명 : ex) {“아이디”:[“핸드폰번호”,이름””]}
여러명 ex) {“아이디”:[“핸드폰번호”,이름””], “아이디”:[“핸드폰번호”,이름””]…}
P.S:핸드폰번호 : 0001234567 숫자만 입력 확인 : 반드시 핸드폰번호는 – 없이 숫자만 입력해 주세요. |
||
SENDERID |
String |
Y |
발송자 정보. 통계정보 사용. Ex) MAILSYSTEM. 제약조건 영문 30byte 이하 문자 |
||
SENDGROUPCODE |
String |
N |
발송자 그룹. 통계정보에 사용됨. EX) SYSTEM |
||
MSG_TYPE |
String |
N |
I: 정보성 메시지, A: 광고성 메시지 중 택일 ex) A |
||
RESERVEDATE |
String |
N |
발송예약 날자형식 : YYYY-MM-DD HH:MM |
||
EXT_KIND |
String |
N |
EXT 사용시 사용. 값 : D로 보냄. ex) D |
||
EXT |
String |
N |
푸시메세지를 클릭하여 앱실행시 전달 해줄 메시지. 규격 제한 없음. Ex) {“linkUrl”:”http://xxx.com/index.html”, “imgUrl”:”http://xxx.com/test.jpg”} |
||
DB_IN |
String |
N |
푸시 SUCCESS 테이블에 저장 여부 |
||
KKOALT_SVCID |
String |
N |
[푸시실패시 대체발송 알림톡 설정] 확인: 알림톡과 친구톡은 둘중 하나 택일
LGCNS 톡드림에 등록된 카카오알림톡 서비스아이디 ex)1910028xxxx
|
||
ALLIMTOLK_TEMPLCODE |
String |
N |
카카오알림톡 등록템플릿코드 ex) 10138 |
||
REPLACE_VARS |
String |
N |
카카오알림톡 템플릿 대체발송시 사용. - 알림톡 템플릿에 내용에 #{변수명}과 같은 치환변수가 템플릿 내용에 있을 경우 필수값.
- 메시지 형태 JSON Object
메시지 내용 : 안녕하세요. 결제일은 #{날짜} 입니다. #{금액}이 청구됩니다.
넘겨야 될 파라미터값 : {“#{날짜}”:”2019-07-07”, “#{금액}”:”1,000”}
|
||
FRIENDTOLK_SVCID |
String |
N |
[푸시실패시 대체발송 친구톡 설정]
확인: 알림톡과 친구톡은 둘중 하나 택일
LGCNS 톡드림에 등록된 카카오 친구톡 서비스 아이디 |
||
FRIENDTOLK_MSG |
String |
N |
친구톡 메시지 아이디, 이름은 치환발송 가능함. Ex) 안녕하세요. #{이름}님! 당신의 아이디: #{아이디}로 메일발송함. |
||
PLUS_ID |
String |
N |
카카오톡 플러스친구 아이디 |
||
KKO_IMGFILE_PATH |
MultipartFile |
N |
친구톡 이미지전송. NAS가 있는 경우만 가능. 없을경우 아래의 KKO_IMGFILE를 이용 이미지 사이즈 규격 권장사이즈 : 720px X 720px 제한사이즈 : 가로 500px 미만, 가로:세로 비율이 2:1 미만 이거나 3:4 초과 시 업로드 불가 파일 형식 및 크기 : jpg / 최대 500KB” |
||
KKO_IMGFILE |
String |
N |
친구톡 이미지 전송 UR방식. Ex)http://xxx.com/aaa.jpg.
이미지 사이즈 규격
권장사이즈 : 720px X 720px 제한사이즈 : 가로 500px 미만, 가로:세로 비율이 2:1 미만 이거나 3:4 초과 시 업로드 불가 파일 형식 및 크기 : jpg / 최대 500KB” |
||
KKO_IMG_LINK_URL |
String |
N |
친구톡 이미지 링크주소. |
||
KKO_BTN_LINK1 |
String |
N |
카카오톡 챗버블 버튼 버튼 타입: DS: 배송조회, WL: 웹링크, AL: 앱링크, BK: 봇키워드, MD: 메시지전달
MD 예제 : {“name”:”메세지전달”, “type”:”MD”} |
||
KKO_BTN_LINK2 |
String |
N |
|||
KKO_BTN_LINK3 |
String |
N |
|||
KKO_BTN_LINK4 |
String |
N |
|||
KKO_BTN_LINK5 |
String |
N |
|||
SMS_TITLE |
String |
N |
MMS문자일 경우 타이틀 |
||
SMS_MSG |
String |
N |
보낼 문자내용. 90byte이상은 MMS로 발송됩니다. |
||
CALLBACK_NUM |
String |
N |
회신번호. SMS대체발송일 경우 필수 |
||
MMS_IMGURL |
String |
N |
MMS일 경우 이미지 URL: http://xxxx.com/sample.jpg |
||
TYPE : 일반발송 응답 메세지 |
|||||
구분 |
항목 |
값 |
필수 |
반복 |
설명 |
HEADER |
RESULTCODE |
String |
Y |
N |
0000 : 응답 성공 그외 : 에러 메시지 |
RESULTMSG |
String |
Y |
N |
OK : 응답 성공 그외 : 에러 메시지 |
|
BODY |
reserveSeqno |
String |
Y |
예약발송 시퀀스 고유번호. |
|
processInfo |
Object |
Y |
발송진행상태 ex) {“processTxt”: “Completed.”, “processPercent”: “100”} |
연동예시
{ "HEADER": { "RESULTCODE": "0000", "RESULTMSG": "OK" }, "BODY": { "reserveSeqno": "220", "processInfo": { "processTxt": "Completed.", "processPercent": "100" } } }
[PUSH] UMS 회원 / CSV발송¶
서비스명 |
PUSH 발송 |
Controller URL |
/api/csvSendPushApi.ums |
||
---|---|---|---|---|---|
METHOD |
multipart/form-data or application/x-www-form-urlencoded |
||||
설명 |
UMS회원 푸시 CSV발송 (대량, 개별화메세지) |
||||
Request (POST 방식 호출) |
|||||
항목 |
타입 |
필수 |
설명 |
||
APP_ID |
String |
Y |
어플리케이션 식별 정보 (패키지명) ex) kr.co.morpheus.mobile1 |
||
TITLE |
String |
N |
|||
PUSH_MSG |
String |
Y |
두 가지 타입 작성. 치환 발송 가능 (아이디, 이름) #{아이디}님 안녕하세요. 유라클 푸시메세지 입니다. |
||
SERVICECODE |
String |
Y |
푸시관리페이지에서 푸시서비스 코드 참조. ex) ALL, PUBLISH, PRIVATE 중 택일, |
||
CSVFILE |
MultipartFile |
Y |
CSV파일을 만들어 첨부한다.
P.S : 1번째 라인 컬럼정보, 2번째 라인부터 데이터
확인 : 푸시만 발송시에는 #{아이디} 하나만 넣어도 됨.
#{이름}, #{핸드폰번호} 생략가능. 회원정보에서 가져옴.
예1) csv파일 비 개인화
#{아이디} 첫번째라인 컬럼정보 헤드
user1
User2 예 2) 개인화 처리 CSV파일 만들기
#{아이디}, #{날자}, #{금액}
user1, 2019-05-01, 4,000
User2, 2019-05-04, 10,000 |
||
SENDERID |
String |
Y |
발송자 정보. 통계정보 사용. Ex) MAILSYSTEM. 제약조건 영문 30byte 이하 문자 |
||
SENDGROUPCODE |
String |
N |
발송자 그룹. 통계정보에 사용됨. EX) SYSTEM |
||
MSG_TYPE |
String |
N |
I: 정보성 메시지, A: 광고성 메시지 중 택일 ex) A |
||
EXT_KIND |
String |
N |
EXT 사용시 사용. 값 : D로 보냄. ex) D |
||
EXT |
String |
N |
푸시메세지를 클릭하여 앱실행시 전달 해줄 메시지. 규격 제한 없음. Ex) {“linkUrl”:”http://xxx.com/index.html”, “imgUrl”:”http://xxx.com/test.jpg”} |
||
DB_IN |
String |
N |
푸시 SUCCESS 테이블에 저장 여부 |
||
KKOALT_SVCID |
String |
N |
[푸시실패시 대체발송 알림톡 설정] 확인: 알림톡과 친구톡은 둘중 하나 택일
LGCNS 톡드림에 등록된 카카오알림톡 서비스아이디 ex)1910028xxxx
|
||
ALLIMTOLK_TEMPLCODE |
String |
N |
카카오알림톡 등록템플릿코드 ex) 10138 |
||
FRIENDTOLK_SVCID |
String |
N |
[푸시실패시 대체발송 친구톡 설정]
확인: 알림톡과 친구톡은 둘중 하나 택일
LGCNS 톡드림에 등록된 카카오 친구톡 서비스 아이디 |
||
FRIENDTOLK_MSG |
String |
N |
친구톡 메시지 아이디, 이름은 치환발송 가능함. Ex) 안녕하세요. #{이름}님! 당신의 아이디: #{아이디}로 메일발송함. |
||
PLUS_ID |
String |
N |
카카오톡 플러스친구 아이디 |
||
KKO_IMGFILE_PATH |
MultipartFile |
N |
친구톡 이미지전송. NAS가 있는 경우만 가능. 없을경우 아래의 KKO_IMGFILE를 이용 이미지 사이즈 규격 권장사이즈 : 720px X 720px 제한사이즈 : 가로 500px 미만, 가로:세로 비율이 2:1 미만 이거나 3:4 초과 시 업로드 불가 파일 형식 및 크기 : jpg / 최대 500KB” |
||
KKO_IMGFILE |
String |
N |
친구톡 이미지 전송 UR방식. Ex)http://xxx.com/aaa.jpg.
이미지 사이즈 규격
권장사이즈 : 720px X 720px 제한사이즈 : 가로 500px 미만, 가로:세로 비율이 2:1 미만 이거나 3:4 초과 시 업로드 불가 파일 형식 및 크기 : jpg / 최대 500KB” |
||
KKO_IMG_LINK_URL |
String |
N |
친구톡 이미지 링크주소. |
||
KKO_BTN_LINK1 |
String |
N |
카카오톡 챗버블 버튼 버튼 타입: DS: 배송조회, WL: 웹링크, AL: 앱링크, BK: 봇키워드, MD: 메시지전달
MD 예제 : {“name”:”메세지전달”, “type”:”MD”} |
||
KKO_BTN_LINK2 |
String |
N |
|||
KKO_BTN_LINK3 |
String |
N |
|||
KKO_BTN_LINK4 |
String |
N |
|||
KKO_BTN_LINK5 |
String |
N |
|||
SMS_TITLE |
String |
N |
MMS문자일 경우 타이틀 |
||
SMS_MSG |
String |
N |
보낼 문자내용. 90byte이상은 MMS로 발송됩니다. |
||
CALLBACK_NUM |
String |
N |
회신번호. SMS대체발송일 경우 필수 |
||
MMS_IMGURL |
String |
N |
MMS일 경우 이미지 URL: http://xxxx.com/sample.jpg |
||
TYPE : 일반발송 응답 메세지 |
|||||
구분 |
항목 |
값 |
필수 |
반복 |
설명 |
HEADER |
RESULTCODE |
String |
Y |
N |
0000 : 응답 성공 그외 : 에러 메시지 |
RESULTMSG |
String |
Y |
N |
OK : 응답 성공 그외 : 에러 메시지 |
|
BODY |
processSeqno |
String |
Y |
발송 시퀀스 고유번호. |
|
pushSendCnt |
int |
Y |
푸시 발송수 |
||
kkoAltCnt |
int |
Y |
카카오 알림톡 발송수 |
||
kkoFrtCnt |
int |
Y |
카카오 친구톡 발송수 |
||
smsCnt |
int |
Y |
문자 발송수 |
||
failCnt |
int |
Y |
실패수 |
||
processInfo |
Object |
Y |
발송진행상태 ex) {“processTxt”: “Completed.”, “processPercent”: “100”} |
연동예시
{ "HEADER": { "RESULTCODE": "0000", "RESULTMSG": "OK" }, "BODY": { "kkoAltCnt": "0", "pushSendCnt": 4, "kkoFrtCnt": "0", "smsCnt": "0", "failCnt": 1, "processInfo": { "processTxt": "Completed.", "processPercent": "100" }, "processSeqno": "202" } }
[PUSH] UMS 회원 / CSV 예약발송¶
서비스명 |
PUSH 발송 |
Controller URL |
/api/csvSendPushApi.ums |
||
---|---|---|---|---|---|
METHOD |
multipart/form-data or application/x-www-form-urlencoded |
||||
설명 |
UMS회원 푸시 CSV예약발송 (대량, 개별화메세지) |
||||
Request (POST 방식 호출) |
|||||
항목 |
타입 |
필수 |
설명 |
||
APP_ID |
String |
Y |
어플리케이션 식별 정보 (패키지명) ex) kr.co.morpheus.mobile1 |
||
TITLE |
String |
N |
|||
PUSH_MSG |
String |
Y |
두 가지 타입 작성. 치환 발송 가능 (아이디, 이름) #{아이디}님 안녕하세요. 유라클 푸시메세지 입니다. |
||
SERVICECODE |
String |
Y |
푸시관리페이지에서 푸시서비스 코드 참조. ex) ALL, PUBLISH, PRIVATE 중 택일, |
||
CSVFILE |
MultipartFile |
Y |
CSV파일을 만들어 첨부한다.
P.S : 1번째 라인 컬럼정보, 2번째 라인부터 데이터
확인 : 푸시만 발송시에는 #{아이디} 하나만 넣으면 됨. 이름, 핸드폰 번호 회원정보에서 가져옴.
예1) csv파일 비 개인화
#{아이디} 첫번째라인 컬럼정보 헤드
user1
User2 예 2) 개인화 처리 CSV파일 만들기
#{아이디}} , #{날자}, #{금액}
user1, 2019-05-01, 4,000
User2, 2019-05-04, 10,000 |
||
SENDERID |
String |
Y |
발송자 정보. 통계정보 사용. Ex) MAILSYSTEM. 제약조건 영문 30byte 이하 문자 |
||
SENDGROUPCODE |
String |
N |
발송자 그룹. 통계정보에 사용됨. EX) SYSTEM |
||
MSG_TYPE |
String |
N |
I: 정보성 메시지, A: 광고성 메시지 중 택일 ex) A |
||
RESERVEDATE |
String |
N |
발송예약 날자형식 : YYYY-MM-DD HH:MM . |
||
EXT_KIND |
String |
N |
EXT 사용시 사용. 값 : D로 보냄. ex) D |
||
EXT |
String |
N |
푸시메세지를 클릭하여 앱실행시 전달 해줄 메시지. 규격 제한 없음. Ex) {“linkUrl”:”http://xxx.com/index.html”, “imgUrl”:”http://xxx.com/test.jpg”} |
||
DB_IN |
String |
N |
푸시 SUCCESS 테이블에 저장 여부 |
||
KKOALT_SVCID |
String |
N |
[푸시실패시 대체발송 알림톡 설정] 확인: 알림톡과 친구톡은 둘중 하나 택일
LGCNS 톡드림에 등록된 카카오알림톡 서비스아이디 ex)1910028xxxx
|
||
ALLIMTOLK_TEMPLCODE |
String |
N |
카카오알림톡 등록템플릿코드 ex) 10138 |
||
FRIENDTOLK_SVCID |
String |
N |
[푸시실패시 대체발송 친구톡 설정]
확인: 알림톡과 친구톡은 둘중 하나 택일
LGCNS 톡드림에 등록된 카카오 친구톡 서비스 아이디 |
||
FRIENDTOLK_MSG |
String |
N |
친구톡 메시지 아이디, 이름은 치환발송 가능함. Ex) 안녕하세요. #{이름}님! 당신의 아이디: #{아이디}로 메일발송함. |
||
PLUS_ID |
String |
N |
카카오톡 플러스친구 아이디 |
||
KKO_IMGFILE_PATH |
MultipartFile |
N |
친구톡 이미지전송. NAS가 있는 경우만 가능. 없을경우 아래의 KKO_IMGFILE를 이용 이미지 사이즈 규격 권장사이즈 : 720px X 720px 제한사이즈 : 가로 500px 미만, 가로:세로 비율이 2:1 미만 이거나 3:4 초과 시 업로드 불가 파일 형식 및 크기 : jpg / 최대 500KB” |
||
KKO_IMGFILE |
String |
N |
친구톡 이미지 전송 UR방식. Ex)http://xxx.com/aaa.jpg.
이미지 사이즈 규격
권장사이즈 : 720px X 720px 제한사이즈 : 가로 500px 미만, 가로:세로 비율이 2:1 미만 이거나 3:4 초과 시 업로드 불가 파일 형식 및 크기 : jpg / 최대 500KB” |
||
KKO_IMG_LINK_URL |
String |
N |
친구톡 이미지 링크주소. |
||
KKO_BTN_LINK1 |
String |
N |
카카오톡 챗버블 버튼 버튼 타입: DS: 배송조회, WL: 웹링크, AL: 앱링크, BK: 봇키워드, MD: 메시지전달
MD 예제 : {“name”:”메세지전달”, “type”:”MD”} |
||
KKO_BTN_LINK2 |
String |
N |
|||
KKO_BTN_LINK3 |
String |
N |
|||
KKO_BTN_LINK4 |
String |
N |
|||
KKO_BTN_LINK5 |
String |
N |
|||
SMS_TITLE |
String |
N |
MMS문자일 경우 타이틀 |
||
SMS_MSG |
String |
N |
보낼 문자내용. 90byte이상은 MMS로 발송됩니다. |
||
CALLBACK_NUM |
String |
N |
회신번호. SMS대체발송일 경우 필수 |
||
MMS_IMGURL |
String |
N |
MMS일 경우 이미지 URL: http://xxxx.com/sample.jpg |
||
TYPE : 일반발송 응답 메세지 |
|||||
구분 |
항목 |
값 |
필수 |
반복 |
설명 |
HEADER |
RESULTCODE |
String |
Y |
N |
0000 : 응답 성공 그외 : 에러 메시지 |
RESULTMSG |
String |
Y |
N |
OK : 응답 성공 그외 : 에러 메시지 |
|
BODY |
reserveSeqno |
String |
Y |
예약발송 시퀀스 고유번호. |
|
processInfo |
Object |
Y |
발송진행상태 ex) {“processTxt”: “Completed.”, “processPercent”: “100”} |
연동예시
{ "HEADER": { "RESULTCODE": "0000", "RESULTMSG": "OK" }, "BODY": { "reserveSeqno": "220", "processInfo": { "processTxt": "Completed.", "processPercent": "100" } } }
[PUSH] UMS 비회원 / CSV 발송 (대량발송 or 치환발송)¶
서비스명 |
PUSH 발송 |
Controller URL |
/api/csvSendPushMnApi.ums |
||
---|---|---|---|---|---|
METHOD |
multipart/form-data or application/x-www-form-urlencoded |
||||
설명 |
UMS비회원 푸시 CSV발송 (대량, 개별화메세지) |
||||
Request (POST 방식 호출) |
|||||
항목 |
타입 |
필수 |
설명 |
||
APP_ID |
String |
Y |
어플리케이션 식별 정보 (패키지명) ex) kr.co.morpheus.mobile1 |
||
TITLE |
String |
N |
|||
PUSH_MSG |
String |
Y |
두 가지 타입 작성. 치환 발송 가능 (아이디, 이름) #{아이디}님 안녕하세요. 유라클 푸시메세지 입니다. |
||
SERVICECODE |
String |
Y |
푸시관리페이지에서 푸시서비스 코드 참조. ex) ALL, PUBLISH, PRIVATE 중 택일, |
||
CSVFILE |
MultipartFile |
Y |
CSV파일을 만들어 첨부한다.
P.S : 1번째 라인 컬럼정보, 2번째 라인부터 데이터
확인 : 발송시에는 #{아이디},#{이름}, #{핸드폰번호} 반드시 넣어야 함. 예1) csv파일 비 개인화
#{아이디}, #{이름}, #{핸드폰번호} 첫번째라인 컬럼정보 헤드
user1, 홍길동1, 01000011111
User2, 홍길동2, 01000002222 예 2) 개인화 처리 CSV파일 만들기
#{아이디}, #{이름}, #{핸드폰번호}, #{날자}, #{금액}
user1, 홍길동1, 01000011111, 2019-05-01, 4,000
User2, 홍길동1, 01000011111, 2019-05-04, 10,000 확인 : 반드시 핸드폰번호는 – 없이 숫자만 입력해 주세요. |
||
SENDERID |
String |
Y |
발송자 정보. 통계정보 사용. Ex) MAILSYSTEM. 제약조건 영문 30byte 이하 문자 |
||
SENDGROUPCODE |
String |
N |
발송자 그룹. 통계정보에 사용됨. EX) SYSTEM |
||
MSG_TYPE |
String |
N |
I: 정보성 메시지, A: 광고성 메시지 중 택일 ex) A |
||
EXT_KIND |
String |
N |
EXT 사용시 사용. 값 : D로 보냄. ex) D |
||
EXT |
String |
N |
푸시메세지를 클릭하여 앱실행시 전달 해줄 메시지. 규격 제한 없음. Ex) {“linkUrl”:”http://xxx.com/index.html”, “imgUrl”:”http://xxx.com/test.jpg”} |
||
DB_IN |
String |
N |
푸시 SUCCESS 테이블에 저장 여부 |
||
KKOALT_SVCID |
String |
N |
[푸시실패시 대체발송 알림톡 설정] 확인: 알림톡과 친구톡은 둘 중 하나 택일
LGCNS 톡드림에 등록된 카카오알림톡 서비스아이디 ex)1910028xxxx
|
||
ALLIMTOLK_TEMPLCODE |
String |
N |
카카오알림톡 등록템플릿코드 ex) 10138 |
||
FRIENDTOLK_SVCID |
String |
N |
[푸시실패시 대체발송 카카오톡 설정]
확인: 알림톡과 친구톡은 둘 중 하나 택일
LGCNS 톡드림에 등록된 카카오 친구톡 서비스 아이디 |
||
FRIENDTOLK_MSG |
String |
N |
친구톡 메시지 아이디, 이름은 치환발송 가능함. Ex) 안녕하세요. #{이름}님! 당신의 아이디: #{아이디}로 메일발송함. |
||
PLUS_ID |
String |
N |
카카오톡 플러스친구 아이디 |
||
KKO_IMGFILE_PATH |
MultipartFile |
N |
친구톡 이미지전송. NAS가 있는 경우만 가능. 없을경우 아래의 KKO_IMGFILE를 이용 이미지 사이즈 규격 권장사이즈 : 720px X 720px 제한사이즈 : 가로 500px 미만, 가로:세로 비율이 2:1 미만 이거나 3:4 초과 시 업로드 불가 파일 형식 및 크기 : jpg / 최대 500KB” |
||
KKO_IMGFILE |
String |
N |
친구톡 이미지 전송 UR방식. Ex)http://xxx.com/aaa.jpg.
이미지 사이즈 규격
권장사이즈 : 720px X 720px 제한사이즈 : 가로 500px 미만, 가로:세로 비율이 2:1 미만 이거나 3:4 초과 시 업로드 불가 파일 형식 및 크기 : jpg / 최대 500KB” |
||
KKO_IMG_LINK_URL |
String |
N |
친구톡 이미지 링크주소. |
||
KKO_BTN_LINK1 |
String |
N |
카카오톡 챗버블 버튼 버튼 타입: DS: 배송조회, WL: 웹링크, AL: 앱링크, BK: 봇키워드, MD: 메시지전달
MD 예제 : {“name”:”메세지전달”, “type”:”MD”} |
||
KKO_BTN_LINK2 |
String |
N |
|||
KKO_BTN_LINK3 |
String |
N |
|||
KKO_BTN_LINK4 |
String |
N |
|||
KKO_BTN_LINK5 |
String |
N |
|||
SMS_TITLE |
String |
N |
MMS문자일 경우 타이틀 |
||
SMS_MSG |
String |
N |
보낼 문자내용. 90byte이상은 MMS로 발송됩니다. |
||
CALLBACK_NUM |
String |
N |
회신번호. SMS대체발송일 경우 필수 |
||
MMS_IMGURL |
String |
N |
MMS일 경우 이미지 URL: http://xxxx.com/sample.jpg |
||
TYPE : 일반발송 응답 메세지 |
|||||
구분 |
항목 |
값 |
필수 |
반복 |
설명 |
HEADER |
RESULTCODE |
String |
Y |
N |
0000 : 응답 성공 그외 : 에러 메시지 |
RESULTMSG |
String |
Y |
N |
OK : 응답 성공 그외 : 에러 메시지 |
|
BODY |
processSeqno |
String |
Y |
발송 시퀀스 고유번호. |
|
pushSendCnt |
int |
Y |
푸시 발송수 |
||
kkoAltCnt |
int |
Y |
카카오 알림톡 발송수 |
||
kkoFrtCnt |
int |
Y |
카카오 친구톡 발송수 |
||
smsCnt |
int |
Y |
문자 발송수 |
||
failCnt |
int |
Y |
실패수 |
||
processInfo |
Object |
Y |
발송진행상태 ex) {“processTxt”: “Completed.”, “processPercent”: “100”} |
연동예시
{ "HEADER": { "RESULTCODE": "0000", "RESULTMSG": "OK" }, "BODY": { "kkoAltCnt": "0", "pushSendCnt": 4, "kkoFrtCnt": "0", "smsCnt": "0", "failCnt": 1, "processInfo": { "processTxt": "Completed.", "processPercent": "100" }, "processSeqno": "202" } }
[PUSH] UMS 비회원 / CSV 예약발송 (대량발송 or 치환발송)¶
서비스명 |
PUSH 발송 |
Controller URL |
/api/csvSendPushMnApi.ums |
||
---|---|---|---|---|---|
METHOD |
multipart/form-data or application/x-www-form-urlencoded |
||||
설명 |
UMS 비회원 푸시 CSV예약발송 (대량, 개별화메세지) |
||||
Request (POST 방식 호출) |
|||||
항목 |
타입 |
필수 |
설명 |
||
APP_ID |
String |
Y |
어플리케이션 식별 정보 (패키지명) ex) kr.co.morpheus.mobile1 |
||
TITLE |
String |
N |
|||
PUSH_MSG |
String |
Y |
두 가지 타입 작성. 치환 발송 가능 (아이디, 이름) #{아이디}님 안녕하세요. 유라클 푸시메세지 입니다. |
||
SERVICECODE |
String |
Y |
푸시관리페이지에서 푸시서비스 코드 참조. ex) ALL, PUBLISH, PRIVATE 중 택일, |
||
CSVFILE |
MultipartFile |
Y |
CSV파일을 만들어 첨부한다.
P.S : 1번째 라인 컬럼정보, 2번째 라인부터 데이터
확인 : 발송시에는 #{아이디},#{이름}, #{핸드폰번호} 반드시 넣어야 함. 예1) csv파일 비 개인화
#{아이디}, #{이름}, #{핸드폰번호} 첫번째라인 컬럼정보 헤드
user1, 홍길동1, 01000011111
User2, 홍길동2, 01000002222 예 2) 개인화 처리 CSV파일 만들기
#{아이디}, #{이름}, #{핸드폰번호}, #{날자}, #{금액}
user1, 홍길동1, 01000011111, 2019-05-01, 4,000
User2, 홍길동1, 01000011111, 2019-05-04, 10,000 확인 : 반드시 핸드폰번호는 – 없이 숫자만 입력해 주세요. |
||
SENDERID |
String |
Y |
발송자 정보. 통계정보 사용. Ex) MAILSYSTEM. 제약조건 영문 30byte 이하 문자 |
||
SENDGROUPCODE |
String |
N |
발송자 그룹. 통계정보에 사용됨. EX) SYSTEM |
||
MSG_TYPE |
String |
N |
I: 정보성 메시지, A: 광고성 메시지 중 택일 ex) A |
||
RESERVEDATE |
String |
N |
발송예약 날자형식 : YYYY-MM-DD HH:MM . |
||
EXT_KIND |
String |
N |
EXT 사용시 사용. 값 : D로 보냄. ex) D |
||
EXT |
String |
N |
푸시메세지를 클릭하여 앱실행시 전달 해줄 메시지. 규격 제한 없음. Ex) {“linkUrl”:”http://xxx.com/index.html”, “imgUrl”:”http://xxx.com/test.jpg”} |
||
DB_IN |
String |
N |
푸시 SUCCESS 테이블에 저장 여부 |
||
KKOALT_SVCID |
String |
N |
[푸시실패시 대체발송 알림톡 설정] 확인: 알림톡과 친구톡은 둘중 하나 택일
카카오알림톡 서비스아이디 ex)1910028xxxx
|
||
ALLIMTOLK_TEMPLCODE |
String |
N |
카카오알림톡 등록템플릿코드 ex) 10138 |
||
FRIENDTOLK_SVCID |
String |
N |
[푸시실패시 대체발송 친구톡 설정]
확인: 알림톡과 친구톡은 둘중 하나 택일
카카오 친구톡 서비스 아이디 |
||
FRIENDTOLK_MSG |
String |
N |
친구톡 메시지 아이디, 이름은 치환발송 가능함. Ex) 안녕하세요. #{이름}님! 당신의 아이디: #{아이디}로 메일발송함. |
||
PLUS_ID |
String |
N |
카카오톡 플러스친구 아이디 |
||
KKO_IMGFILE_PATH |
MultipartFile |
N |
친구톡 이미지전송. NAS가 있는 경우만 가능. 없을경우 아래의 KKO_IMGFILE를 이용 이미지 사이즈 규격 권장사이즈 : 720px X 720px 제한사이즈 : 가로 500px 미만, 가로:세로 비율이 2:1 미만 이거나 3:4 초과 시 업로드 불가 파일 형식 및 크기 : jpg / 최대 500KB” |
||
KKO_IMGFILE |
String |
N |
친구톡 이미지 전송 UR방식. Ex)http://xxx.com/aaa.jpg.
이미지 사이즈 규격
권장사이즈 : 720px X 720px 제한사이즈 : 가로 500px 미만, 가로:세로 비율이 2:1 미만 이거나 3:4 초과 시 업로드 불가 파일 형식 및 크기 : jpg / 최대 500KB” |
||
KKO_IMG_LINK_URL |
String |
N |
친구톡 이미지 링크주소. |
||
KKO_BTN_LINK1 |
String |
N |
카카오톡 챗버블 버튼 버튼 타입: DS: 배송조회, WL: 웹링크, AL: 앱링크, BK: 봇키워드, MD: 메시지전달
MD 예제 : {“name”:”메세지전달”, “type”:”MD”} |
||
KKO_BTN_LINK2 |
String |
N |
|||
KKO_BTN_LINK3 |
String |
N |
|||
KKO_BTN_LINK4 |
String |
N |
|||
KKO_BTN_LINK5 |
String |
N |
|||
SMS_TITLE |
String |
N |
MMS문자일 경우 타이틀 |
||
SMS_MSG |
String |
N |
보낼 문자내용. 90byte이상은 MMS로 발송됩니다. |
||
CALLBACK_NUM |
String |
N |
회신번호. SMS대체발송일 경우 필수 |
||
MMS_IMGURL |
String |
N |
MMS일 경우 이미지 URL: http://xxxx.com/sample.jpg |
||
TYPE : 일반발송 응답 메세지 |
|||||
구분 |
항목 |
값 |
필수 |
반복 |
설명 |
HEADER |
RESULTCODE |
String |
Y |
N |
0000 : 응답 성공 그외 : 에러 메시지 |
RESULTMSG |
String |
Y |
N |
OK : 응답 성공 그외 : 에러 메시지 |
|
BODY |
reserveSeqno |
String |
Y |
예약발송 시퀀스 고유번호. |
|
processInfo |
Object |
Y |
발송진행상태 ex) {“processTxt”: “Completed.”, “processPercent”: “100”} |
연동예시
{ "HEADER": { "RESULTCODE": "0000", "RESULTMSG": "OK" }, "BODY": { "reserveSeqno": "220", "processInfo": { "processTxt": "Completed.", "processPercent": "100" } } }
카카오 알림톡 API¶
[카카오알림톡] UMS 회원 발송 (단건 치환발송)¶
서비스명 |
알림톡 발송 |
Controller URL |
/api/umsSendAltApi.ums |
||
---|---|---|---|---|---|
METHOD |
multipart/form-data or application/x-www-form-urlencoded |
||||
설명 |
UMS 회원 알림톡 발송 |
||||
Request (POST 방식 호출) |
|||||
항목 |
타입 |
필수 |
설명 |
||
SENDERID |
String |
Y |
발송자 정보. 통계정보 사용. Ex) MAILSYSTEM. 제약조건 영문 30byte 이하 문자 |
||
TYPE |
String |
Y |
발송 타겟팅 선택 : MU , OU, AU 중 택일
MU=>회원 발송. 아이디로 타겟팅,
OU=>전체조직도유저, AU=>전체UMS회원, |
||
CUIDS |
String |
Y |
TYPE : MU 일 경우 필수 값.
1. MU일 경우 UMS 등록된 회원아이디로 보냄.
한건 발송 ex) user1 여러명 발송 ex) [“user1”,”user2”…] 최대 2000명 가능 |
||
KKOALT_SVCID |
String |
Y |
LGCNS톡드림에 등록된 카카오알림톡 서비스아이디 ex)1910028xxxx |
||
ALLIMTOLK_TEMPLCODE |
String |
Y |
카카오알림톡 등록템플릿코드 ex) 10138 |
||
REPLACE_VARS |
String |
N |
- 알림톡 템플릿에 내용에 #{변수명}과 같은 치환변수가 템플릿 내용에 있을 경우 필수값.
- 메시지 형태 JSON Object
메시지 내용 : 안녕하세요. 결제일은 #{날짜} 입니다. #{금액}이 청구됩니다.
넘겨야 될 파라미터값 : {“#{날짜}”:”2019-07-07”, “#{금액}”:”1,000”}
|
||
PLUS_ID |
String |
Y |
카카오톡 플러스친구 아이디 |
||
KKO_BTN_LINK1 |
String |
N |
카카오톡 챗버블 버튼 버튼 타입: DS: 배송조회, WL: 웹링크, AL: 앱링크, BK: 봇키워드, MD: 메시지전달
MD 예제 : {“name”:”메세지전달”, “type”:”MD”} |
||
KKO_BTN_LINK2 |
String |
N |
|||
KKO_BTN_LINK3 |
String |
N |
|||
KKO_BTN_LINK4 |
String |
N |
|||
KKO_BTN_LINK5 |
String |
N |
|||
SMS_TITLE |
String |
N |
MMS문자일 경우 타이틀 |
||
SMS_MSG |
String |
N |
보낼 문자내용. 90byte이상은 MMS로 발송됩니다. |
||
CALLBACK_NUM |
String |
N |
회신번호. SMS대체발송일 경우 필수 |
||
MMS_IMGURL |
String |
N |
MMS일 경우 이미지 URL: http://xxxx.com/sample.jpg |
||
TYPE : 일반발송 응답 메세지 |
|||||
구분 |
항목 |
값 |
필수 |
반복 |
설명 |
HEADER |
RESULTCODE |
String |
Y |
N |
0000 : 응답 성공 그외 : 에러 메시지 |
RESULTMSG |
String |
Y |
N |
OK : 응답 성공 그외 : 에러 메시지 |
|
BODY |
processSeqno |
String |
Y |
발송 시퀀스 고유번호. |
|
pushSendCnt |
int |
Y |
푸시 발송수 |
||
kkoAltCnt |
int |
Y |
카카오 알림톡 발송수 |
||
kkoFrtCnt |
int |
Y |
카카오 친구톡 발송수 |
||
smsCnt |
int |
Y |
문자 발송수 |
||
failCnt |
int |
Y |
실패수 |
||
processInfo |
Object |
Y |
발송진행상태 ex) {“processTxt”: “Completed.”, “processPercent”: “100”} |
연동예시
{ "HEADER": { "RESULTCODE": "0000", "RESULTMSG": "OK" }, "BODY": { "kkoAltCnt": "1", "pushSendCnt": "0", "kkoFrtCnt": "0", "smsCnt": "0", "failCnt": 0, "processInfo": { "processTxt": "Completed.", "processPercent": "100" }, "processSeqno": "280" } }
[카카오알림톡] UMS 회원 / 예약발송(단건 치환발송)¶
서비스명 |
알림톡 발송 |
Controller URL |
/api/umsSendAltApi.ums |
||
---|---|---|---|---|---|
METHOD |
multipart/form-data or application/x-www-form-urlencoded |
||||
설명 |
UMS 회원 알림톡 예약발송 |
||||
Request (POST 방식 호출) |
|||||
항목 |
타입 |
필수 |
설명 |
||
SENDERID |
String |
Y |
발송자 정보. 통계정보 사용. Ex) MAILSYSTEM. 제약조건 영문 30byte 이하 문자 |
||
TYPE |
String |
Y |
발송 타겟팅 선택 : MU , OU, AU 중 택일
MU=>회원 발송. 아이디로 타겟팅,
OU=>전체조직도유저, AU=>전체UMS회원, |
||
CUIDS |
String |
Y |
TYPE : MU 일 경우 필수 값.
1. MU일 경우 UMS 등록된 회원아이디로 보냄.
한건 발송 ex) user1 여러명 발송 ex) [“user1”,”user2”…] 최대 2000명 가능 |
||
KKOALT_SVCID |
String |
Y |
LGCNS톡드림에 등록된 카카오알림톡 서비스아이디 ex)1910028xxxx |
||
ALLIMTOLK_TEMPLCODE |
String |
Y |
카카오알림톡 등록템플릿코드 ex) 10138 |
||
REPLACE_VARS |
String |
N |
- 알림톡 템플릿에 내용에 #{변수명}과 같은 치환변수가 템플릿 내용에 있을 경우 필수값.
- 메시지 형태 JSON Object
메시지 내용 : 안녕하세요. 결제일은 #{날짜} 입니다. #{금액}이 청구됩니다.
넘겨야 될 파라미터값 : {“#{날짜}”:”2019-07-07”, “#{금액}”:”1,000”}
|
||
PLUS_ID |
String |
Y |
카카오톡 플러스친구 아이디 |
||
RESERVEDATE |
String |
N |
발송예약 날자형식 : YYYY-MM-DD HH:MM . |
||
KKO_BTN_LINK1 |
String |
N |
카카오톡 챗버블 버튼 버튼 타입: DS: 배송조회, WL: 웹링크, AL: 앱링크, BK: 봇키워드, MD: 메시지전달
MD 예제 : {“name”:”메세지전달”, “type”:”MD”} |
||
KKO_BTN_LINK2 |
String |
N |
|||
KKO_BTN_LINK3 |
String |
N |
|||
KKO_BTN_LINK4 |
String |
N |
|||
KKO_BTN_LINK5 |
String |
N |
|||
SMS_TITLE |
String |
N |
MMS문자일 경우 타이틀 |
||
SMS_MSG |
String |
N |
보낼 문자내용. 90byte이상은 MMS로 발송됩니다. |
||
CALLBACK_NUM |
String |
N |
회신번호. SMS대체발송일 경우 필수 |
||
MMS_IMGURL |
String |
N |
MMS일 경우 이미지 URL: http://xxxx.com/sample.jpg |
||
TYPE : 일반발송 응답 메세지 |
|||||
구분 |
항목 |
값 |
필수 |
반복 |
설명 |
HEADER |
RESULTCODE |
String |
Y |
N |
0000 : 응답 성공 그외 : 에러 메시지 |
RESULTMSG |
String |
Y |
N |
OK : 응답 성공 그외 : 에러 메시지 |
|
BODY |
reserveSeqno |
String |
Y |
예약발송 시퀀스 고유번호. |
|
processInfo |
Object |
Y |
발송진행상태 ex) {“processTxt”: “Completed.”, “processPercent”: “100”} |
||
연동예시
{ "HEADER": { "RESULTCODE": "0000", "RESULTMSG": "OK" }, "BODY": { "reserveSeqno": "220", "processInfo": { "processTxt": "Completed.", "processPercent": "100" } } }
[카카오알림톡] UMS 비회원 발송(단건 치환발송)¶
서비스명 |
알림톡 비회원 발송 |
Controller URL |
/api/umsSendAltMnApi.ums |
||
---|---|---|---|---|---|
METHOD |
multipart/form-data or application/x-www-form-urlencoded |
||||
설명 |
UMS 비회원 알림톡 발송 |
||||
Request (POST 방식 호출) |
|||||
항목 |
타입 |
필수 |
설명 |
||
SENDERID |
String |
Y |
발송자 정보. 통계정보 사용. Ex) MAILSYSTEM. 제약조건 영문 30byte 이하 문자 |
||
CUIDS |
String |
Y |
한 명 : ex) {“아이디”:[“핸드폰번호”,이름””]}
여러명 ex) {“아이디”:[“핸드폰번호”,이름””], “아이디”:[“핸드폰번호”,이름””]…}
P.S:핸드폰번호 : 0001234567 숫자만 입력 아이디 모를 경우 GUEST1,GUEST2… 임의의 아이디 생성하여 보냄. 확인 : 반드시 핸드폰번호는 – 없이 숫자만 입력해 주세요. |
||
KKOALT_SVCID |
String |
Y |
LGCNS톡드림에 등록된 카카오알림톡 서비스아이디 ex)1910028xxxx |
||
ALLIMTOLK_TEMPLCODE |
String |
Y |
카카오알림톡 등록템플릿코드 ex) 10138 |
||
REPLACE_VARS |
String |
N |
- 알림톡 템플릿에 내용에 #{변수명}과 같은 치환변수가 템플릿 내용에 있을 경우 필수값.
- 메시지 형태 JSON Object
메시지 내용 : 안녕하세요. 결제일은 #{날짜} 입니다. #{금액}이 청구됩니다.
넘겨야 될 파라미터값 : {“#{날짜}”:”2019-07-07”, “#{금액}”:”1,000”}
|
||
PLUS_ID |
String |
Y |
카카오톡 플러스친구 아이디 |
||
KKO_BTN_LINK1 |
String |
N |
카카오톡 챗버블 버튼 버튼 타입: DS: 배송조회, WL: 웹링크, AL: 앱링크, BK: 봇키워드, MD: 메시지전달
MD 예제 : {“name”:”메세지전달”, “type”:”MD”} |
||
KKO_BTN_LINK2 |
String |
N |
|||
KKO_BTN_LINK3 |
String |
N |
|||
KKO_BTN_LINK4 |
String |
N |
|||
KKO_BTN_LINK5 |
String |
N |
|||
SMS_TITLE |
String |
N |
MMS문자일 경우 타이틀 |
||
SMS_MSG |
String |
N |
보낼 문자내용 |
||
CALLBACK_NUM |
String |
N |
회신번호. SMS대체발송일 경우 필수 |
||
MMS_IMGURL |
String |
N |
MMS일 경우 이미지 URL: http://xxxx.com/sample.jpg |
||
TYPE : 일반발송 응답 메세지 |
|||||
구분 |
항목 |
값 |
필수 |
반복 |
설명 |
HEADER |
RESULTCODE |
String |
Y |
N |
0000 : 응답 성공 그외 : 에러 메시지 |
RESULTMSG |
String |
Y |
N |
OK : 응답 성공 그외 : 에러 메시지 |
|
BODY |
processSeqno |
String |
Y |
발송 시퀀스 고유번호. |
|
pushSendCnt |
int |
Y |
푸시 발송수 |
||
kkoAltCnt |
int |
Y |
카카오 알림톡 발송수 |
||
kkoFrtCnt |
int |
Y |
카카오 친구톡 발송수 |
||
smsCnt |
int |
Y |
문자 발송수 |
||
failCnt |
int |
Y |
실패수 |
||
processInfo |
Object |
Y |
발송진행상태 ex) {“processTxt”: “Completed.”, “processPercent”: “100”} |
연동예시
{ "HEADER": { "RESULTCODE": "0000", "RESULTMSG": "OK" }, "BODY": { "kkoAltCnt": "1", "pushSendCnt": "0", "kkoFrtCnt": "0", "smsCnt": "0", "failCnt": 0, "processInfo": { "processTxt": "Completed.", "processPercent": "100" }, "processSeqno": "280" } }
[카카오알림톡] UMS 비회원 / 예약발송 (단건 치환발송)¶
서비스명 |
알림톡 비회원 예약발송 |
Controller URL |
/api/umsSendAltMnApi.ums |
||
---|---|---|---|---|---|
METHOD |
multipart/form-data or application/x-www-form-urlencoded |
||||
설명 |
UMS 비회원 알림톡 예약 발송 |
||||
Request (POST 방식 호출) |
|||||
항목 |
타입 |
필수 |
설명 |
||
SENDERID |
String |
Y |
발송자 정보. 통계정보 사용. Ex) MAILSYSTEM. 제약조건 영문 30byte 이하 문자 |
||
CUIDS |
String |
Y |
한 명 : ex) {“아이디”:[“핸드폰번호”,” 이름”]} 여러명 ex) {“아이디”:[“핸드폰번호”,”이름”], “아이디”:[“핸드폰번호”,이름””]…} P.S:핸드폰번호 : 0001234567 숫자만 입력 아이디 모를 경우 GUEST1,GUEST2… 임의의 아이디 생성하여 보냄. 확인 : 반드시 핸드폰번호는 – 없이 숫자만 입력해 주세요. |
||
RESERVEDATE |
String |
N |
발송예약 날자형식 : YYYY-MM-DD HH:MM . |
||
KKOALT_SVCID |
String |
Y |
LGCNS톡드림에 등록된 카카오알림톡 서비스아이디 ex)1910028xxxx |
||
ALLIMTOLK_TEMPLCODE |
String |
Y |
카카오알림톡 등록템플릿코드 ex) 10138 |
||
REPLACE_VARS |
String |
N |
- 알림톡 템플릿에 내용에 #{변수명}과 같은 치환변수가 템플릿 내용에 있을 경우 필수값.
- 메시지 형태 JSON Object
메시지 내용 : 안녕하세요. 결제일은 #{날짜} 입니다. #{금액}이 청구됩니다.
넘겨야 될 파라미터값 : {“#{날짜}”:”2019-07-07”, “#{금액}”:”1,000”}
|
||
PLUS_ID |
String |
Y |
카카오톡 플러스친구 아이디 |
||
KKO_BTN_LINK1 |
String |
N |
카카오톡 챗버블 버튼 버튼 타입: DS: 배송조회, WL: 웹링크, AL: 앱링크, BK: 봇키워드, MD: 메시지전달 [예제] 파이프 2개 구분자로 링크구분.
- 알림톡 예제 : http://xxx.com||http://xxx.com
|
||
KKO_BTN_LINK2 |
String |
N |
|||
KKO_BTN_LINK3 |
String |
N |
|||
KKO_BTN_LINK4 |
String |
N |
|||
KKO_BTN_LINK5 |
String |
N |
|||
SMS_TITLE |
String |
N |
MMS문자일 경우 타이틀 |
||
SMS_MSG |
String |
N |
보낼 문자내용. 90byte이상은 MMS로 발송됩니다. |
||
CALLBACK_NUM |
String |
N |
회신번호. SMS대체발송일 경우 필수 |
||
MMS_IMGURL |
String |
N |
MMS일 경우 이미지 URL: http://xxxx.com/sample.jpg |
||
TYPE : 일반발송 응답 메세지 |
|||||
구분 |
항목 |
값 |
필수 |
반복 |
설명 |
HEADER |
RESULTCODE |
String |
Y |
N |
0000 : 응답 성공 그외 : 에러 메시지 |
RESULTMSG |
String |
Y |
N |
OK : 응답 성공 그외 : 에러 메시지 |
|
BODY |
reserveSeqno |
String |
Y |
예약발송 시퀀스 고유번호. |
|
processInfo |
Object |
Y |
발송진행상태 ex) {“processTxt”: “Completed.”, “processPercent”: “100”} |
||
연동예시
{ "HEADER": { "RESULTCODE": "0000", "RESULTMSG": "OK" }, "BODY": { "reserveSeqno": "220", "processInfo": { "processTxt": "Completed.", "processPercent": "100" } } }
[카카오알림톡] UMS 회원 / CSV발송 (대량발송 or 치환발송)¶
서비스명 |
알림톡UMS회원 CSV 발송 |
Controller URL |
/api/csvSendAltApi.ums |
||
---|---|---|---|---|---|
METHOD |
multipart/form-data or application/x-www-form-urlencoded |
||||
설명 |
UMS 회원 알림톡 CSV 발송 |
||||
Request (POST 방식 호출) |
|||||
항목 |
타입 |
필수 |
설명 |
||
SENDERID |
String |
Y |
발송자 정보. 통계정보 사용. Ex) MAILSYSTEM. 제약조건 영문 30byte 이하 문자 |
||
CSVFILE |
MultipartFile |
Y |
CSV파일을 만들어 첨부한다.
P.S : 1번째 라인 컬럼정보, 2번째 라인부터 데이터
확인 : 푸시만 발송시에는 #{아이디} 하나만 넣어도 됨.
#{이름}, #{핸드폰번호} 생략가능. 회원정보에서 가져옴.
예1) csv파일 비 개인화
#{아이디} 첫번째라인 컬럼정보 헤드
user1
User2 예 2) 개인화 처리 CSV파일 만들기
#{아이디}, #{날자}, #{금액}
user1, 2019-05-01, 4,000
User2, 2019-05-04, 10,000 |
||
KKOALT_SVCID |
String |
Y |
LGCNS톡드림에 등록된 카카오알림톡 서비스아이디 ex)1910028xxxx |
||
ALLIMTOLK_TEMPLCODE |
String |
Y |
카카오알림톡 등록템플릿코드 ex) 10138 |
||
PLUS_ID |
String |
Y |
카카오톡 플러스친구 아이디 |
||
KKO_BTN_LINK1 |
String |
N |
카카오톡 챗버블 버튼 버튼 타입: DS: 배송조회, WL: 웹링크, AL: 앱링크, BK: 봇키워드, MD: 메시지전달
MD 예제 : {“name”:”메세지전달”, “type”:”MD”} |
||
KKO_BTN_LINK2 |
String |
N |
|||
KKO_BTN_LINK3 |
String |
N |
|||
KKO_BTN_LINK4 |
String |
N |
|||
KKO_BTN_LINK5 |
String |
N |
|||
SMS_TITLE |
String |
N |
MMS문자일 경우 타이틀 |
||
SMS_MSG |
String |
N |
보낼 문자내용. 90byte이상은 MMS로 발송됩니다. |
||
CALLBACK_NUM |
String |
N |
회신번호. SMS대체발송일 경우 필수 |
||
MMS_IMGURL |
String |
N |
MMS일 경우 이미지 URL: http://xxxx.com/sample.jpg |
||
TYPE : 일반발송 응답 메세지 |
|||||
구분 |
항목 |
값 |
필수 |
반복 |
설명 |
HEADER |
RESULTCODE |
String |
Y |
N |
0000 : 응답 성공 그외 : 에러 메시지 |
RESULTMSG |
String |
Y |
N |
OK : 응답 성공 그외 : 에러 메시지 |
|
BODY |
processSeqno |
String |
Y |
발송 시퀀스 고유번호. |
|
pushSendCnt |
int |
Y |
푸시 발송수 |
||
kkoAltCnt |
int |
Y |
카카오 알림톡 발송수 |
||
kkoFrtCnt |
int |
Y |
카카오 친구톡 발송수 |
||
smsCnt |
int |
Y |
문자 발송수 |
||
failCnt |
int |
Y |
실패수 |
||
processInfo |
Object |
Y |
발송진행상태 ex) {“processTxt”: “Completed.”, “processPercent”: “100”} |
연동예시
{ "HEADER": { "RESULTCODE": "0000", "RESULTMSG": "OK" }, "BODY": { "kkoAltCnt": "1", "pushSendCnt": "0", "kkoFrtCnt": "0", "smsCnt": "0", "failCnt": 0, "processInfo": { "processTxt": "Completed.", "processPercent": "100" }, "processSeqno": "280" } }
[카카오알림톡] UMS 회원 / CSV예약발송 (대량발송 or 치환발송)¶
서비스명 |
알림톡UMS회원 CSV 예약발송 |
Controller URL |
/api/csvSendAltApi.ums |
||
---|---|---|---|---|---|
METHOD |
multipart/form-data or application/x-www-form-urlencoded |
||||
설명 |
UMS 회원 알림톡 CSV 예약발송 |
||||
Request (POST 방식 호출) |
|||||
항목 |
타입 |
필수 |
설명 |
||
SENDERID |
String |
Y |
발송자 정보. 통계정보 사용. Ex) MAILSYSTEM. 제약조건 영문 30byte 이하 문자 |
||
CSVFILE |
MultipartFile |
Y |
CSV파일을 만들어 첨부한다.
P.S : 1번째 라인 컬럼정보, 2번째 라인부터 데이터
확인 : 푸시만 발송시에는 #{아이디} 하나만 넣어도 됨.
#{이름}, #{핸드폰번호} 생략가능. 회원정보에서 가져옴.
예1) csv파일 비 개인화
#{아이디} 첫번째라인 컬럼정보 헤드
user1
User2 예 2) 개인화 처리 CSV파일 만들기
#{아이디}, #{날자}, #{금액}
user1, 2019-05-01, 4,000
User2, 2019-05-04, 10,000 |
||
RESERVEDATE |
String |
N |
발송예약 날자형식 : YYYY-MM-DD HH:MM . |
||
KKOALT_SVCID |
String |
Y |
LGCNS톡드림에 등록된 카카오알림톡 서비스아이디 ex)1910028xxxx |
||
ALLIMTOLK_TEMPLCODE |
String |
Y |
카카오알림톡 등록템플릿코드 ex) 10138 |
||
PLUS_ID |
String |
Y |
카카오톡 플러스친구 아이디 |
||
KKO_BTN_LINK1 |
String |
N |
카카오톡 챗버블 버튼 버튼 타입: DS: 배송조회, WL: 웹링크, AL: 앱링크, BK: 봇키워드, MD: 메시지전달
MD 예제 : {“name”:”메세지전달”, “type”:”MD”} |
||
KKO_BTN_LINK2 |
String |
N |
|||
KKO_BTN_LINK3 |
String |
N |
|||
KKO_BTN_LINK4 |
String |
N |
|||
KKO_BTN_LINK5 |
String |
N |
|||
SMS_TITLE |
String |
N |
MMS문자일 경우 타이틀 |
||
SMS_MSG |
String |
N |
보낼 문자내용. 90byte이상은 MMS로 발송됩니다. |
||
CALLBACK_NUM |
String |
N |
회신번호. SMS대체발송일 경우 필수 |
||
MMS_IMGURL |
String |
N |
MMS일 경우 이미지 URL: http://xxxx.com/sample.jpg |
||
TYPE : 일반발송 응답 메세지 |
|||||
구분 |
항목 |
값 |
필수 |
반복 |
설명 |
HEADER |
RESULTCODE |
String |
Y |
N |
0000 : 응답 성공 그외 : 에러 메시지 |
RESULTMSG |
String |
Y |
N |
OK : 응답 성공 그외 : 에러 메시지 |
|
BODY |
reserveSeqno |
String |
Y |
예약발송 시퀀스 고유번호. |
|
processInfo |
Object |
Y |
발송진행상태 ex) {“processTxt”: “Completed.”, “processPercent”: “100”} |
||
연동예시
{ "HEADER": { "RESULTCODE": "0000", "RESULTMSG": "OK" }, "BODY": { "reserveSeqno": "220", "processInfo": { "processTxt": "Completed.", "processPercent": "100" } } }
[카카오알림톡] UMS 비회원 / CSV발송 (대량발송 or 치환발송)¶
서비스명 |
알림톡UMS비회원 CSV 예약발송 |
Controller URL |
/api/csvSendAltMnApi.ums |
||
---|---|---|---|---|---|
METHOD |
multipart/form-data or application/x-www-form-urlencoded |
||||
설명 |
UMS 비회원 알림톡 CSV 예약발송 |
||||
Request (POST 방식 호출) |
|||||
항목 |
타입 |
필수 |
설명 |
||
SENDERID |
String |
Y |
발송자 정보. 통계정보 사용. Ex) MAILSYSTEM. 제약조건 영문 30byte 이하 문자 |
||
CSVFILE |
MultipartFile |
Y |
CSV파일을 만들어 첨부한다.
P.S : 1번째 라인 컬럼정보, 2번째 라인부터 데이터
확인 : 발송시에는 #{아이디},#{이름}, #{핸드폰번호} 반드시 넣어야 함. 예1) csv파일 비 개인화
#{아이디}, #{이름}, #{핸드폰번호} 첫번째라인 컬럼정보 헤드
user1, 홍길동1, 01000011111
User2, 홍길동2, 01000002222 예 2) 개인화 처리 CSV파일 만들기
#{아이디}, #{이름}, #{핸드폰번호}, #{날자}, #{금액}
user1, 홍길동1, 01000011111, 2019-05-01, 4,000
User2, 홍길동1, 01000011111, 2019-05-04, 10,000 확인 : 반드시 핸드폰번호는 – 없이 숫자만 입력해 주세요. |
||
KKOALT_SVCID |
String |
Y |
LGCNS톡드림에 등록된 카카오알림톡 서비스아이디 ex)1910028xxxx |
||
ALLIMTOLK_TEMPLCODE |
String |
Y |
카카오알림톡 등록템플릿코드 ex) 10138 |
||
PLUS_ID |
String |
Y |
카카오톡 플러스친구 아이디 |
||
KKO_BTN_LINK1 |
String |
N |
카카오톡 챗버블 버튼 버튼 타입: DS: 배송조회, WL: 웹링크, AL: 앱링크, BK: 봇키워드, MD: 메시지전달
MD 예제 : {“name”:”메세지전달”, “type”:”MD”} |
||
KKO_BTN_LINK2 |
String |
N |
|||
KKO_BTN_LINK3 |
String |
N |
|||
KKO_BTN_LINK4 |
String |
N |
|||
KKO_BTN_LINK5 |
String |
N |
|||
SMS_TITLE |
String |
N |
MMS문자일 경우 타이틀 |
||
SMS_MSG |
String |
N |
보낼 문자내용. 90byte이상은 MMS로 발송됩니다. |
||
CALLBACK_NUM |
String |
N |
회신번호. SMS대체발송일 경우 필수 |
||
MMS_IMGURL |
String |
N |
MMS일 경우 이미지 URL: http://xxxx.com/sample.jpg |
||
TYPE : 일반발송 응답 메세지 |
|||||
구분 |
항목 |
값 |
필수 |
반복 |
설명 |
HEADER |
RESULTCODE |
String |
Y |
N |
0000 : 응답 성공 그외 : 에러 메시지 |
RESULTMSG |
String |
Y |
N |
OK : 응답 성공 그외 : 에러 메시지 |
|
BODY |
reserveSeqno |
String |
Y |
예약발송 시퀀스 고유번호. |
|
processInfo |
Object |
Y |
발송진행상태 ex) {“processTxt”: “Completed.”, “processPercent”: “100”} |
||
연동예시
{ "HEADER": { "RESULTCODE": "0000", "RESULTMSG": "OK" }, "BODY": { "reserveSeqno": "220", "processInfo": { "processTxt": "Completed.", "processPercent": "100" } } }
[카카오알림톡 ] UMS 비회원 / CSV예약발송 (대량발송 or 치환발송)¶
서비스명 |
알림톡UMS비회원 CSV 예약발송 |
Controller URL |
/api/csvSendAltMnApi.ums |
||
---|---|---|---|---|---|
METHOD |
multipart/form-data or application/x-www-form-urlencoded |
||||
설명 |
UMS 비회원 알림톡 CSV 예약발송 |
||||
Request (POST 방식 호출) |
|||||
항목 |
타입 |
필수 |
설명 |
||
SENDERID |
String |
Y |
발송자 정보. 통계정보 사용. Ex) MAILSYSTEM. 제약조건 영문 30byte 이하 문자 |
||
CSVFILE |
MultipartFile |
Y |
CSV파일을 만들어 첨부한다.
P.S : 1번째 라인 컬럼정보, 2번째 라인부터 데이터
확인 : 발송시에는 #{아이디},#{이름}, #{핸드폰번호} 반드시 넣어야 함. 예1) csv파일 비 개인화
#{아이디}, #{이름}, #{핸드폰번호} 첫번째라인 컬럼정보 헤드
user1, 홍길동1, 01000011111
User2, 홍길동2, 01000002222 예 2) 개인화 처리 CSV파일 만들기
#{아이디}, #{이름}, #{핸드폰번호}, #{날자}, #{금액}
user1, 홍길동1, 01000011111, 2019-05-01, 4,000
User2, 홍길동1, 01000011111, 2019-05-04, 10,000 확인 : 반드시 핸드폰번호는 – 없이 숫자만 입력해 주세요. |
||
RESERVEDATE |
String |
N |
발송예약 날자형식 : YYYY-MM-DD HH:MM . |
||
KKOALT_SVCID |
String |
Y |
LGCNS톡드림에 등록된 카카오알림톡 서비스아이디 ex)1910028xxxx |
||
ALLIMTOLK_TEMPLCODE |
String |
Y |
카카오알림톡 등록템플릿코드 ex) 10138 |
||
PLUS_ID |
String |
Y |
카카오톡 플러스친구 아이디 |
||
KKO_BTN_LINK1 |
String |
N |
카카오톡 챗버블 버튼 버튼 타입: DS: 배송조회, WL: 웹링크, AL: 앱링크, BK: 봇키워드, MD: 메시지전달
MD 예제 : {“name”:”메세지전달”, “type”:”MD”} |
||
KKO_BTN_LINK2 |
String |
N |
|||
KKO_BTN_LINK3 |
String |
N |
|||
KKO_BTN_LINK4 |
String |
N |
|||
KKO_BTN_LINK5 |
String |
N |
|||
SMS_TITLE |
String |
N |
MMS문자일 경우 타이틀 |
||
SMS_MSG |
String |
N |
보낼 문자내용. 90byte이상은 MMS로 발송됩니다. |
||
CALLBACK_NUM |
String |
N |
회신번호. SMS대체발송일 경우 필수 |
||
MMS_IMGURL |
String |
N |
MMS일 경우 이미지 URL: http://xxxx.com/sample.jpg |
||
TYPE : 일반발송 응답 메세지 |
|||||
구분 |
항목 |
값 |
필수 |
반복 |
설명 |
HEADER |
RESULTCODE |
String |
Y |
N |
0000 : 응답 성공 그외 : 에러 메시지 |
RESULTMSG |
String |
Y |
N |
OK : 응답 성공 그외 : 에러 메시지 |
|
BODY |
reserveSeqno |
String |
Y |
예약발송 시퀀스 고유번호. |
|
processInfo |
Object |
Y |
발송진행상태 ex) {“processTxt”: “Completed.”, “processPercent”: “100”} |
||
연동예시
{ "HEADER": { "RESULTCODE": "0000", "RESULTMSG": "OK" }, "BODY": { "reserveSeqno": "220", "processInfo": { "processTxt": "Completed.", "processPercent": "100" } } }
[카카오친구톡] UMS 회원 발송¶
서비스명 |
친구톡 발송 |
Controller URL |
/api/umsSendFrtApi.ums |
||
---|---|---|---|---|---|
METHOD |
multipart/form-data or application/x-www-form-urlencoded |
||||
설명 |
UMS 회원 친구톡 발송 |
||||
Request (POST 방식 호출) |
|||||
항목 |
타입 |
필수 |
설명 |
||
SENDERID |
String |
Y |
발송자 정보. 통계정보 사용. Ex) MAILSYSTEM. 제약조건 영문 30byte 이하 문자 |
||
TYPE |
String |
Y |
발송 타겟팅 선택 : MU , OU, AU 중 택일
MU=>회원 발송. 아이디로 타겟팅,
OU=>전체조직도유저, AU=>전체UMS회원, |
||
CUIDS |
String |
Y |
TYPE : MU 일 경우 필수 값.
1. MU일 경우 UMS 등록된 회원아이디로 보냄.
한건 발송 ex) user1 여러명 발송 ex) [“user1”,”user2”…] 최대 2000명 가능 |
||
FRIENDTOLK_SVCID |
String |
Y |
LGCNS톡드림에 등록된 카카오친구톡 서비스아이디 ex)1910028xxxx |
||
FRIENDTOLK_MSG |
String |
Y |
친구톡 메시지. 최대 4000byte |
||
PLUS_ID |
String |
Y |
친구톡 플러스친구 아이디 |
||
KKO_BTN_LINK1 |
String |
N |
카카오톡 챗버블 버튼 버튼 타입: DS: 배송조회, WL: 웹링크, AL: 앱링크, BK: 봇키워드, MD: 메시지전달
MD 예제 : {“name”:”메세지전달”, “type”:”MD”} |
||
KKO_BTN_LINK2 |
String |
N |
|||
KKO_BTN_LINK3 |
String |
N |
|||
KKO_BTN_LINK4 |
String |
N |
|||
KKO_BTN_LINK5 |
String |
N |
|||
SMS_TITLE |
String |
N |
MMS문자일 경우 타이틀. |
||
SMS_MSG |
String |
N |
보낼 문자내용. 90byte이상은 MMS로 발송됩니다. |
||
CALLBACK_NUM |
String |
N |
회신번호. SMS대체발송일 경우 필수 |
||
MMS_IMGURL |
String |
N |
MMS일 경우 이미지 URL: http://xxxx.com/sample.jpg |
||
TYPE : 일반발송 응답 메세지 |
|||||
구분 |
항목 |
값 |
필수 |
반복 |
설명 |
HEADER |
RESULTCODE |
String |
Y |
N |
0000 : 응답 성공 그외 : 에러 메시지 |
RESULTMSG |
String |
Y |
N |
OK : 응답 성공 그외 : 에러 메시지 |
|
BODY |
processSeqno |
String |
Y |
발송 시퀀스 고유번호. |
|
pushSendCnt |
int |
Y |
푸시 발송수 |
||
kkoAltCnt |
int |
Y |
카카오 알림톡 발송수 |
||
kkoFrtCnt |
int |
Y |
카카오 친구톡 발송수 |
||
smsCnt |
int |
Y |
문자 발송수 |
||
failCnt |
int |
Y |
실패수 |
||
processInfo |
Object |
Y |
발송진행상태 ex) {“processTxt”: “Completed.”, “processPercent”: “100”} |
연동예시
{ "HEADER": { "RESULTCODE": "0000", "RESULTMSG": "OK" }, "BODY": { "kkoAltCnt": "1", "pushSendCnt": "0", "kkoFrtCnt": "0", "smsCnt": "0", "failCnt": 0, "processInfo": { "processTxt": "Completed.", "processPercent": "100" }, "processSeqno": "280" } }
카카오친구톡 API¶
[카카오친구톡] UMS 회원 / 예약발송¶
서비스명 |
친구톡 회원 예약발송 |
Controller URL |
/api/umsSendFrtApi.ums |
||
---|---|---|---|---|---|
METHOD |
multipart/form-data or application/x-www-form-urlencoded |
||||
설명 |
UMS 회원 친구톡 예약 발송 |
||||
Request (POST 방식 호출) |
|||||
항목 |
타입 |
필수 |
설명 |
||
SENDERID |
String |
Y |
발송자 정보. 통계정보 사용. Ex) MAILSYSTEM. 제약조건 영문 30byte 이하 문자 |
||
TYPE |
String |
Y |
발송 타겟팅 선택 : MU , OU, AU 중 택일
MU=>회원 발송. 아이디로 타겟팅,
OU=>전체조직도유저, AU=>전체UMS회원, |
||
CUIDS |
String |
Y |
TYPE : MU 일 경우 필수 값.
1. MU일 경우 UMS 등록된 회원아이디로 보냄.
한건 발송 ex) user1 여러명 발송 ex) [“user1”,”user2”…] 최대 2000명 가능 |
||
RESERVEDATE |
String |
N |
발송예약 날자형식 : YYYY-MM-DD HH:MM . |
||
FRIENDTOLK_SVCID |
String |
Y |
LGCNS톡드림에 등록된 카카오친구톡 서비스아이디 ex)1910028xxxx |
||
FRIENDTOLK_MSG |
String |
Y |
친구톡 메시지. 최대 4000byte |
||
PLUS_ID |
String |
Y |
친구톡 플러스친구 아이디 |
||
KKO_BTN_LINK1 |
String |
N |
카카오톡 챗버블 버튼 버튼 타입: DS: 배송조회, WL: 웹링크, AL: 앱링크, BK: 봇키워드, MD: 메시지전달
MD 예제 : {“name”:”메세지전달”, “type”:”MD”} |
||
KKO_BTN_LINK2 |
String |
N |
|||
KKO_BTN_LINK3 |
String |
N |
|||
KKO_BTN_LINK4 |
String |
N |
|||
KKO_BTN_LINK5 |
String |
N |
|||
SMS_TITLE |
String |
N |
MMS문자일 경우 타이틀. |
||
SMS_MSG |
String |
N |
보낼 문자내용. 90byte이상은 MMS로 발송됩니다. |
||
CALLBACK_NUM |
String |
N |
회신번호. SMS대체발송일 경우 필수 |
||
MMS_IMGURL |
String |
N |
MMS일 경우 이미지 URL: http://xxxx.com/sample.jpg |
||
TYPE : 일반발송 응답 메세지 |
|||||
구분 |
항목 |
값 |
필수 |
반복 |
설명 |
HEADER |
RESULTCODE |
String |
Y |
N |
0000 : 응답 성공 그외 : 에러 메시지 |
RESULTMSG |
String |
Y |
N |
OK : 응답 성공 그외 : 에러 메시지 |
|
BODY |
reserveSeqno |
String |
Y |
예약발송 시퀀스 고유번호. |
|
processInfo |
Object |
Y |
발송진행상태 ex) {“processTxt”: “Completed.”, “processPercent”: “100”} |
||
연동예시
{ "HEADER": { "RESULTCODE": "0000", "RESULTMSG": "OK" }, "BODY": { "reserveSeqno": "220", "processInfo": { "processTxt": "Completed.", "processPercent": "100" } } }
[카카오친구톡] UMS 비회원 발송¶
서비스명 |
친구톡 비회원 발송 |
Controller URL |
/api/umsSendFrtMnApi.ums |
||
---|---|---|---|---|---|
METHOD |
multipart/form-data or application/x-www-form-urlencoded |
||||
설명 |
UMS 비회원 친구톡 발송 |
||||
Request (POST 방식 호출) |
|||||
항목 |
타입 |
필수 |
설명 |
||
SENDERID |
String |
Y |
발송자 정보. 통계정보 사용. Ex) MAILSYSTEM. 제약조건 영문 30byte 이하 문자 |
||
CUIDS |
String |
Y |
한 명 : ex) {“아이디”:[“핸드폰번호”,” 이름”]} 여러명 ex) {“아이디”:[“핸드폰번호”,”이름”], “아이디”:[“핸드폰번호”,이름””]…} P.S:핸드폰번호 : 0001234567 숫자만 입력 아이디 모를 경우 GUEST1,GUEST2… 임의의 아이디 생성하여 보냄. 확인 : 반드시 핸드폰번호는 – 없이 숫자만 입력해 주세요. |
||
FRIENDTOLK_SVCID |
String |
Y |
LGCNS톡드림에 등록된 카카오친구톡 서비스아이디 ex)1910028xxxx |
||
FRIENDTOLK_MSG |
String |
Y |
친구톡 메시지. 최대 4000byte |
||
PLUS_ID |
String |
Y |
친구톡 플러스친구 아이디 |
||
KKO_BTN_LINK1 |
String |
N |
카카오톡 챗버블 버튼 버튼 타입: DS: 배송조회, WL: 웹링크, AL: 앱링크, BK: 봇키워드, MD: 메시지전달
MD 예제 : {“name”:”메세지전달”, “type”:”MD”} |
||
KKO_BTN_LINK2 |
String |
N |
|||
KKO_BTN_LINK3 |
String |
N |
|||
KKO_BTN_LINK4 |
String |
N |
|||
KKO_BTN_LINK5 |
String |
N |
|||
SMS_TITLE |
String |
N |
MMS문자일 경우 타이틀. |
||
SMS_MSG |
String |
N |
보낼 문자내용. 90byte이상은 MMS로 발송됩니다. |
||
MMS_IMGURL |
String |
N |
MMS일 경우 이미지 URL: http://xxxx.com/sample.jpg |
||
CALLBACK_NUM |
String |
N |
회신번호. SMS대체발송일 경우 필수 |
||
TYPE : 일반발송 응답 메세지 |
|||||
구분 |
항목 |
값 |
필수 |
반복 |
설명 |
HEADER |
RESULTCODE |
String |
Y |
N |
0000 : 응답 성공 그외 : 에러 메시지 |
RESULTMSG |
String |
Y |
N |
OK : 응답 성공 그외 : 에러 메시지 |
|
BODY |
processSeqno |
String |
Y |
발송 시퀀스 고유번호. |
|
pushSendCnt |
int |
Y |
푸시 발송수 |
||
kkoAltCnt |
int |
Y |
카카오 알림톡 발송수 |
||
kkoFrtCnt |
int |
Y |
카카오 친구톡 발송수 |
||
smsCnt |
int |
Y |
문자 발송수 |
||
failCnt |
int |
Y |
실패수 |
||
processInfo |
Object |
Y |
발송진행상태 ex) {“processTxt”: “Completed.”, “processPercent”: “100”} |
연동예시
{ "HEADER": { "RESULTCODE": "0000", "RESULTMSG": "OK" }, "BODY": { "kkoAltCnt": "1", "pushSendCnt": "0", "kkoFrtCnt": "0", "smsCnt": "0", "failCnt": 0, "processInfo": { "processTxt": "Completed.", "processPercent": "100" }, "processSeqno": "280" } }
[카카오친구톡] UMS 비회원 / 예약발송¶
서비스명 |
친구톡 비회원 발송 |
Controller URL |
/api/umsSendFrtMnApi.ums |
||
---|---|---|---|---|---|
METHOD |
multipart/form-data or application/x-www-form-urlencoded |
||||
설명 |
UMS 비회원 친구톡 발송 |
||||
Request (POST 방식 호출) |
|||||
항목 |
타입 |
필수 |
설명 |
||
SENDERID |
String |
Y |
발송자 정보. 통계정보 사용. Ex) MAILSYSTEM. 제약조건 영문 30byte 이하 문자 |
||
CUIDS |
String |
Y |
한 명 : ex) {“아이디”:[“핸드폰번호”,이름””]} 여러명 ex) {“아이디”:[“핸드폰번호”,이름””], “아이디”:[“핸드폰번호”,이름””]…} P.S:핸드폰번호 : 0001234567 숫자만 입력 아이디 모를 경우 GUEST1,GUEST2… 임의의 아이디 생성하여 보냄. 확인 : 반드시 핸드폰번호는 – 없이 숫자만 입력해 주세요. |
||
RESERVEDATE |
String |
N |
발송예약 날자형식 : YYYY-MM-DD HH:MM . |
||
FRIENDTOLK_SVCID |
String |
Y |
LGCNS톡드림에 등록된 카카오친구톡 서비스아이디 ex)1910028xxxx |
||
FRIENDTOLK_MSG |
String |
Y |
친구톡 메시지. 최대 4000byte |
||
PLUS_ID |
String |
Y |
친구톡 플러스친구 아이디 |
||
KKO_BTN_LINK1 |
String |
N |
카카오톡 챗버블 버튼 버튼 타입: DS: 배송조회, WL: 웹링크, AL: 앱링크, BK: 봇키워드, MD: 메시지전달
MD 예제 : {“name”:”메세지전달”, “type”:”MD”} |
||
KKO_BTN_LINK2 |
String |
N |
|||
KKO_BTN_LINK3 |
String |
N |
|||
KKO_BTN_LINK4 |
String |
N |
|||
KKO_BTN_LINK5 |
String |
N |
|||
SMS_TITLE |
String |
N |
MMS문자일 경우 타이틀. |
||
SMS_MSG |
String |
N |
보낼 문자내용. 90byte이상은 MMS로 발송됩니다. |
||
CALLBACK_NUM |
String |
N |
회신번호. SMS대체발송일 경우 필수 |
||
MMS_IMGURL |
String |
N |
MMS일 경우 이미지 URL: http://xxxx.com/sample.jpg |
||
TYPE : 일반발송 응답 메세지 |
|||||
구분 |
항목 |
값 |
필수 |
반복 |
설명 |
HEADER |
RESULTCODE |
String |
Y |
N |
0000 : 응답 성공 그외 : 에러 메시지 |
RESULTMSG |
String |
Y |
N |
OK : 응답 성공 그외 : 에러 메시지 |
|
BODY |
reserveSeqno |
String |
Y |
예약발송 시퀀스 고유번호. |
|
processInfo |
Object |
Y |
발송진행상태 ex) {“processTxt”: “Completed.”, “processPercent”: “100”} |
||
연동예시
{ "HEADER": { "RESULTCODE": "0000", "RESULTMSG": "OK" }, "BODY": { "reserveSeqno": "220", "processInfo": { "processTxt": "Completed.", "processPercent": "100" } } }
[카카오친구톡] UMS 회원 / CSV발송 (대량발송 or 치환발송)¶
서비스명 |
친구톡 회원 CSV발송 |
Controller URL |
/api/csvSendFrtApi.ums |
||
---|---|---|---|---|---|
METHOD |
multipart/form-data or application/x-www-form-urlencoded |
||||
설명 |
친구톡 회원 CSV발송 |
||||
Request (POST 방식 호출) |
|||||
항목 |
타입 |
필수 |
설명 |
||
SENDERID |
String |
Y |
발송자 정보. 통계정보 사용. Ex) MAILSYSTEM. 제약조건 영문 30byte 이하 문자 |
||
CSVFILE |
MultipartFile |
Y |
CSV파일을 만들어 첨부한다.
P.S : 1번째 라인 컬럼정보, 2번째 라인부터 데이터
확인 : 푸시만 발송시에는 #{아이디} 하나만 넣어도 됨.
#{이름}, #{핸드폰번호} 생략가능. 회원정보에서 가져옴.
예1) csv파일 비 개인화
#{아이디} 첫번째라인 컬럼정보 헤드
user1
User2 예 2) 개인화 처리 CSV파일 만들기
#{아이디}, #{날자}, #{금액}
user1, 2019-05-01, 4,000
User2, 2019-05-04, 10,000 |
||
FRIENDTOLK_SVCID |
String |
Y |
LGCNS톡드림에 등록된 카카오친구톡 서비스아이디 ex)1910028xxxx |
||
FRIENDTOLK_MSG |
String |
Y |
친구톡 메시지. 최대 4000byte |
||
PLUS_ID |
String |
Y |
친구톡 플러스친구 아이디 |
||
KKO_BTN_LINK1 |
String |
N |
카카오톡 챗버블 버튼 버튼 타입: DS: 배송조회, WL: 웹링크, AL: 앱링크, BK: 봇키워드, MD: 메시지전달
MD 예제 : {“name”:”메세지전달”, “type”:”MD”} |
||
KKO_BTN_LINK2 |
String |
N |
|||
KKO_BTN_LINK3 |
String |
N |
|||
KKO_BTN_LINK4 |
String |
N |
|||
KKO_BTN_LINK5 |
String |
N |
|||
SMS_TITLE |
String |
N |
MMS문자일 경우 타이틀. |
||
SMS_MSG |
String |
N |
보낼 문자내용. 90byte이상은 MMS로 발송됩니다. |
||
MMS_IMGURL |
String |
N |
MMS일 경우 이미지 URL: http://xxxx.com/sample.jpg |
||
CALLBACK_NUM |
String |
N |
회신번호. SMS대체발송일 경우 필수 |
||
TYPE : 일반발송 응답 메세지 |
|||||
구분 |
항목 |
값 |
필수 |
반복 |
설명 |
HEADER |
RESULTCODE |
String |
Y |
N |
0000 : 응답 성공 그외 : 에러 메시지 |
RESULTMSG |
String |
Y |
N |
OK : 응답 성공 그외 : 에러 메시지 |
|
BODY |
processSeqno |
String |
Y |
발송 시퀀스 고유번호. |
|
pushSendCnt |
int |
Y |
푸시 발송수 |
||
kkoAltCnt |
int |
Y |
카카오 알림톡 발송수 |
||
kkoFrtCnt |
int |
Y |
카카오 친구톡 발송수 |
||
smsCnt |
int |
Y |
문자 발송수 |
||
failCnt |
int |
Y |
실패수 |
||
processInfo |
Object |
Y |
발송진행상태 ex) {“processTxt”: “Completed.”, “processPercent”: “100”} |
연동예시
{ "HEADER": { "RESULTCODE": "0000", "RESULTMSG": "OK" }, "BODY": { "kkoAltCnt": "1", "pushSendCnt": "0", "kkoFrtCnt": "0", "smsCnt": "0", "failCnt": 0, "processInfo": { "processTxt": "Completed.", "processPercent": "100" }, "processSeqno": "280" } }
[카카오친구톡] UMS 회원 / CSV예약발송 (대량발송 or 치환발송)¶
서비스명 |
친구톡 회원 CSV 발송 |
Controller URL |
/api/csvSendFrtApi.ums |
||
---|---|---|---|---|---|
METHOD |
multipart/form-data or application/x-www-form-urlencoded |
||||
설명 |
친구톡 회원 CSV 발송 |
||||
Request (POST 방식 호출) |
|||||
항목 |
타입 |
필수 |
설명 |
||
SENDERID |
String |
Y |
발송자 정보. 통계정보 사용. Ex) MAILSYSTEM. 제약조건 영문 30byte 이하 문자 |
||
CSVFILE |
MultipartFile |
Y |
CSV파일을 만들어 첨부한다.
P.S : 1번째 라인 컬럼정보, 2번째 라인부터 데이터
확인 : 푸시만 발송시에는 #{아이디} 하나만 넣어도 됨.
#{이름}, #{핸드폰번호} 생략가능. 회원정보에서 가져옴.
예1) csv파일 비 개인화
#{아이디} 첫번째라인 컬럼정보 헤드
user1
User2 예 2) 개인화 처리 CSV파일 만들기
#{아이디}, #{날자}, #{금액}
user1, 2019-05-01, 4,000
User2, 2019-05-04, 10,000 |
||
RESERVEDATE |
String |
N |
발송예약 날자형식 : YYYY-MM-DD HH:MM . |
||
FRIENDTOLK_SVCID |
String |
Y |
LGCNS톡드림에 등록된 카카오친구톡 서비스아이디 ex)1910028xxxx |
||
FRIENDTOLK_MSG |
String |
Y |
친구톡 메시지. 최대 4000byte |
||
PLUS_ID |
String |
Y |
친구톡 플러스친구 아이디 |
||
KKO_BTN_LINK1 |
String |
N |
카카오톡 챗버블 버튼 버튼 타입: DS: 배송조회, WL: 웹링크, AL: 앱링크, BK: 봇키워드, MD: 메시지전달
MD 예제 : {“name”:”메세지전달”, “type”:”MD”} |
||
KKO_BTN_LINK2 |
String |
N |
|||
KKO_BTN_LINK3 |
String |
N |
|||
KKO_BTN_LINK4 |
String |
N |
|||
KKO_BTN_LINK5 |
String |
N |
|||
SMS_TITLE |
String |
N |
MMS문자일 경우 타이틀. |
||
SMS_MSG |
String |
N |
보낼 문자내용. 90byte이상은 MMS로 발송됩니다. |
||
CALLBACK_NUM |
String |
N |
회신번호. SMS대체발송일 경우 필수 |
||
MMS_IMGURL |
String |
N |
MMS일 경우 이미지 URL: http://xxxx.com/sample.jpg |
||
TYPE : 일반발송 응답 메세지 |
|||||
구분 |
항목 |
값 |
필수 |
반복 |
설명 |
HEADER |
RESULTCODE |
String |
Y |
N |
0000 : 응답 성공 그외 : 에러 메시지 |
RESULTMSG |
String |
Y |
N |
OK : 응답 성공 그외 : 에러 메시지 |
|
BODY |
reserveSeqno |
String |
Y |
예약발송 시퀀스 고유번호. |
|
processInfo |
Object |
Y |
발송진행상태 ex) {“processTxt”: “Completed.”, “processPercent”: “100”} |
||
연동예시
{ "HEADER": { "RESULTCODE": "0000", "RESULTMSG": "OK" }, "BODY": { "reserveSeqno": "220", "processInfo": { "processTxt": "Completed.", "processPercent": "100" } } }
[카카오친구톡] UMS 비회원 / CSV발송 (대량발송 or 치환발송)¶
서비스명 |
친구톡 비회원 CSV발송 |
Controller URL |
/api/csvSendFrtMnApi.ums |
||
---|---|---|---|---|---|
METHOD |
multipart/form-data or application/x-www-form-urlencoded |
||||
설명 |
친구톡 비회원 CSV발송 |
||||
Request (POST 방식 호출) |
|||||
항목 |
타입 |
필수 |
설명 |
||
SENDERID |
String |
Y |
발송자 정보. 통계정보 사용. Ex) MAILSYSTEM. 제약조건 영문 30byte 이하 문자 |
||
CSVFILE |
MultipartFile |
Y |
CSV파일을 만들어 첨부한다.
P.S : 1번째 라인 컬럼정보, 2번째 라인부터 데이터
확인 : 발송시에는 #{아이디},#{이름}, #{핸드폰번호} 반드시 넣어야 함. 예1) csv파일 비 개인화
#{아이디}, #{이름}, #{핸드폰번호} 첫번째라인 컬럼정보 헤드
user1, 홍길동1, 01000011111
User2, 홍길동2, 01000002222 예 2) 개인화 처리 CSV파일 만들기
#{아이디}, #{이름}, #{핸드폰번호}, #{날자}, #{금액}
user1, 홍길동1, 01000011111, 2019-05-01, 4,000
User2, 홍길동1, 01000011111, 2019-05-04, 10,000 확인 : 반드시 핸드폰번호는 – 없이 숫자만 입력해 주세요. |
||
FRIENDTOLK_SVCID |
String |
Y |
LGCNS톡드림에 등록된 카카오친구톡 서비스아이디 ex)1910028xxxx |
||
FRIENDTOLK_MSG |
String |
Y |
친구톡 메시지. 최대 4000byte |
||
PLUS_ID |
String |
Y |
친구톡 플러스친구 아이디 |
||
KKO_BTN_LINK1 |
String |
N |
카카오톡 챗버블 버튼 버튼 타입: DS: 배송조회, WL: 웹링크, AL: 앱링크, BK: 봇키워드, MD: 메시지전달
MD 예제 : {“name”:”메세지전달”, “type”:”MD”} |
||
KKO_BTN_LINK2 |
String |
N |
|||
KKO_BTN_LINK3 |
String |
N |
|||
KKO_BTN_LINK4 |
String |
N |
|||
KKO_BTN_LINK5 |
String |
N |
|||
SMS_TITLE |
String |
N |
MMS문자일 경우 타이틀. |
||
SMS_MSG |
String |
N |
보낼 문자내용. 90byte이상은 MMS로 발송됩니다. |
||
MMS_IMGURL |
String |
N |
MMS일 경우 이미지 URL: http://xxxx.com/sample.jpg |
||
CALLBACK_NUM |
String |
N |
회신번호. SMS대체발송일 경우 필수 |
||
TYPE : 일반발송 응답 메세지 |
|||||
구분 |
항목 |
값 |
필수 |
반복 |
설명 |
HEADER |
RESULTCODE |
String |
Y |
N |
0000 : 응답 성공 그외 : 에러 메시지 |
RESULTMSG |
String |
Y |
N |
OK : 응답 성공 그외 : 에러 메시지 |
|
BODY |
processSeqno |
String |
Y |
발송 시퀀스 고유번호. |
|
pushSendCnt |
int |
Y |
푸시 발송수 |
||
kkoAltCnt |
int |
Y |
카카오 알림톡 발송수 |
||
kkoFrtCnt |
int |
Y |
카카오 친구톡 발송수 |
||
smsCnt |
int |
Y |
문자 발송수 |
||
failCnt |
int |
Y |
실패수 |
||
processInfo |
Object |
Y |
발송진행상태 ex) {“processTxt”: “Completed.”, “processPercent”: “100”} |
연동예시
{ "HEADER": { "RESULTCODE": "0000", "RESULTMSG": "OK" }, "BODY": { "kkoAltCnt": "1", "pushSendCnt": "0", "kkoFrtCnt": "0", "smsCnt": "0", "failCnt": 0, "processInfo": { "processTxt": "Completed.", "processPercent": "100" }, "processSeqno": "280" } }
[카카오친구톡] UMS 비회원 / CSV예약발송 (대량발송 or 치환발송)¶
서비스명 |
친구톡 비회원 CSV예약발송 |
Controller URL |
/api/csvSendFrtMnApi.ums |
||
---|---|---|---|---|---|
METHOD |
multipart/form-data or application/x-www-form-urlencoded |
||||
설명 |
친구톡 비회원 CSV예약발송 |
||||
Request (POST 방식 호출) |
|||||
항목 |
타입 |
필수 |
설명 |
||
SENDERID |
String |
Y |
발송자 정보. 통계정보 사용. Ex) MAILSYSTEM. 제약조건 영문 30byte 이하 문자 |
||
CSVFILE |
MultipartFile |
Y |
CSV파일을 만들어 첨부한다.
P.S : 1번째 라인 컬럼정보, 2번째 라인부터 데이터
확인 : 발송시에는 #{아이디},#{이름}, #{핸드폰번호} 반드시 넣어야 함. 예1) csv파일 비 개인화
#{아이디}, #{이름}, #{핸드폰번호} 첫번째라인 컬럼정보 헤드
user1, 홍길동1, 01000011111
User2, 홍길동2, 01000002222 예 2) 개인화 처리 CSV파일 만들기
#{아이디}, #{이름}, #{핸드폰번호}, #{날자}, #{금액}
user1, 홍길동1, 01000011111, 2019-05-01, 4,000
User2, 홍길동1, 01000011111, 2019-05-04, 10,000 확인 : 반드시 핸드폰번호는 – 없이 숫자만 입력해 주세요. |
||
RESERVEDATE |
String |
N |
발송예약 날자형식 : YYYY-MM-DD HH:MM . |
||
FRIENDTOLK_SVCID |
String |
Y |
LGCNS톡드림에 등록된 카카오친구톡 서비스아이디 ex)1910028xxxx |
||
FRIENDTOLK_MSG |
String |
Y |
친구톡 메시지. 최대 4000byte |
||
PLUS_ID |
String |
Y |
친구톡 플러스친구 아이디 |
||
KKO_BTN_LINK1 |
String |
N |
카카오톡 챗버블 버튼 버튼 타입: DS: 배송조회, WL: 웹링크, AL: 앱링크, BK: 봇키워드, MD: 메시지전달
MD 예제 : {“name”:”메세지전달”, “type”:”MD”} |
||
KKO_BTN_LINK2 |
String |
N |
|||
KKO_BTN_LINK3 |
String |
N |
|||
KKO_BTN_LINK4 |
String |
N |
|||
KKO_BTN_LINK5 |
String |
N |
|||
SMS_TITLE |
String |
N |
MMS문자일 경우 타이틀. |
||
SMS_MSG |
String |
N |
보낼 문자내용. 90byte이상은 MMS로 발송됩니다. |
||
CALLBACK_NUM |
String |
N |
회신번호. SMS대체발송일 경우 필수 |
||
MMS_IMGURL |
String |
N |
MMS일 경우 이미지 URL: http://xxxx.com/sample.jpg |
||
TYPE : 일반발송 응답 메세지 |
|||||
구분 |
항목 |
값 |
필수 |
반복 |
설명 |
HEADER |
RESULTCODE |
String |
Y |
N |
0000 : 응답 성공 그외 : 에러 메시지 |
RESULTMSG |
String |
Y |
N |
OK : 응답 성공 그외 : 에러 메시지 |
|
BODY |
reserveSeqno |
String |
Y |
예약발송 시퀀스 고유번호. |
|
processInfo |
Object |
Y |
발송진행상태 ex) {“processTxt”: “Completed.”, “processPercent”: “100”} |
||
연동예시
{ "HEADER": { "RESULTCODE": "0000", "RESULTMSG": "OK" }, "BODY": { "reserveSeqno": "220", "processInfo": { "processTxt": "Completed.", "processPercent": "100" } } }
[SMS] UMS 회원 발송¶
서비스명 |
SMS UMS 회원발송 |
Controller URL |
/api/umsSendSmsApi.ums |
||
---|---|---|---|---|---|
METHOD |
multipart/form-data or application/x-www-form-urlencoded |
||||
설명 |
UMS 회원 SMS 발송 |
||||
Request (POST 방식 호출) |
|||||
항목 |
타입 |
필수 |
설명 |
||
SENDERID |
String |
Y |
발송자 정보. 통계정보 사용. Ex) MAILSYSTEM. 제약조건 영문 30byte 이하 문자 |
||
TYPE |
String |
Y |
발송 타겟팅 선택 : MU , OU, AU 중 택일
MU=>회원 발송. 아이디로 타겟팅,
OU=>전체조직도유저, AU=>전체UMS회원, |
||
CUIDS |
String |
Y |
TYPE : MU 일 경우 필수 값.
1. MU일 경우 UMS 등록된 회원아이디로 보냄.
한건 발송 ex) user1 여러명 발송 ex) [“user1”,”user2”…] 최대 2000명 가능 |
||
SMS_TITLE |
String |
N |
MMS문자일 경우 타이틀 |
||
SMS_MSG |
String |
N |
보낼 문자내용. 90byte 이상일 경우 MMS로 발송됨. |
||
CALLBACK_NUM |
String |
N |
회신번호. SMS대체발송일 경우 필수 |
||
MMS_IMGURL |
String |
N |
MMS일 경우 이미지 URL: http://xxxx.com/sample.jpg |
||
TYPE : 일반발송 응답 메세지 |
|||||
구분 |
항목 |
값 |
필수 |
반복 |
설명 |
HEADER |
RESULTCODE |
String |
Y |
N |
0000 : 응답 성공 그외 : 에러 메시지 |
RESULTMSG |
String |
Y |
N |
OK : 응답 성공 그외 : 에러 메시지 |
|
BODY |
processSeqno |
String |
Y |
발송 시퀀스 고유번호. |
|
pushSendCnt |
int |
Y |
푸시 발송수 |
||
kkoAltCnt |
int |
Y |
카카오 알림톡 발송수 |
||
kkoFrtCnt |
int |
Y |
카카오 친구톡 발송수 |
||
smsCnt |
int |
Y |
문자 발송수 |
||
failCnt |
int |
Y |
실패수 |
||
processInfo |
Object |
Y |
발송진행상태 ex) {“processTxt”: “Completed.”, “processPercent”: “100”} |
연동예시
{ "HEADER": { "RESULTCODE": "0000", "RESULTMSG": "OK" }, "BODY": { "kkoAltCnt": "0", "pushSendCnt": "0", "kkoFrtCnt": "0", "smsCnt": "1", "failCnt": 0, "processInfo": { "processTxt": "Completed.", "processPercent": "100" }, "processSeqno": "280" } }
SMS API¶
[SMS] UMS 회원 / 예약발송¶
서비스명 |
SMS UMS 회원 예약발송 |
Controller URL |
/api/umsSendSmsApi.ums |
||
---|---|---|---|---|---|
METHOD |
multipart/form-data or application/x-www-form-urlencoded |
||||
설명 |
UMS 회원 SMS 예약발송 |
||||
Request (POST 방식 호출) |
|||||
항목 |
타입 |
필수 |
설명 |
||
SENDERID |
String |
Y |
발송자 정보. 통계정보 사용. Ex) MAILSYSTEM. 제약조건 영문 30byte 이하 문자 |
||
TYPE |
String |
Y |
발송 타겟팅 선택 : MU , OU, AU 중 택일
MU=>회원 발송. 아이디로 타겟팅,
OU=>전체조직도유저, AU=>전체UMS회원, |
||
CUIDS |
String |
Y |
TYPE : MU 일 경우 필수 값.
1. MU일 경우 UMS 등록된 회원아이디로 보냄.
한건 발송 ex) user1 여러명 발송 ex) [“user1”,”user2”…] 최대 2000명 가능 |
||
RESERVEDATE |
String |
N |
발송예약 날자형식 : YYYY-MM-DD HH:MM . |
||
SMS_TITLE |
String |
N |
MMS문자일 경우 타이틀 |
||
SMS_MSG |
String |
N |
보낼 문자내용. 90byte 이상일 경우 MMS로 발송됨. |
||
CALLBACK_NUM |
String |
N |
회신번호. SMS대체발송일 경우 필수 |
||
MMS_IMGURL |
String |
N |
MMS일 경우 이미지 URL: http://xxxx.com/sample.jpg |
||
TYPE : 일반발송 응답 메세지 |
|||||
구분 |
항목 |
값 |
필수 |
반복 |
설명 |
HEADER |
RESULTCODE |
String |
Y |
N |
0000 : 응답 성공 그외 : 에러 메시지 |
RESULTMSG |
String |
Y |
N |
OK : 응답 성공 그외 : 에러 메시지 |
|
BODY |
reserveSeqno |
String |
Y |
예약발송 시퀀스 고유번호. |
|
processInfo |
Object |
Y |
발송진행상태 ex) {“processTxt”: “Completed.”, “processPercent”: “100”} |
||
연동예시
{ "HEADER": { "RESULTCODE": "0000", "RESULTMSG": "OK" }, "BODY": { "reserveSeqno": "220", "processInfo": { "processTxt": "Completed.", "processPercent": "100" } } }
[SMS] UMS 비회원 발송¶
서비스명 |
SMS 비회원 발송 |
Controller URL |
/api/umsSendSmsMnApi.ums |
||
---|---|---|---|---|---|
METHOD |
multipart/form-data or application/x-www-form-urlencoded |
||||
설명 |
SMS 비회원 발송 |
||||
Request (POST 방식 호출) |
|||||
항목 |
타입 |
필수 |
설명 |
||
SENDERID |
String |
Y |
발송자 정보. 통계정보 사용. Ex) MAILSYSTEM. 제약조건 영문 30byte 이하 문자 |
||
CUIDS |
String |
Y |
한 명 : ex) {“아이디”:[“핸드폰번호”,이름””]} 여러명 ex) {“아이디”:[“핸드폰번호”,이름””], “아이디”:[“핸드폰번호”,이름””]…} P.S:핸드폰번호 : 0001234567 숫자만 입력 아이디 모를 경우 GUEST1,GUEST2… 임의의 아이디 생성하여 보냄. 확인 : 반드시 핸드폰번호는 – 없이 숫자만 입력해 주세요. |
||
SMS_TITLE |
String |
N |
MMS문자일 경우 타이틀. |
||
SMS_MSG |
String |
N |
보낼 문자내용. 90byte이상은 MMS로 발송됩니다. |
||
CALLBACK_NUM |
String |
N |
회신번호. SMS대체발송일 경우 필수 |
||
MMS_IMGURL |
String |
N |
MMS일 경우 이미지 URL: http://xxxx.com/sample.jpg |
||
TYPE : 일반발송 응답 메세지 |
|||||
구분 |
항목 |
값 |
필수 |
반복 |
설명 |
HEADER |
RESULTCODE |
String |
Y |
N |
0000 : 응답 성공 그외 : 에러 메시지 |
RESULTMSG |
String |
Y |
N |
OK : 응답 성공 그외 : 에러 메시지 |
|
BODY |
processSeqno |
String |
Y |
발송 시퀀스 고유번호. |
|
pushSendCnt |
int |
Y |
푸시 발송수 |
||
kkoAltCnt |
int |
Y |
카카오 알림톡 발송수 |
||
kkoFrtCnt |
int |
Y |
카카오 친구톡 발송수 |
||
smsCnt |
int |
Y |
문자 발송수 |
||
failCnt |
int |
Y |
실패수 |
||
processInfo |
Object |
Y |
발송진행상태 ex) {“processTxt”: “Completed.”, “processPercent”: “100”} |
연동예시
{ "HEADER": { "RESULTCODE": "0000", "RESULTMSG": "OK" }, "BODY": { "kkoAltCnt": "0", "pushSendCnt": "0", "kkoFrtCnt": "0", "smsCnt": "1", "failCnt": 0, "processInfo": { "processTxt": "Completed.", "processPercent": "100" }, "processSeqno": "280" } }
[SMS] UMS 비회원 / 예약발송¶
서비스명 |
SMS 비회원 발송 |
Controller URL |
/api/umsSendSmsMnApi.ums |
||
---|---|---|---|---|---|
METHOD |
multipart/form-data or application/x-www-form-urlencoded |
||||
설명 |
SMS 비회원 발송 |
||||
Request (POST 방식 호출) |
|||||
항목 |
타입 |
필수 |
설명 |
||
SENDERID |
String |
Y |
발송자 정보. 통계정보 사용. Ex) MAILSYSTEM. 제약조건 영문 30byte 이하 문자 |
||
CUIDS |
String |
Y |
한 명 : ex) {“아이디”:[“핸드폰번호”,이름””]} 여러명 ex) {“아이디”:[“핸드폰번호”,이름””], “아이디”:[“핸드폰번호”,이름””]…} P.S:핸드폰번호 : 0001234567 숫자만 입력 아이디 모를 경우 GUEST1,GUEST2… 임의의 아이디 생성하여 보냄. 확인 : 반드시 핸드폰번호는 – 없이 숫자만 입력해 주세요. |
||
RESERVEDATE |
String |
N |
발송예약 날자형식 : YYYY-MM-DD HH:MM . |
||
SMS_TITLE |
String |
N |
MMS문자일 경우 타이틀. |
||
SMS_MSG |
String |
N |
보낼 문자내용. 90byte이상은 MMS로 발송됩니다. |
||
CALLBACK_NUM |
String |
N |
회신번호. SMS대체발송일 경우 필수 |
||
MMS_IMGURL |
String |
N |
MMS일 경우 이미지 URL: http://xxxx.com/sample.jpg |
||
TYPE : 일반발송 응답 메세지 |
|||||
구분 |
항목 |
값 |
필수 |
반복 |
설명 |
HEADER |
RESULTCODE |
String |
Y |
N |
0000 : 응답 성공 그외 : 에러 메시지 |
RESULTMSG |
String |
Y |
N |
OK : 응답 성공 그외 : 에러 메시지 |
|
BODY |
reserveSeqno |
String |
Y |
예약발송 시퀀스 고유번호. |
|
processInfo |
Object |
Y |
발송진행상태 ex) {“processTxt”: “Completed.”, “processPercent”: “100”} |
||
연동예시
{ "HEADER": { "RESULTCODE": "0000", "RESULTMSG": "OK" }, "BODY": { "reserveSeqno": "220", "processInfo": { "processTxt": "Completed.", "processPercent": "100" } } }
[SMS] UMS 회원 / CSV발송 (대량발송 or 치환발송)¶
서비스명 |
SMS 회원 CSV발송 |
Controller URL |
/api/csvSendSmsApi.ums |
||
---|---|---|---|---|---|
METHOD |
multipart/form-data or application/x-www-form-urlencoded |
||||
설명 |
SMS 회원 CSV발송 |
||||
Request (POST 방식 호출) |
|||||
항목 |
타입 |
필수 |
설명 |
||
SENDERID |
String |
Y |
발송자 정보. 통계정보 사용. Ex) MAILSYSTEM. 제약조건 영문 30byte 이하 문자 |
||
CSVFILE |
MultipartFile |
Y |
CSV파일을 만들어 첨부한다.
P.S : 1번째 라인 컬럼정보, 2번째 라인부터 데이터
확인 : 푸시만 발송시에는 #{아이디} 하나만 넣어도 됨.
#{이름}, #{핸드폰번호} 생략가능. 회원정보에서 가져옴.
예1) csv파일 비 개인화
#{아이디} 첫번째라인 컬럼정보 헤드
user1
User2 예 2) 개인화 처리 CSV파일 만들기
#{아이디}, #{날자}, #{금액}
user1, 2019-05-01, 4,000
User2, 2019-05-04, 10,000 |
||
SMS_TITLE |
String |
N |
MMS문자일 경우 타이틀. |
||
SMS_MSG |
String |
N |
보낼 문자내용. 90byte이상은 MMS로 발송됩니다. |
||
CALLBACK_NUM |
String |
N |
회신번호. SMS대체발송일 경우 필수 |
||
MMS_IMGURL |
String |
N |
MMS일 경우 이미지 URL: http://xxxx.com/sample.jpg |
||
TYPE : 일반발송 응답 메세지 |
|||||
구분 |
항목 |
값 |
필수 |
반복 |
설명 |
HEADER |
RESULTCODE |
String |
Y |
N |
0000 : 응답 성공 그외 : 에러 메시지 |
RESULTMSG |
String |
Y |
N |
OK : 응답 성공 그외 : 에러 메시지 |
|
BODY |
processSeqno |
String |
Y |
발송 시퀀스 고유번호. |
|
pushSendCnt |
int |
Y |
푸시 발송수 |
||
kkoAltCnt |
int |
Y |
카카오 알림톡 발송수 |
||
kkoFrtCnt |
int |
Y |
카카오 친구톡 발송수 |
||
smsCnt |
int |
Y |
문자 발송수 |
||
failCnt |
int |
Y |
실패수 |
||
processInfo |
Object |
Y |
발송진행상태 ex) {“processTxt”: “Completed.”, “processPercent”: “100”} |
연동예시
{ "HEADER": { "RESULTCODE": "0000", "RESULTMSG": "OK" }, "BODY": { "kkoAltCnt": "0", "pushSendCnt": "0", "kkoFrtCnt": "0", "smsCnt": "1", "failCnt": 0, "processInfo": { "processTxt": "Completed.", "processPercent": "100" }, "processSeqno": "280" } }
[SMS] UMS 회원 / CSV예약발송 (대량발송 or 치환발송)¶
서비스명 |
SMS 회원 CSV예약발송 |
Controller URL |
/api/ csvSendSmsApi.ums |
||
---|---|---|---|---|---|
METHOD |
multipart/form-data or application/x-www-form-urlencoded |
||||
설명 |
SMS 회원 CSV예약발송 |
||||
Request (POST 방식 호출) |
|||||
항목 |
타입 |
필수 |
설명 |
||
SENDERID |
String |
Y |
발송자 정보. 통계정보 사용. Ex) MAILSYSTEM. 제약조건 영문 30byte 이하 문자 |
||
CSVFILE |
MultipartFile |
Y |
CSV파일을 만들어 첨부한다.
P.S : 1번째 라인 컬럼정보, 2번째 라인부터 데이터
확인 : 푸시만 발송시에는 #{아이디} 하나만 넣어도 됨.
#{이름}, #{핸드폰번호} 생략가능. 회원정보에서 가져옴.
예1) csv파일 비 개인화
#{아이디} 첫번째라인 컬럼정보 헤드
user1
User2 예 2) 개인화 처리 CSV파일 만들기
#{아이디}, #{날자}, #{금액}
user1, 2019-05-01, 4,000
User2, 2019-05-04, 10,000 |
||
RESERVEDATE |
String |
N |
발송예약 날자형식 : YYYY-MM-DD HH:MM . |
||
SMS_TITLE |
String |
N |
MMS문자일 경우 타이틀. |
||
SMS_MSG |
String |
N |
보낼 문자내용. 90byte이상은 MMS로 발송됩니다. |
||
CALLBACK_NUM |
String |
N |
회신번호. SMS대체발송일 경우 필수 |
||
MMS_IMGURL |
String |
N |
MMS일 경우 이미지 URL: http://xxxx.com/sample.jpg |
||
TYPE : 일반발송 응답 메세지 |
|||||
구분 |
항목 |
값 |
필수 |
반복 |
설명 |
HEADER |
RESULTCODE |
String |
Y |
N |
0000 : 응답 성공 그외 : 에러 메시지 |
RESULTMSG |
String |
Y |
N |
OK : 응답 성공 그외 : 에러 메시지 |
|
BODY |
reserveSeqno |
String |
Y |
예약발송 시퀀스 고유번호. |
|
processInfo |
Object |
Y |
발송진행상태 ex) {“processTxt”: “Completed.”, “processPercent”: “100”} |
||
연동예시
{ "HEADER": { "RESULTCODE": "0000", "RESULTMSG": "OK" }, "BODY": { "reserveSeqno": "220", "processInfo": { "processTxt": "Completed.", "processPercent": "100" } } }
[SMS] UMS 비회원 / CSV발송 (대량발송 or 메시지 치환발송)¶
서비스명 |
SMS 비회원 CSV발송 |
Controller URL |
/api/csvSendSmsMnApi.ums |
||
---|---|---|---|---|---|
METHOD |
multipart/form-data or application/x-www-form-urlencoded |
||||
설명 |
SMS 비회원 CSV발송 |
||||
Request (POST 방식 호출) |
|||||
항목 |
타입 |
필수 |
설명 |
||
SENDERID |
String |
Y |
발송자 정보. 통계정보 사용. Ex) MAILSYSTEM. 제약조건 영문 30byte 이하 문자 |
||
CSVFILE |
MultipartFile |
Y |
CSV파일을 만들어 첨부한다.
P.S : 1번째 라인 컬럼정보, 2번째 라인부터 데이터
확인 : 발송시에는 #{아이디},#{이름}, #{핸드폰번호} 반드시 넣어야 함. 예1) csv파일 비 개인화
#{아이디}, #{이름}, #{핸드폰번호} 첫번째라인 컬럼정보 헤드
user1, 홍길동1, 01000011111
User2, 홍길동2, 01000002222 예 2) 개인화 처리 CSV파일 만들기
#{아이디}, #{이름}, #{핸드폰번호}, #{날자}, #{금액}
user1, 홍길동1, 01000011111, 2019-05-01, 4,000
User2, 홍길동1, 01000011111, 2019-05-04, 10,000 확인 : 반드시 핸드폰번호는 – 없이 숫자만 입력해 주세요. |
||
SMS_TITLE |
String |
N |
MMS문자일 경우 타이틀. |
||
SMS_MSG |
String |
N |
보낼 문자내용. 90byte이상은 MMS로 발송됩니다. |
||
CALLBACK_NUM |
String |
N |
회신번호. SMS대체발송일 경우 필수 |
||
MMS_IMGURL |
String |
N |
MMS일 경우 이미지 URL: http://xxxx.com/sample.jpg |
||
TYPE : 일반발송 응답 메세지 |
|||||
구분 |
항목 |
값 |
필수 |
반복 |
설명 |
HEADER |
RESULTCODE |
String |
Y |
N |
0000 : 응답 성공 그외 : 에러 메시지 |
RESULTMSG |
String |
Y |
N |
OK : 응답 성공 그외 : 에러 메시지 |
|
BODY |
processSeqno |
String |
Y |
발송 시퀀스 고유번호. |
|
pushSendCnt |
int |
Y |
푸시 발송수 |
||
kkoAltCnt |
int |
Y |
카카오 알림톡 발송수 |
||
kkoFrtCnt |
int |
Y |
카카오 친구톡 발송수 |
||
smsCnt |
int |
Y |
문자 발송수 |
||
failCnt |
int |
Y |
실패수 |
||
processInfo |
Object |
Y |
발송진행상태 ex) {“processTxt”: “Completed.”, “processPercent”: “100”} |
연동예시
{ "HEADER": { "RESULTCODE": "0000", "RESULTMSG": "OK" }, "BODY": { "kkoAltCnt": "0", "pushSendCnt": "0", "kkoFrtCnt": "0", "smsCnt": "1", "failCnt": 0, "processInfo": { "processTxt": "Completed.", "processPercent": "100" }, "processSeqno": "280" } }
[SMS] UMS 비회원 / CSV예약발송 (대량발송 or 메시지 치환발송)¶
서비스명 |
SMS 비회원 CSV예약발송 |
Controller URL |
/api/csvSendSmsMnApi.ums |
||
---|---|---|---|---|---|
METHOD |
multipart/form-data or application/x-www-form-urlencoded |
||||
설명 |
SMS 비회원 CSV예약발송 |
||||
Request (POST 방식 호출) |
|||||
항목 |
타입 |
필수 |
설명 |
||
SENDERID |
String |
Y |
발송자 정보. 통계정보 사용. Ex) MAILSYSTEM. 제약조건 영문 30byte 이하 문자 |
||
CSVFILE |
MultipartFile |
Y |
CSV파일을 만들어 첨부한다.
P.S : 1번째 라인 컬럼정보, 2번째 라인부터 데이터
확인 : 발송시에는 #{아이디},#{이름}, #{핸드폰번호} 반드시 넣어야 함. 예1) csv파일 비 개인화
#{아이디}, #{이름}, #{핸드폰번호} 첫번째라인 컬럼정보 헤드
user1, 홍길동1, 01000011111
User2, 홍길동2, 01000002222 예 2) 개인화 처리 CSV파일 만들기
#{아이디}, #{이름}, #{핸드폰번호}, #{날자}, #{금액}
user1, 홍길동1, 01000011111, 2019-05-01, 4,000
User2, 홍길동1, 01000011111, 2019-05-04, 10,000 확인 : 반드시 핸드폰번호는 – 없이 숫자만 입력해 주세요. |
||
RESERVEDATE |
String |
N |
발송예약 날자형식 : YYYY-MM-DD HH:MM . |
||
SMS_TITLE |
String |
N |
MMS문자일 경우 타이틀. |
||
SMS_MSG |
String |
N |
보낼 문자내용. 90byte이상은 MMS로 발송됩니다. |
||
CALLBACK_NUM |
String |
N |
회신번호. SMS대체발송일 경우 필수 |
||
MMS_IMGURL |
String |
N |
MMS일 경우 이미지 URL: http://xxxx.com/sample.jpg |
||
TYPE : 일반발송 응답 메세지 |
|||||
구분 |
항목 |
값 |
필수 |
반복 |
설명 |
HEADER |
RESULTCODE |
String |
Y |
N |
0000 : 응답 성공 그외 : 에러 메시지 |
RESULTMSG |
String |
Y |
N |
OK : 응답 성공 그외 : 에러 메시지 |
|
BODY |
reserveSeqno |
String |
Y |
예약발송 시퀀스 고유번호. |
|
processInfo |
Object |
Y |
발송진행상태 ex) {“processTxt”: “Completed.”, “processPercent”: “100”} |
||
연동예시
{ "HEADER": { "RESULTCODE": "0000", "RESULTMSG": "OK" }, "BODY": { "reserveSeqno": "220", "processInfo": { "processTxt": "Completed.", "processPercent": "100" } } }
UMS 회원관리 API¶
[UMS회원관리]회원 조회 API¶
서비스명 |
대쉬보드 검색조건 |
Controller URL |
/umsMember/selUmsMember.ums |
||
---|---|---|---|---|---|
METHOD |
POST content-type : application/x-www-form-urlencoded |
||||
설명 |
UMS 등록회원 정보조회 |
||||
요청 : Request parameter : application/x-www-form-urlencoded |
|||||
항목 |
타입 |
필수 |
설명 |
||
MEMBERID |
String |
Y |
조회 할 UMS아이디 |
||
응답 : Response TYPE : JSON |
|||||
구분 |
항목 |
값 |
필수 |
반복 |
설명 |
HEADER |
RESULTCODE |
String |
Y |
N |
0000 : 응답 성공 그외 : 에러 메시지 |
RESULTMSG |
String |
Y |
N |
OK : 응답 성공 그외 : 에러 메시지 |
|
BODY |
MEMBERINFO |
Array<Object> |
Y |
UMS 회원정보 리스트 |
|
연동예시
{ "HEADER": { "RESULTCODE": "0000", "RESULTMSG": "OK" }, "BODY": { "MEMBERINFO": [ { "MEMBERID": "aaa", "MEMBERNAME": "aaa", "MOBILE": "01098782095", "ORGANID": "", "VAR1": "", "VAR2": "", "VAR3": "", "VAR4": "", "VAR5": "", "REGDATE": "2019-12-23 11:19:11.0", "EDITDATE": "2019-12-23 11:19:11.0" } ] } }
[UMS회원관리]회원 등록 API¶
서비스명 |
대쉬보드 검색조건 |
Controller URL |
/umsMember/inUmsMember.ums |
||
---|---|---|---|---|---|
METHOD |
POST content-type : application/x-www-form-urlencoded |
||||
설명 |
UMS 회원등록API |
||||
요청 : Request parameter : application/x-www-form-urlencoded |
|||||
항목 |
타입 |
필수 |
설명 |
||
MEMBERID |
String |
Y |
UMS아이디 |
||
MEMBERNAME |
String |
Y |
이름 |
||
MOBILE |
String |
Y |
핸드폰번호(숫자만 기입) ex)01012345678 |
||
ORGANID |
String |
N |
UMS 조직도에 만든 조직코드 |
||
VAR1 |
String |
N |
예비회원정보1 |
||
VAR2 |
String |
N |
예비회원정보2 |
||
VAR3 |
String |
N |
예비회원정보3 |
||
VAR4 |
String |
N |
예비회원정보4 |
||
VAR5 |
String |
N |
예비회원정보5 |
||
응답 : Response TYPE : JSON |
|||||
구분 |
항목 |
값 |
필수 |
반복 |
설명 |
HEADER |
RESULTCODE |
String |
Y |
N |
0000 : 응답 성공 그외 : 에러 메시지 |
RESULTMSG |
String |
Y |
N |
OK : 응답 성공 그외 : 에러 메시지 |
|
BODY |
|||||
연동예시
{ "HEADER": { "RESULTCODE": "0000", "RESULTMSG": "OK" }, "BODY": {} }
[UMS회원관리]회원 수정 API¶
서비스명 |
대쉬보드 검색조건 |
Controller URL |
/umsMember/upUmsMember.ums |
||
---|---|---|---|---|---|
METHOD |
POST content-type : application/x-www-form-urlencoded |
||||
설명 |
UMS회원정보 수정 |
||||
요청 : Request parameter : application/x-www-form-urlencoded |
|||||
항목 |
타입 |
필수 |
설명 |
||
MEMBERID |
String |
Y |
UMS아이디 |
||
MEMBERNAME |
String |
Y |
이름 |
||
MOBILE |
String |
Y |
핸드폰번호(숫자만 기입) ex)01012345678 |
||
ORGANID |
String |
N |
UMS 조직도에 만든 조직코드 |
||
VAR1 |
String |
N |
예비회원정보1 |
||
VAR2 |
String |
N |
예비회원정보2 |
||
VAR3 |
String |
N |
예비회원정보3 |
||
VAR4 |
String |
N |
예비회원정보4 |
||
VAR5 |
String |
N |
예비회원정보5 |
||
응답 : Response TYPE : JSON |
|||||
구분 |
항목 |
값 |
필수 |
반복 |
설명 |
HEADER |
RESULTCODE |
String |
Y |
N |
0000 : 응답 성공 그외 : 에러 메시지 |
RESULTMSG |
String |
Y |
N |
OK : 응답 성공 그외 : 에러 메시지 |
|
BODY |
MEMBERINFO |
JSON |
Y |
회원정보 수정 데이타 |
|
연동예시
{ "HEADER": { "RESULTCODE": "0000", "RESULTMSG": "OK" }, "BODY": { "MEMBERINFO": { "MEMBERID": "ddd", "MEMBERNAME": "회원D-2", "MOBILE": "0100005555", "ORGANID": "5", "VAR1": "유라클2", "VAR2": "과장2", "VAR3": "", "VAR4": "", "VAR5": "", "REGDATE": "", "EDITDATE": "" } } }
[UMS회원관리]회원 삭제 API¶
서비스명 |
대쉬보드 검색조건 |
Controller URL |
/umsMember/delUmsMember.ums |
||
---|---|---|---|---|---|
METHOD |
POST content-type : application/x-www-form-urlencoded |
||||
설명 |
UMS회원정보 삭제 |
||||
요청 : Request parameter : application/x-www-form-urlencoded |
|||||
항목 |
타입 |
필수 |
설명 |
||
MEMBERID |
String |
Y |
UMS아이디 |
||
응답 : Response TYPE : JSON |
|||||
구분 |
항목 |
값 |
필수 |
반복 |
설명 |
HEADER |
RESULTCODE |
String |
Y |
N |
0000 : 응답 성공 그외 : 에러 메시지 |
RESULTMSG |
String |
Y |
N |
OK : 응답 성공 그외 : 에러 메시지 |
|
BODY |
DELCOUNT |
int |
Y |
삭제아이디 수 |
|
연동예시
{ "HEADER": { "RESULTCODE": "0000", "RESULTMSG": "OK" }, "BODY": { "DELCOUNT": 1 } } }
대쉬보드 API¶
[대쉬보드] 검색조건 정보 (푸시앱아이디, 플러스친구…)¶
서비스명 |
대쉬보드 검색조건 |
Controller URL |
/common/initSettingData.ums |
||
---|---|---|---|---|---|
METHOD |
POST content-type : application/json |
||||
설명 |
발송통계 검색 조건 정보 |
||||
Request Body(JSON 방식 호출) 확인 : 필수 파라미트 없음 |
|||||
항목 |
타입 |
필수 |
설명 |
||
TYPE : 일반발송 응답 메시지(JSON) |
|||||
구분 |
항목 |
값 |
필수 |
반복 |
설명 |
HEADER |
RESULTCODE |
String |
Y |
N |
0000 : 응답 성공 그외 : 에러 메시지 |
RESULTMSG |
String |
Y |
N |
OK : 응답 성공 그외 : 에러 메시지 |
|
BODY |
appids |
Array |
Y |
푸시 앱아이디 리스트 |
|
plusAlimInfos |
Array |
Y |
카카오 알림톡 플러스아이디 정보 리스트 |
||
plusFriendInfos |
Array |
카카오 친구톡 플러스 아이디 정보 리스트 |
|||
smsSendNums |
Array |
SMS 발신번호리스트 |
|||
연동예시
{ "BODY" : { "plusAlimInfos" : [ { "PLUS_ID" : 유라클연구소, "ALLIMTOLK_SVC_ID" : 1910000001, "FRIENDTOLK_SVC_ID" : 1920000000 } ], "NAS_YN" : Y, "appids" : [ com.upns.push.test, com.uracle.push.test, com.uracle.push.demo, com.mium2.push.democlient ], "smsSendNums" : [ { "val" : 0234794400, "col" : aaa(0234794400) } ], "plusFriendInfos" : [ { "PLUS_ID" : 유라클연구소, "ALLIMTOLK_SVC_ID" : 1910000001, "FRIENDTOLK_SVC_ID" : 1920000000 } ] }, "HEADER" : { "RESULTCODE" : 0000, "RESULTMSG" : OK } }
[대쉬보드] 발송 통계 DATA (UMS발송통계 ,차트데이타,푸시가입데이타..)¶
서비스명 |
대쉬보드 발송통계 데이터 |
Controller URL |
/common/getAllDashboardData.ums |
||
---|---|---|---|---|---|
METHOD |
POST content-type : application/json |
||||
설명 |
UMS 발송 통계 데이터 |
||||
Request (POST 방식 호출) |
|||||
항목 |
타입 |
필수 |
설명 |
||
startDt |
String |
검색시작일자 ex) YYYY.MM.DD HH:MI:SS 2019.07.09 00:00:00 |
|||
endDt |
String |
검색종료일자 ex) YYYY.MM.DD HH:MI:SS 2019.07.16 23:59:59 |
|||
selType |
String |
검색 발송종류 : PUSH , KKOALT, KKOFRT, SMS 중 택1일 PUSH : 푸시, KKOALT : 카카오알림톡 KKOFRT : 카카오친구톡 SMS : 문자 |
|||
TYPE : 일반발송 응답 메세지 |
|||||
구분 |
항목 |
값 |
필수 |
반복 |
설명 |
HEADER |
RESULTCODE |
String |
Y |
N |
0000 : 응답 성공 그외 : 에러 메시지 |
RESULTMSG |
String |
Y |
N |
OK : 응답 성공 그외 : 에러 메시지 |
|
BODY |
sendStatistics |
Object |
Y |
N |
발송 타입 별 발송 통계현황 |
sendChartDataMap |
Object |
Y |
N |
발송 통계 차트 데이터 |
|
termChartDataMap |
Object |
Y |
N |
푸시 기간별 가입통계 차트 데이터 |
|
osChartDataMap |
Object |
Y |
N |
푸시 OS별 차트데이터 |
|
연동예시
{ "BODY" : { "termChartDataMap" : { "termLineChartDatas" : [ 0, 0, 1, 0, 0, 0, 0, 0 ], "termLineChartLabels" : [ 07/09, 07/10, 07/11, 07/12, 07/13, 07/14, 07/15, 07/16 ], "appTotalUserCnt" : 2 }, "sendStatistics" : { "PUSH_SUCC_CNT" : 2, "PUSH_FAIL_CNT" : 20, "ALT_SUCC_CNT" : 302, "ALT_FAIL_CNT" : 10, "FRT_SUCC_CNT" : 0, "FRT_FAIL_CNT" : 0, "SMS_SUCC_CNT" : 0, "SMS_FAIL_CNT" : 0 }, "osChartDataMap" : { "iosBarChartDatas" : [ 0, 0, 0, 0, 0, 0, 0, 0 ], "osPieChartDatas" : [ 1, 0 ], "osPieChartLabels" : [ Android, iOS ], "androidBarChartDatas" : [ 0, 0, 1, 0, 0, 0, 0, 0 ], "osBarChartLabels" : [ 07/09, 07/10, 07/11, 07/12, 07/13, 07/14, 07/15, 07/16 ] }, "sendChartDataMap" : { "pieChartLabels" : [ 성공 11%, 실패 89% ], "pieChartDatas" : [ 2, 18 ], "lineChartSuccDatas" : [ 0, 0, 2, 0, 0, 0, 0, 0 ], "lineChartFailDatas" : [ 0, 0, 20, 0, 0, 0, 0, 0 ], "lineChartLabels" : [ 07/09, 07/10, 07/11, 07/12, 07/13, 07/14, 07/15, 07/16 ] } }, "HEADER" : { "RESULTCODE" : 0000, "RESULTMSG" : OK } }
예약취소 API¶
서비스명 |
예약발송취소 |
Controller URL |
/api/reserveCancelApi.ums |
||
---|---|---|---|---|---|
METHOD |
POST content-type : application/x-www-form-urlencoded |
||||
설명 |
예약발송 내역취소 |
||||
Request (POST 방식 호출) |
|||||
항목 |
타입 |
필수 |
설명 |
||
RESERVE_SEQNO |
String |
Y |
예약발송 등록 후 리턴받은 예약발송번호 |
||
TYPE : 일반발송 응답 메세지 |
|||||
구분 |
항목 |
값 |
필수 |
반복 |
설명 |
HEADER |
RESULTCODE |
String |
Y |
N |
0000 : 응답 성공 그외 : 에러 메시지 |
RESULTMSG |
String |
Y |
N |
OK : 응답 성공 그외 : 에러 메시지 |
|
BODY |
delCnt |
Integer |
Y |
N |
삭제처리된 카운트. 1 : 삭제성공, 0 : 삭제안됨 |
연동예시
{ "BODY": { "delCnt": 0 }, "HEADER": { "RESULTCODE": "0000", "RESULTMSG": "OK" } }