발송 API

발송

구분

내용

Controller URL

/api/send/potalSendApi.ums

METHOD

POST

Content-type

multipart/form-data or application/x-www-form-urlencoded;charset=UTF-8

설명

발송

비고

application/json 불가

  • [공통] 전문

항목

타입

필수

설명

APIKEY

STRING

Y

CLOUD APIKEY

PROJECT_ID

STRING

Y

PROJECT_ID

REQ_TRAN_TYPE

STRING

N

전송 유형 (기본값 – BATCH)

  • REAL(실시간)

  • BATCH(배치)

SENDGROUPCODE

STRING

N

발송자 그룹 코드- 통계, 발송 횟수 제어에 사용됨

SENDERID

STRING

Y

발송자 ID - 통계, 발송 횟수 제어에 사용됨

TARGET_USER_TYPE

ENUM

N

발송 대상 유형 (기본값 – NM)

  • NM(일반 발송)

  • NC(CSV 발송)

SEND_MACRO_CODE

STRING

N

대체 발송 순서 정보 코드

(기본값 – MACRO_001)

REPLACE_VARS

STRING

N

치환 변수 정보

RESERVEDATE

STRING

N

예약 발송 일시(YYYY-MM-DD HH24:MM)

MSG_TYPE

ENUM

N

메시지 정보 (기본값 – I)

  • I(정보성)

  • A(광고성)

LIMITSECOND

STRING

N

속도제한 기준 초

LIMITCNT

STRING

N

속도제한 기준 건수

CUST_TRANSKEY

STRING

N

고객 거래 키

CUST_TRANSGROUPKEY

STRING

N

고객 거래 그룹 키

MIN_START_TIME

STRING

N

최소 발송 유효시간(HH:MM)

MAX_END_TIME

STRING

N

최대 발송 유효시간(HH:MM)

FATIGUE_YN

STRING

N

피로도 발송(체크) 여부

CALLBACK_NUM

STRING

Y/N

발신 번호(SMS/RCS 필수)

CSVFILE

BINARY

Y/N

CSV 파일(CSV 발송 시 필수)

CUIDS

STRING

Y/N

수신자 정보(일반 발송 필수)

{“아이디”:[“핸드폰번호”,”이름”],…}

  • [PUSH] 전문

항목

타입

필수

설명

APP_ID

STRING

Y

앱 ID

TITLE

STRING

N

발송 메시지 제목

PUSH_MSG

STRING

Y

발송 메시지 내용

PUSH_TEMPL_ID

STRING

N

발송 템플릿 ID

EXT

STRING

N

앱에 전달되는 추가 정보

EXT_KIND

STRING

N

D: 사용자 지정

I: 모피어스 이미지 규격으로 재 조립 기능 사용

M:모피어스 동영상 규격으로 재 조립 기능 사용

SOUNDFILE

STRING

N

앱 알림음(기본값 – alert.aif)

  • [WEB-PUSH] 전문

항목

타입

필수

설명

WPUSH_DOMAIN

STRING

Y

웹 도메인

WPUSH_TITLE

STRING

N

발송 메시지 제목

WPUSH_MSG

STRING

Y

발송 메시지 내용

WPUSH_TEMPL_ID

STRING

N

발송 템플릿 ID

WPUSH_EXT

STRING

N

웹에 전달되는 추가 정보

WPUSH_LINK

STRING

N

웹 노티 링크

WPUSH_ICON

STRING

N

웹 노티 아이콘

WPUSH_BADGENO

STRING

N

웹 뱃지 카운트 정보(기본값 – 0)

  • UPMC 뱃지 자동 관리 설정 모드 (0: 기능 OFF 1: 기능 ON)

  • UPMC 뱃지 자동 관리 설정 모드 (0~999 숫자 입력 가능)

  • [ALIMTOK] 전문

항목

타입

필수

설명

KKOALT_SVCID

STRING

Y

서비스 ID

ALLIMTOLK_TEMPLCODE

STRING

Y

템플릿 코드

ALLIMTALK_MSG

STRING

N

메시지 내용

KKO_BTNS

STRING ARRAY

N

버튼 정보(최대 5개)

KKO_TITLE

STRING

Y/N

TEXT 강조 형 제목(강조형 템플릿 경우 필수)

  • 안드로이드: 최대 2줄 23자(24자부터 말줄임 처리)

  • iOS: 최대 2줄 27자(28자부터 말줄임 처리)

  • [RCS] 전문

항목

타입

필수

설명

BRAND_ID

STRING

Y

브랜드 ID

RCS_MSGBASE_ID

STRING

Y

RCS 메시지 ID

RCS_TYPE

STRING

Y

RCS 유형

  • RCS_FREE(90자, 버튼X)

  • RCS_SMS(100자, 버튼1)

  • RCS_LMS(1000자, 버튼3)

  • RCS_MMS(1000자, 버튼2, 이미지1개)

RCS_TITLE

STRING

N

메시지 제목

RCS_MSG

STRING

Y/N

메시지 내용 – (우선순위 2)

RCS_TEMPL_ID

STRING

N

템플릿 ID

EXPIRY_OPTION

ENUM

N

발송 결과 만료 시간 옵션(기본값 – 1)

  • 1 (1일), 2(30초)

  • 3 (3분), 4(1시간 10초)

FOOTER

STRING

N

수신거부전화번호

COPY_ALLOWED

STRING

N

메시지 복사 허용 여부(기본값 – Y)

RCS_OBJECT

STRING

N

RCS 제목 내용 JSON 포맷(우선순위 1)

해당 필드의 데이터가 RCS_MSG 보다 우선 함

RCS_IMG_PATH

STRING ARRAY

N

이미지 파일 위치 정보

RCS_IMG_FILES

BINARY

N

이미지 파일

BTN_OBJECT

STRING ARRAY

N

버튼 정보(최대 5개)

RCS_BTN_CNT

STRING

N

버튼 개수(숫자만 가능)

RCS_BTN_TYPE

STRING

N

버튼 저장 타입

  • D(DB 버튼컬럼 입력)

  • V(서술형 가변 변수형)

  • F(기본)

  • [xMS] 전문

항목

타입

필수

설명

SMS_TEMPL_ID

STRING

N

템플릿 ID

SMS_TITLE

STRING

N

메시지 제목

SMS_MSG

STRING

Y

메시지 내용

MMS_IMGURL

JSON ARRAY

N

이미지 URL(ex.[”https://aaa.com/aaa.jpg”])

  • [공통] 응답 전문

ROOT 항목

항목

타입

설명

HEADER

FIELD

헤더 영역

RESULTCODE

STRING

결과 코드 – 0000 성공

RESULTMSG

STRING

결과 내용 정보

BODY

Array

FIELD

바디 영역

UMS_SEQNO

STRING

발송 고유번호(실시간 발송 요청 시 리턴)

(조회/취소 시 사용)

RESERVE_SEQNO

STRING

예약발송 고유번호(예약발송 요청 시 리턴)

(예약 취소 시 사용)

TRANS_TYPE

STRING

거래 유형 – REAL, BATCH

SEND_CNT

STRING

발송 요청 성공 건수

(실시간 발송요청 시 리턴)

FAIL_CNT

STRING

발송 요청 실패 건수

(실시간 발송요청 시 리턴)

PUSH

STRING

푸쉬 요청 건수

(실시간 발송요청 시 리턴)

WPUSH

STRING

웹 푸쉬 요청 건수

(실시간 발송요청 시 리턴)

KKOALT

STRING

알림톡 요청 건수

(실시간 발송요청 시 리턴)

KKOFRT

STRING

친구톡 요청 건수

(실시간 발송요청 시 리턴)

RCS_FREE

STRING

RCS FREE 요청 건수

(실시간 발송요청 시 리턴)

RCS_CELL

STRING

RCS CELL 요청 건수

(실시간 발송요청 시 리턴)

RCS_DESC

STRING

RCS DESC 요청 건수

(실시간 발송요청 시 리턴)

RCS_SMS

STRING

RCS SMS 요청 건수

(실시간 발송요청 시 리턴)

RCS_LMS

STRING

RCS LMS 요청 건수

(실시간 발송요청 시 리턴)

RCS_MMS

STRING

RCS MMS 요청 건수

(실시간 발송요청 시 리턴)

NAVERT

STRING

네이버톡 요청 건수

(실시간 발송요청 시 리턴)

SMS

STRING

SMS 요청 건수

(실시간 발송요청 시 리턴)

LMS

STRING

LMS 요청 건수

(실시간 발송요청 시 리턴)

MMS

STRING

MMS 요청 건수

(실시간 발송요청 시 리턴)

  • 연동 응답 예시

    {
    "HEADER": {
        "RESULTMSG": "OK",
        "RESULTCODE": "0000"
    },
    "BODY": [
        {
            "RCS_CELL": "0",
            "SEND_CNT": "1",
            "RCS_LMS": "0",
            "RCS_MMS": "0",
            "TRANS_TYPE": "BATCH",
            "RCS_SMS": "0",
            "RCS_DESC": "0",
            "MMS": "0",
            "LMS": "0",
            "RCS_FREE": "0",
            "SMS": "0",
            "UMS_SEQNO": "2503",
            "KKOALT": "1",
            "FAIL_CNT": "0",
            "WPUSH": "0",
            "PUSH": "0"
        }
    ]
}

발송 요청 취소

구분

내용

Controller URL

/api/sdk/umsCancleSendApi.ums

METHOD

POST

Content-type

application/x-www-form-urlencoded

설명

발송 요청 취소

  • 요청 : Request parameter : application/x-www-form-urlencoded

항목

타입

필수

설명

APIKEY

String

Y

유라클클라우드 데브콘솔에서 생성된 API키

PROJECT_ID

String

Y

유라클클라우드 데브콘솔에서 생성된 프로젝트아이디.

PROCESS_SEQNO

String

Y

취소 거래키(SEQ)

SENDERID

String

N

취소 요청자 ID

SENDGROUPCODE

String

N

취소 요청 그룹 코드

  • 응답 : Response TYPE : JSON

ROOT 항목

항목

타입

설명

HEADER

FIELD

헤더 영역

RESULTCODE

STRING

결과 코드 – 0000 성공

RESULTMSG

STRING

결과 내용 정보

  • 연동 예시

    {
   "HEADER":{
      "RESULTCODE":"0000",
      "RESULTMSG":"OK"
   }
}