SMS APIs¶

[SMS] UMS 회원 발송¶

구분	내용
Controller URL	/api/umsSendSmsApi.ums
METHOD	POST
Content-type	multipart/form-data or application/x-www-form-urlencoded
설명	UMS 회원 SMS 발송
비고	application/json 불가

Request (POST 방식 호출)

항목	타입	필수	설명
APIKEY	String	Y	유라클클라우드 데브콘솔에서 생성된 API키
CLOUD_PROJECT_ID	String	Y	유라클클라우드 데브콘솔에서 생성된 프로젝트아이디.
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: htt p://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”}

연동 예시

{
   "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 회원 / 예약발송¶

구분	내용
Controller URL	/api/umsSendSmsApi.ums
METHOD	POST
Content-type	multipart/form-data or application/x-www-form-urlencoded
설명	UMS 회원 SMS 예약발송
비고	application/json 불가

Request (POST 방식 호출)

항목	타입	필수	설명
APIKEY	String	Y	유라클클라우드 데브콘솔에서 생성된 API키
CLOUD_PROJECT_ID	String	Y	유라클클라우드 데브콘솔에서 생성된 프로젝트아이디.
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.”, “pr ocessPercent”: “100”}

연동 예시

{
   "HEADER":{
      "RESULTCODE":"0000",
      "RESULTMSG":"OK"
   },
   "BODY":{
      "reserveSeqno":"220",
      "processInfo":{
         "processTxt":"Completed.",
         "processPercent":"100"
      }
   }
}

[SMS] UMS 비회원 발송¶

구분	내용
Controller URL	/api/umsSendSmsMnApi.ums
METHOD	POST
Content-type	multipart/form-data or application/x-www-form-urlencoded
설명	SMS 비회원 발송
비고	application/json 불가

Request (POST 방식 호출)

항목	타입	필수	설명
APIKEY	String	Y	유라클클라우드 데브콘솔에서 생성된 API키
CLOUD_PROJECT_ID	String	Y	유라클클라우드 데브콘솔에서 생성된 프로젝트아이디.
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: htt p://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”}

연동 예시

{
   "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 비회원 / 예약발송¶

구분	내용
Controller URL	/api/umsSendSmsMnApi.ums
METHOD	POST
Content-type	multipart/form-data or application/x-www-form-urlencoded
설명	SMS 비회원 발송
비고	application/json 불가

Request (POST 방식 호출)

항목	타입	필수	설명
APIKEY	String	Y	유라클클라우드 데브콘솔에서 생성된 API키
CLOUD_PROJECT_ID	String	Y	유라클클라우드 데브콘솔에서 생성된 프로젝트아이디.
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.”, “pr ocessPercent”: “100”}

연동 예시

{
   "HEADER":{
      "RESULTCODE":"0000",
      "RESULTMSG":"OK"
   },
   "BODY":{
      "reserveSeqno":"220",
      "processInfo":{
         "processTxt":"Completed.",
         "processPercent":"100"
      }
   }
}

[SMS] UMS 회원 / CSV발송 (대량발송 or 치환발송)¶

구분	내용
Controller URL	/api/csvSendSmsApi.ums
METHOD	POST
Content-type	multipart/form-data or application/x-www-form-urlencoded
설명	SMS 회원 CSV발송
비고	application/json 불가

Request (POST 방식 호출)

항목	타입	필수	설명
APIKEY	String	Y	유라클클라우드 데브콘솔에서 생성된 API키
CLOUD_PROJECT_ID	String	Y	유라클클라우드 데브콘솔에서 생성된 프로젝트아이디.
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.”, “pr ocessPercent”: “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 치환발송)¶

구분	내용
Controller URL	/api/csvSendSmsApi.ums
METHOD	POST
Content-type	multipart/form-data or application/x-www-form-urlencoded
설명	SMS 회원 CSV예약발송
비고	application/json 불가

Request (POST 방식 호출)

항목	타입	필수	설명
APIKEY	String	Y	유라클클라우드 데브콘솔에서 생성된 API키
CLOUD_PROJECT_ID	String	Y	유라클클라우드 데브콘솔에서 생성된 프로젝트아이디.
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.”, “pr ocessPercent”: “100”}

연동 예시

{
   "HEADER":{
      "RESULTCODE":"0000",
      "RESULTMSG":"OK"
   },
   "BODY":{
      "reserveSeqno":"220",
      "processInfo":{
         "processTxt":"Completed.",
         "processPercent":"100"
      }
   }
}

[SMS] UMS 비회원 / CSV발송 (대량발송 or 메시지 치환발송)¶

구분	내용
Controller URL	/api/csvSendSmsMnApi.ums
METHOD	POST
Content-type	multipart/form-data or application/x-www-form-urlencoded
설명	SMS 비회원 CSV발송
비고	application/json 불가

Request (POST 방식 호출)

항목	타입	필수	설명
APIKEY	String	Y	유라클클라우드 데브콘솔에서 생성된 API키
CLOUD_PROJECT_ID	String	Y	유라클클라우드 데브콘솔에서 생성된 프로젝트아이디.
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.”, “pr ocessPercent”: “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 메시지 치환발송)¶

구분	내용
Controller URL	/api/csvSendSmsMnApi.ums
METHOD	POST
Content-type	multipart/form-data or application/x-www-form-urlencoded
설명	SMS 비회원 CSV예약발송
비고	application/json 불가

Request (POST 방식 호출)

항목	타입	필수	설명
APIKEY	String	Y	유라클클라우드 데브콘솔에서 생성된 API키
CLOUD_PROJECT_ID	String	Y	유라클클라우드 데브콘솔에서 생성된 프로젝트아이디.
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.”, “pr ocessPercent”: “100”}

연동 예시

{
   "HEADER":{
      "RESULTCODE":"0000",
      "RESULTMSG":"OK"
   },
   "BODY":{
      "reserveSeqno":"220",
      "processInfo":{
         "processTxt":"Completed.",
         "processPercent":"100"
      }
   }
}