================= PUSH APIs ================= [PUSH] UMS 회원 발송 -------------------- ============== ======================================================== 구분 내용 ============== ======================================================== Controller URL /api/umsSendPushApi.ums METHOD POST Content-type multipart/form-data or application/x-www-form-urlencoded 설명 UMS 회원 발송 비고 application/json 불가 ============== ======================================================== * **Request (POST 방식 호출)** +---------------------+---------------+-------+---------------------+ | 항목 | 타입 | 필수 | 설명 | +=====================+===============+=======+=====================+ | APIKEY | String | Y | 유라클클라우드 | | | | | 데브콘솔에서 생성된 | | | | | API키 | +---------------------+---------------+-------+---------------------+ | CLOUD_PROJECT_ID | String | Y | 유라클클라우드 | | | | | 데브콘솔에서 생성된 | | | | | 프로젝트아이디. | +---------------------+---------------+-------+---------------------+ | PUSH_MSG | String | Y | 두 가지 타입 작성. | | | | | **치환 발송 가능 | | | | | (아이디, 이름)** | | | | | | | | | | 첫번째 : JsonObject | | | | | String, body는 | | | | | 필수값이면 개행이 | | | | | 됩니다.(\n) | | | | | | | | | | Ex) {“title”:” | | | | | #{이름}님 | | | | | 타이틀입니다.”, | | | | | “body”:”본문내용을 | | | | | 작성합니다.”} | | | | | | | | | | 두번째 : 일반문자 | | | | | | | | | | Ex) #{아이디}님 | | | | | 안녕하세요. 유라클 | | | | | 푸시메세지 입니다. | +---------------------+---------------+-------+---------------------+ | SERVICECODE | String | Y | 푸시관리페이지에서 | | | | | 푸시서비스 코드 | | | | | 참조. | | | | | | | | | | ex) ALL, FCM, | | | | | APNS 중 택일, | +---------------------+---------------+-------+---------------------+ | **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://x | | | | | xx.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 | | | | | | | | | | - ex) | | | | | | | | | | | 메시지 내용 : | | | | | 안녕하세요. | | | | | 결제일은 #{날짜} | | | | | 입니다. #{금액}이 | | | | | 청구됩니다. | | | | | | 넘겨야 될 | | | | | 파라미터값 : | | | | | {“#{날 | | | | | 짜}”:”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: | | | | | 메시지전달 | | | | | | | | | | | **[예제]** | | | | | | - **알림톡 | | | | | 예제** : | | | | | http://xxx. | | | | | com||http://xxx.com | | | | | | - **친구톡 | | | | | 예제** : | | | | | | **WL 예제**: | | | | | | | | | | | {"name":"유라클버튼 | | | | | ","type":"WL","url | | | | | _pc":"http://blog.n | | | | | aver.com/imagetech1 | | | | | /221004457903","url | | | | | _mobile":"http://bl | | | | | og.naver.com/imaget | | | | | ech1/221004457903"} | | | | | | | | | | | **AL 예제** : | | | | | | {"nam | | | | | e":"버튼명칭","type | | | | | ":"AL","scheme_ios" | | | | | :"scheme://xxx.xx", | | | | | | | | | | "scheme_android" | | | | | :"scheme://xxx.xx"} | | | | | | | | | | **BK 예제** : | | | | | | | | | | {"name":"봇키워드", | | | | | "type":"BK"} | | | | | | | | | | **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.", | | | | | | | "pr | | | | | | | ocessPercent": | | | | | | | "100"} | +--------+--------------+--------+------+------+----------------+ * **연동 예시** .. code-block:: javascript { "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 회원 / 예약발송 -------------------------- ============== ======================================================== 구분 내용 ============== ======================================================== Controller URL /api/umsSendPushApi.ums METHOD POST Content-type multipart/form-data or application/x-www-form-urlencoded 설명 UMS통합 푸시 예약발송 비고 application/json 불가 ============== ======================================================== * **Request (POST 방식 호출)** +---------------------+---------------+-------+---------------------+ | 항목 | 타입 | 필수 | 설명 | +=====================+===============+=======+=====================+ | APIKEY | String | Y | 유라클클라우드 | | | | | 데브콘솔에서 생성된 | | | | | API키 | +---------------------+---------------+-------+---------------------+ | CLOUD_PROJECT_ID | String | Y | 유라클클라우드 | | | | | 데브콘솔에서 생성된 | | | | | 프로젝트아이디. | +---------------------+---------------+-------+---------------------+ | PUSH_MSG | String | Y | 두 가지 타입 작성. | | | | | **치환 발송 가능 | | | | | (아이디, 이름)** | | | | | | | | | | 첫번째 : JsonObject | | | | | String, body는 | | | | | 필수값이면 개행이 | | | | | 됩니다.(\n) | | | | | | | | | | Ex) {“title”:” | | | | | #{이름}님 | | | | | 타이틀입니다.”, | | | | | “body”:”본문내용을 | | | | | 작성합니다.”} | | | | | | | | | | 두번째 : 일반문자 | | | | | | | | | | Ex) #{아이디}님 | | | | | 안녕하세요. 유라클 | | | | | 푸시메세지 입니다. | +---------------------+---------------+-------+---------------------+ | SERVICECODE | String | Y | 푸시관리페이지에서 | | | | | 푸시서비스 코드 | | | | | 참조. | | | | | | | | | | ex) ALL, FCM, | | | | | APNS 중 택일, | +---------------------+---------------+-------+---------------------+ | **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://x | | | | | xx.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 | | | | | | | | | | - ex) | | | | | | | | | | | 메시지 내용 : | | | | | 안녕하세요. | | | | | 결제일은 #{날짜} | | | | | 입니다. #{금액}이 | | | | | 청구됩니다. | | | | | | 넘겨야 될 | | | | | 파라미터값 : | | | | | {“#{날 | | | | | 짜}”:”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: | | | | | 메시지전달 | | | | | | | | | | | **[예제]** | | | | | | - **알림톡 | | | | | 예제** : | | | | | http://xxx. | | | | | com||http://xxx.com | | | | | | - **친구톡 | | | | | 예제** : | | | | | | **WL 예제**: | | | | | | | | | | | {"name":"유라클버튼 | | | | | ","type":"WL","url | | | | | _pc":"http://blog.n | | | | | aver.com/imagetech1 | | | | | /221004457903","url | | | | | _mobile":"http://bl | | | | | og.naver.com/imaget | | | | | ech1/221004457903"} | | | | | | | | | | | **AL 예제** : | | | | | | {"nam | | | | | e":"버튼명칭","type | | | | | ":"AL","scheme_ios" | | | | | :"scheme://xxx.xx", | | | | | | | | | | "scheme_android" | | | | | :"scheme://xxx.xx"} | | | | | | | | | | **BK 예제** : | | | | | | | | | | {"name":"봇키워드", | | | | | "type":"BK"} | | | | | | | | | | **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.", | | | | | | | "pr | | | | | | | ocessPercent": | | | | | | | "100"} | +--------+--------------+--------+------+------+----------------+ * **연동 예시** .. code-block:: javascript { "HEADER":{ "RESULTCODE":"0000", "RESULTMSG":"OK" }, "BODY":{ "reserveSeqno":"220", "processInfo":{ "processTxt":"Completed.", "processPercent":"100" } } } [PUSH] UMS 비회원 발송 ---------------------- ============== ======================================================== 구분 내용 ============== ======================================================== Controller URL /api/umsSendPushMnApi.ums METHOD POST Content-type multipart/form-data or application/x-www-form-urlencoded 설명 UMS 비회원 통합 푸시 발송 비고 application/json 불가 ============== ======================================================== * **Request (POST 방식 호출)** +---------------------+---------------+------+---------------------+ | 항목 | 타입 | 필수 | 설명 | +=====================+===============+======+=====================+ | APIKEY | String | Y | 유라클클라우드 | | | | | 데브콘솔에서 생성된 | | | | | API키 | +---------------------+---------------+------+---------------------+ | CLOUD_PROJECT_ID | String | Y | 유라클클라우드 | | | | | 데브콘솔에서 생성된 | | | | | 프로젝트아이디. | +---------------------+---------------+------+---------------------+ | PUSH_MSG | String | Y | 두 가지 타입 작성. | | | | | **치환 발송 가능 | | | | | (아이디, 이름)** | | | | | | | | | | 첫번째 : JsonObject | | | | | String, body는 | | | | | 필수값이면 개행이 | | | | | 됩니다.(\n) | | | | | | | | | | Ex) {“title”:” | | | | | #{이름}님 | | | | | 타이틀입니다.”, | | | | | “body”:”본문내용을 | | | | | 작성합니다.”} | | | | | | | | | | 두번째 : 일반문자 | | | | | | | | | | Ex) #{아이디}님 | | | | | 안녕하세요. 유라클 | | | | | 푸시메세지 입니다. | +---------------------+---------------+------+---------------------+ | SERVICECODE | String | Y | 푸시관리페이지에서 | | | | | 푸시서비스 코드 | | | | | 참조. | | | | | | | | | | ex) ALL, FCM, | | | | | APNS 중 택일, | +---------------------+---------------+------+---------------------+ | 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://x | | | | | xx.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 | | | | | | | | | | - ex) | | | | | | | | | | | 메시지 내용 : | | | | | 안녕하세요. | | | | | 결제일은 #{날짜} | | | | | 입니다. #{금액}이 | | | | | 청구됩니다. | | | | | | 넘겨야 될 | | | | | 파라미터값 : | | | | | {“#{날 | | | | | 짜}”:”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: | | | | | 메시지전달 | | | | | | | | | | | **[예제]** | | | | | | - **알림톡 | | | | | 예제** : | | | | | http://xxx. | | | | | com||http://xxx.com | | | | | | - **친구톡 | | | | | 예제** : | | | | | | **WL 예제**: | | | | | | | | | | | {"name":"유라클버튼 | | | | | ","type":"WL","url | | | | | _pc":"http://blog.n | | | | | aver.com/imagetech1 | | | | | /221004457903","url | | | | | _mobile":"http://bl | | | | | og.naver.com/imaget | | | | | ech1/221004457903"} | | | | | | | | | | | **AL 예제** : | | | | | | {"nam | | | | | e":"버튼명칭","type | | | | | ":"AL","scheme_ios" | | | | | :"scheme://xxx.xx", | | | | | | | | | | "scheme_android" | | | | | :"scheme://xxx.xx"} | | | | | | | | | | **BK 예제** : | | | | | | | | | | {"name":"봇키워드", | | | | | "type":"BK"} | | | | | | | | | | **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.", | | | | | | | "pr | | | | | | | ocessPercent": | | | | | | | "100"} | +--------+--------------+--------+------+------+----------------+ * **연동 예시** .. code-block:: javascript { "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 비회원 / 예약발송 ---------------------------- ============== ======================================================== 구분 내용 ============== ======================================================== Controller URL /api/umsSendPushMnApi.ums METHOD POST Content-type multipart/form-data or application/x-www-form-urlencoded 설명 UMS비회원 통합 푸시 예약발송 비고 application/json 불가 ============== ======================================================== * **Request (POST 방식 호출)** +---------------------+---------------+-------+---------------------+ | 항목 | 타입 | 필수 | 설명 | +=====================+===============+=======+=====================+ | APIKEY | String | Y | 유라클클라우드 | | | | | 데브콘솔에서 생성된 | | | | | API키 | +---------------------+---------------+-------+---------------------+ | CLOUD_PROJECT_ID | String | Y | 유라클클라우드 | | | | | 데브콘솔에서 생성된 | | | | | 프로젝트아이디. | +---------------------+---------------+-------+---------------------+ | PUSH_MSG | String | Y | 두 가지 타입 작성. | | | | | **치환 발송 가능 | | | | | (아이디, 이름)** | | | | | | | | | | 첫번째 : JsonObject | | | | | String, body는 | | | | | 필수값이면 개행이 | | | | | 됩니다.(\n) | | | | | | | | | | Ex) {“title”:” | | | | | #{이름}님 | | | | | 타이틀입니다.”, | | | | | “body”:”본문내용을 | | | | | 작성합니다.”} | | | | | | | | | | 두번째 : 일반문자 | | | | | | | | | | Ex) #{아이디}님 | | | | | 안녕하세요. 유라클 | | | | | 푸시메세지 입니다. | +---------------------+---------------+-------+---------------------+ | SERVICECODE | String | Y | 푸시관리페이지에서 | | | | | 푸시서비스 코드 | | | | | 참조. | | | | | | | | | | ex) ALL, FCM, | | | | | APNS 중 택일, | +---------------------+---------------+-------+---------------------+ | 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://x | | | | | xx.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 | | | | | | | | | | - ex) | | | | | | | | | | | 메시지 내용 : | | | | | 안녕하세요. | | | | | 결제일은 #{날짜} | | | | | 입니다. #{금액}이 | | | | | 청구됩니다. | | | | | | 넘겨야 될 | | | | | 파라미터값 : | | | | | {“#{날 | | | | | 짜}”:”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: | | | | | 메시지전달 | | | | | | | | | | | **[예제]** | | | | | | - **알림톡 | | | | | 예제** : | | | | | http://xxx. | | | | | com||http://xxx.com | | | | | | - **친구톡 | | | | | 예제** : | | | | | | **WL 예제**: | | | | | | | | | | | {"name":"유라클버튼 | | | | | ","type":"WL","url | | | | | _pc":"http://blog.n | | | | | aver.com/imagetech1 | | | | | /221004457903","url | | | | | _mobile":"http://bl | | | | | og.naver.com/imaget | | | | | ech1/221004457903"} | | | | | | | | | | | **AL 예제** : | | | | | | {"nam | | | | | e":"버튼명칭","type | | | | | ":"AL","scheme_ios" | | | | | :"scheme://xxx.xx", | | | | | | | | | | "scheme_android" | | | | | :"scheme://xxx.xx"} | | | | | | | | | | **BK 예제** : | | | | | | | | | | {"name":"봇키워드", | | | | | "type":"BK"} | | | | | | | | | | **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.", | | | | | | | "pr | | | | | | | ocessPercent": | | | | | | | "100"} | +--------+--------------+--------+------+------+----------------+ * **연동 예시** .. code-block:: javascript** { "HEADER":{ "RESULTCODE":"0000", "RESULTMSG":"OK" }, "BODY":{ "reserveSeqno":"220", "processInfo":{ "processTxt":"Completed.", "processPercent":"100" } } } [PUSH] UMS 회원 / CSV발송 ------------------------- ============== ======================================================== 구분 내용 ============== ======================================================== Controller URL /api/csvSendPushApi.ums METHOD POST Content-type multipart/form-data or application/x-www-form-urlencoded 설명 UMS회원 푸시 예약발송 CSV발송 (대량,개별화메세지) 비고 application/json 불가 ============== ======================================================== * **Request (POST 방식 호출)** +---------------------+---------------+------+---------------------+ | 항목 | 타입 | 필수 | 설명 | +=====================+===============+======+=====================+ | APIKEY | String | Y | 유라클클라우드 | | | | | 데브콘솔에서 생성된 | | | | | API키 | +---------------------+---------------+------+---------------------+ | CLOUD_PROJECT_ID | String | Y | 유라클클라우드 | | | | | 데브콘솔에서 생성된 | | | | | 프로젝트아이디. | +---------------------+---------------+------+---------------------+ | PUSH_MSG | String | Y | 두 가지 타입 작성. | | | | | **치환 발송 가능** | | | | | | | | | | 첫번째 : JsonObject | | | | | String, body는 | | | | | 필수값이면 개행이 | | | | | 됩니다.(\n) | | | | | | | | | | | Ex) {“title”:” | | | | | #{이름}님 | | | | | 타이틀입니다.”, | | | | | | “body” | | | | | :”#{날자}본문내용을 | | | | | 작성합니다.”} | | | | | | | | | | 두번째 : 일반문자 | | | | | | | | | | Ex) #{아이디}님 | | | | | 안녕하세요. 유라클 | | | | | 푸시메세지 입니다. | +---------------------+---------------+------+---------------------+ | SERVICECODE | String | Y | 푸시관리페이지에서 | | | | | 푸시서비스 코드 | | | | | 참조. | | | | | | | | | | ex) ALL, FCM, | | | | | APNS 중 택일, | +---------------------+---------------+------+---------------------+ | 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://x | | | | | xx.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: | | | | | 메시지전달 | | | | | | | | | | | **[예제]** | | | | | | - **알림톡 | | | | | 예제** : | | | | | http://xxx. | | | | | com||http://xxx.com | | | | | | - **친구톡 | | | | | 예제** : | | | | | | **WL 예제**: | | | | | | | | | | | {"name":"유라클버튼 | | | | | ","type":"WL","url | | | | | _pc":"http://blog.n | | | | | aver.com/imagetech1 | | | | | /221004457903","url | | | | | _mobile":"http://bl | | | | | og.naver.com/imaget | | | | | ech1/221004457903"} | | | | | | | | | | | **AL 예제** : | | | | | | {"nam | | | | | e":"버튼명칭","type | | | | | ":"AL","scheme_ios" | | | | | :"scheme://xxx.xx", | | | | | | | | | | "scheme_android" | | | | | :"scheme://xxx.xx"} | | | | | | | | | | **BK 예제** : | | | | | | | | | | {"name":"봇키워드", | | | | | "type":"BK"} | | | | | | | | | | **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.", | | | | | | | "pr | | | | | | | ocessPercent": | | | | | | | "100"} | +--------+--------------+--------+------+------+----------------+ * **연동 예시** .. code-block:: javascript** { "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 예약발송 ------------------------------ ============== ======================================================== 구분 내용 ============== ======================================================== Controller URL /api/csvSendPushApi.ums METHOD POST Content-type multipart/form-data or application/x-www-form-urlencoded 설명 UMS회원 푸시 CSV예약발송 (대량, 개별화메세지) 비고 application/json 불가 ============== ======================================================== * **Request (POST 방식 호출)** +---------------------+---------------+-------+---------------------+ | 항목 | 타입 | 필수 | 설명 | +=====================+===============+=======+=====================+ | APIKEY | String | Y | 유라클클라우드 | | | | | 데브콘솔에서 생성된 | | | | | API키 | +---------------------+---------------+-------+---------------------+ | CLOUD_PROJECT_ID | String | Y | 유라클클라우드 | | | | | 데브콘솔에서 생성된 | | | | | 프로젝트아이디. | +---------------------+---------------+-------+---------------------+ | PUSH_MSG | String | Y | 두 가지 타입 작성. | | | | | **치환 발송 가능** | | | | | | | | | | 첫번째 : JsonObject | | | | | String, body는 | | | | | 필수값이면 개행이 | | | | | 됩니다.(\n) | | | | | | | | | | | Ex) {“title”:” | | | | | #{이름}님 | | | | | 타이틀입니다.”, | | | | | | “body” | | | | | :”#{날자}본문내용을 | | | | | 작성합니다.”} | | | | | | | | | | 두번째 : 일반문자 | | | | | | | | | | Ex) #{아이디}님 | | | | | 안녕하세요. 유라클 | | | | | 푸시메세지 입니다. | +---------------------+---------------+-------+---------------------+ | SERVICECODE | String | Y | 푸시관리페이지에서 | | | | | 푸시서비스 코드 | | | | | 참조. | | | | | | | | | | ex) ALL, FCM, | | | | | APNS 중 택일, | +---------------------+---------------+-------+---------------------+ | 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://x | | | | | xx.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: | | | | | 메시지전달 | | | | | | | | | | | **[예제]** | | | | | | - **알림톡 | | | | | 예제** : | | | | | http://xxx. | | | | | com||http://xxx.com | | | | | | - **친구톡 | | | | | 예제** : | | | | | | **WL 예제**: | | | | | | | | | | | {"name":"유라클버튼 | | | | | ","type":"WL","url | | | | | _pc":"http://blog.n | | | | | aver.com/imagetech1 | | | | | /221004457903","url | | | | | _mobile":"http://bl | | | | | og.naver.com/imaget | | | | | ech1/221004457903"} | | | | | | | | | | | **AL 예제** : | | | | | | {"nam | | | | | e":"버튼명칭","type | | | | | ":"AL","scheme_ios" | | | | | :"scheme://xxx.xx", | | | | | | | | | | "scheme_android" | | | | | :"scheme://xxx.xx"} | | | | | | | | | | **BK 예제** : | | | | | | | | | | {"name":"봇키워드", | | | | | "type":"BK"} | | | | | | | | | | **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.", | | | | | | | "pr | | | | | | | ocessPercent": | | | | | | | "100"} | +--------+--------------+--------+------+------+----------------+ * **연동 예시** .. code-block:: javascript** { "HEADER":{ "RESULTCODE":"0000", "RESULTMSG":"OK" }, "BODY":{ "reserveSeqno":"220", "processInfo":{ "processTxt":"Completed.", "processPercent":"100" } } } [PUSH] UMS 비회원 / CSV 발송 (대량발송 or 치환발송) --------------------------------------------------- ============== ======================================================== 구분 내용 ============== ======================================================== Controller URL /api/csvSendPushMnApi.ums METHOD POST Content-type multipart/form-data or application/x-www-form-urlencoded 설명 UMS비회원 푸시 CSV발송 (대량, 개별화메세지) 비고 application/json 불가 ============== ======================================================== * **Request (POST 방식 호출)** +---------------------+---------------+------+---------------------+ | 항목 | 타입 | 필수 | 설명 | +=====================+===============+======+=====================+ | APIKEY | String | Y | 유라클클라우드 | | | | | 데브콘솔에서 생성된 | | | | | API키 | +---------------------+---------------+------+---------------------+ | CLOUD_PROJECT_ID | String | Y | 유라클클라우드 | | | | | 데브콘솔에서 생성된 | | | | | 프로젝트아이디. | +---------------------+---------------+------+---------------------+ | PUSH_MSG | String | Y | 두 가지 타입 작성. | | | | | **치환 발송 가능** | | | | | | | | | | 첫번째 : JsonObject | | | | | String, body는 | | | | | 필수값이면 개행이 | | | | | 됩니다.(\n) | | | | | | | | | | | Ex) {“title”:” | | | | | #{이름}님 | | | | | 타이틀입니다.”, | | | | | | “body” | | | | | :”#{날자}본문내용을 | | | | | 작성합니다.”} | | | | | | | | | | 두번째 : 일반문자 | | | | | | | | | | Ex) #{아이디}님 | | | | | 안녕하세요. 유라클 | | | | | 푸시메세지 입니다. | +---------------------+---------------+------+---------------------+ | SERVICECODE | String | Y | 푸시관리페이지에서 | | | | | 푸시서비스 코드 | | | | | 참조. | | | | | | | | | | ex) ALL, FCM, | | | | | APNS 중 택일, | +---------------------+---------------+------+---------------------+ | 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://x | | | | | xx.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: | | | | | 메시지전달 | | | | | | | | | | | **[예제]** | | | | | | - **알림톡 | | | | | 예제** : | | | | | http://xxx. | | | | | com||http://xxx.com | | | | | | - **친구톡 | | | | | 예제** : | | | | | | **WL 예제**: | | | | | | | | | | | {"name":"유라클버튼 | | | | | ","type":"WL","url | | | | | _pc":"http://blog.n | | | | | aver.com/imagetech1 | | | | | /221004457903","url | | | | | _mobile":"http://bl | | | | | og.naver.com/imaget | | | | | ech1/221004457903"} | | | | | | | | | | | **AL 예제** : | | | | | | {"nam | | | | | e":"버튼명칭","type | | | | | ":"AL","scheme_ios" | | | | | :"scheme://xxx.xx", | | | | | | | | | | "scheme_android" | | | | | :"scheme://xxx.xx"} | | | | | | | | | | **BK 예제** : | | | | | | | | | | {"name":"봇키워드", | | | | | "type":"BK"} | | | | | | | | | | **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 | +---------------------+---------------+------+---------------------+ | | | | | +---------------------+---------------+------+---------------------+ +--------+--------------+--------+------+------+----------------+ | 구분 | 항목 | 값 | 필수 | 반복 | 설명 | +========+==============+========+======+======+================+ | 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.", | | | | | | | "pr | | | | | | | ocessPercent": | | | | | | | "100"} | +--------+--------------+--------+------+------+----------------+ * **연동 예시** .. code-block:: javascript** { "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 치환발송) ------------------------------------------------------- ============== ======================================================== 구분 내용 ============== ======================================================== Controller URL /api/csvSendPushMnApi.ums METHOD POST Content-type multipart/form-data or application/x-www-form-urlencoded 설명 UMS 비회원 푸시 CSV예약발송 (대량, 개별화메세지) 비고 application/json 불가 ============== ======================================================== * **Request (POST 방식 호출)** +---------------------+---------------+-------+---------------------+ | 항목 | 타입 | 필수 | 설명 | +=====================+===============+=======+=====================+ | APIKEY | String | Y | 유라클클라우드 | | | | | 데브콘솔에서 생성된 | | | | | API키 | +---------------------+---------------+-------+---------------------+ | CLOUD_PROJECT_ID | String | Y | 유라클클라우드 | | | | | 데브콘솔에서 생성된 | | | | | 프로젝트아이디. | +---------------------+---------------+-------+---------------------+ | PUSH_MSG | String | Y | 두 가지 타입 작성. | | | | | **치환 발송 가능** | | | | | | | | | | 첫번째 : JsonObject | | | | | String, body는 | | | | | 필수값이면 개행이 | | | | | 됩니다.(\n) | | | | | | | | | | | Ex) {“title”:” | | | | | #{이름}님 | | | | | 타이틀입니다.”, | | | | | | “body” | | | | | :”#{날자}본문내용을 | | | | | 작성합니다.”} | | | | | | | | | | 두번째 : 일반문자 | | | | | | | | | | Ex) #{아이디}님 | | | | | 안녕하세요. 유라클 | | | | | 푸시메세지 입니다. | +---------------------+---------------+-------+---------------------+ | SERVICECODE | String | Y | 푸시관리페이지에서 | | | | | 푸시서비스 코드 | | | | | 참조. | | | | | | | | | | ex) ALL, FCM, | | | | | APNS 중 택일, | +---------------------+---------------+-------+---------------------+ | 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://x | | | | | xx.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: | | | | | 메시지전달 | | | | | | | | | | | **[예제]** | | | | | | - **알림톡 | | | | | 예제** : | | | | | http://xxx. | | | | | com||http://xxx.com | | | | | | - **친구톡 | | | | | 예제** : | | | | | | **WL 예제**: | | | | | | | | | | | {"name":"유라클버튼 | | | | | ","type":"WL","url | | | | | _pc":"http://blog.n | | | | | aver.com/imagetech1 | | | | | /221004457903","url | | | | | _mobile":"http://bl | | | | | og.naver.com/imaget | | | | | ech1/221004457903"} | | | | | | | | | | | **AL 예제** : | | | | | | {"nam | | | | | e":"버튼명칭","type | | | | | ":"AL","scheme_ios" | | | | | :"scheme://xxx.xx", | | | | | | | | | | "scheme_android" | | | | | :"scheme://xxx.xx"} | | | | | | | | | | **BK 예제** : | | | | | | | | | | {"name":"봇키워드", | | | | | "type":"BK"} | | | | | | | | | | **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.", | | | | | | | "pr | | | | | | | ocessPercent": | | | | | | | "100"} | +--------+--------------+--------+------+------+----------------+ * **연동 예시** .. code-block:: javascript** { "HEADER":{ "RESULTCODE":"0000", "RESULTMSG":"OK" }, "BODY":{ "reserveSeqno":"220", "processInfo":{ "processTxt":"Completed.", "processPercent":"100" } } }