SMS 문자 메세지 발송
post

SMS 문자를 발송합니다.
※이모지 문자가 포함된 메세지는 삭제되고 발송됩니다.

https://papi.udpay.co.kr/api/v1/msg/sms

  • pApiToken

    STRING 필수

    연동토큰

    UDPAY 부가서비스 연동토큰

  • sendNumber

    STRING 필수

    수신번호

    발신자에게 보여지는 번호

  • recvNumbers

    ARRAY 필수

    발신번호 리스트

    수신받는 번호 리스트

    • recvNumber

      STRING 필수

      발신번호

      수신받는 번호
      [예:Arrays.asList("010XXXXXXXX", "010XXXXXXXX")]

  • sendDate

    STRING

    예약 발송

    예약 발송 날짜(yyyyMMddHHmmss)
    [발송 1분전에는 취소 불가능]

  • message

    STRING 필수

    메세지

    발송 메세지

  • state

    STRING 필수

    요청 결과

    true 성공, false 실패

  • message

    STRING

    메세지

    요청 결과 메세지

  • errorMessage

    STRING

    오류 메세지

    요청 결과에 대한 오류 메세지

  • errorType

    STRING

    오류 번호

    요청 결과에 대한 오류 번호

  • result

    OBJECT

    결과 데이터

    결과 데이터 정보

    • groupID

      STRING

      그룹ID

      해당 요청건에 대한 ID값

    • successCnt

      NUMBER

      요청 성공 건수

    • errorCnt

      NUMBER

      요청 에러 건수

코드샘플
// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01

Map<String, Object> paramMap = new HashMap<> ();

paramMap.put ("sendNumber", "");	// 수신번호
paramMap.put ("recvNumbers", "");	// 발신번호 리스트
paramMap.put ("sendDate", "");	// 예약 발송
paramMap.put ("message", "");	// 메세지

HttpResponse response = Unirest.post("https://papi.udpay.co.kr/api/v1/msg/sms")
.header("accept", "application/json")
.header("Content-Type", "application/json")
.header("pApiToken", "") // 연동토큰
.body(paramMap)
.asJson();

// JSONObject obj = response.getBody().getObject().getJSONObject("objKey");
// String strVal = obj.getString ("strKey");
// JSONArray arr = response.getBody().getObject().getJsonArray("arrayKey");
LMS 문자 메세지 발송
post

LMS 문자를 발송합니다.
※이모지 문자가 포함된 메세지는 삭제되고 발송됩니다.

https://papi.udpay.co.kr/api/v1/msg/lms

  • pApiToken

    STRING 필수

    연동토큰

    UDPAY 부가서비스 연동토큰

  • sendNumber

    STRING 필수

    수신번호

    발신자에게 보여지는 번호

  • recvNumbers

    ARRAY 필수

    발신번호 리스트

    수신받는 번호 리스트

    • recvNumber

      STRING 필수

      발신번호

      수신받는 번호
      [예:Arrays.asList("010XXXXXXXX", "010XXXXXXXX")]

  • sendDate

    STRING

    예약 발송

    예약 발송 날짜(yyyyMMddHHmmss)
    [발송 1분전에는 취소 불가능]

  • message

    STRING 필수

    메세지

    발송 메세지

  • subject

    STRING

    제목

    문자 제목

  • state

    STRING 필수

    요청 결과

    true 성공, false 실패

  • message

    STRING

    메세지

    요청 결과 메세지

  • errorMessage

    STRING

    오류 메세지

    요청 결과에 대한 오류 메세지

  • errorType

    STRING

    오류 번호

    요청 결과에 대한 오류 번호

  • result

    OBJECT

    결과 데이터

    결과 데이터 정보

    • groupID

      STRING

      그룹ID

      해당 요청건에 대한 ID값

    • successCnt

      NUMBER

      요청 성공 건수

    • errorCnt

      NUMBER

      요청 에러 건수

코드샘플
// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01

Map<String, Object> paramMap = new HashMap<> ();

paramMap.put ("sendNumber", "");	// 수신번호
paramMap.put ("recvNumbers", "");	// 발신번호 리스트
paramMap.put ("sendDate", "");	// 예약 발송
paramMap.put ("message", "");	// 메세지
paramMap.put ("subject", "");	// 제목

HttpResponse response = Unirest.post("https://papi.udpay.co.kr/api/v1/msg/lms")
.header("accept", "application/json")
.header("Content-Type", "application/json")
.header("pApiToken", "") // 연동토큰
.body(paramMap)
.asJson();

// JSONObject obj = response.getBody().getObject().getJSONObject("objKey");
// String strVal = obj.getString ("strKey");
// JSONArray arr = response.getBody().getObject().getJsonArray("arrayKey");
MMS 문자 메세지 발송
post

MMS 문자를 발송합니다.
※이모지 문자가 포함된 메세지는 삭제되고 발송됩니다.

https://papi.udpay.co.kr/api/v1/msg/mms

  • pApiToken

    STRING 필수

    연동토큰

    UDPAY 부가서비스 연동토큰

  • sendNumber

    STRING 필수

    수신번호

    발신자에게 보여지는 번호

  • recvNumbers

    ARRAY 필수

    발신번호 리스트

    수신받는 번호 리스트

    • recvNumber

      STRING 필수

      발신번호

      수신받는 번호
      [예:Arrays.asList("010XXXXXXXX", "010XXXXXXXX")]

  • sendDate

    STRING

    예약 발송

    예약 발송 날짜(yyyyMMddHHmmss)
    [발송 1분전에는 취소 불가능]

  • message

    STRING 필수

    메세지

    발송 메세지

  • subject

    STRING

    제목

    문자 제목

  • fileList

    ARRAY

    파일 리스트

    첨부파일 리스트

    • file

      FILE

      파일

      첨부파일(File 객체)

  • attachs

    ARRAY

    파일 리스트

    첨부파일 리스트

    • attach

      OBJECT

      파일 정보

      첨부파일 정보

      • fileName

        STRING

        파일명

        이미지 파일명

      • base64Encode

        STRING

        base64 인코딩

        이미지파일을 Base64로 인코딩한 데이터

  • state

    STRING 필수

    요청 결과

    true 성공, false 실패

  • message

    STRING

    메세지

    요청 결과 메세지

  • errorMessage

    STRING

    오류 메세지

    요청 결과에 대한 오류 메세지

  • errorType

    STRING

    오류 번호

    요청 결과에 대한 오류 번호

  • result

    OBJECT

    결과 데이터

    결과 데이터 정보

    • groupID

      STRING

      그룹ID

      해당 요청건에 대한 ID값

    • successCnt

      NUMBER

      요청 성공 건수

    • errorCnt

      NUMBER

      요청 에러 건수

코드샘플
// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01

Map<String, Object> paramMap = new HashMap<> ();

paramMap.put ("sendNumber", "");	// 수신번호
paramMap.put ("recvNumbers", "");	// 발신번호 리스트
paramMap.put ("sendDate", "");	// 예약 발송
paramMap.put ("message", "");	// 메세지
paramMap.put ("subject", "");	// 제목
paramMap.put ("fileList", "");	// 파일 리스트
paramMap.put ("attachs", "");	// 파일 리스트

HttpResponse response = Unirest.post("https://papi.udpay.co.kr/api/v1/msg/mms")
.header("accept", "application/json")
.header("Content-Type", "application/json")
.header("pApiToken", "") // 연동토큰
.body(paramMap)
.asJson();

// JSONObject obj = response.getBody().getObject().getJSONObject("objKey");
// String strVal = obj.getString ("strKey");
// JSONArray arr = response.getBody().getObject().getJsonArray("arrayKey");
예약문자 취소
get

예약문자로 요청된 문자건에 대한 발송을 취소합니다.

https://papi.udpay.co.kr/api/v1/msg/reservation/cancel/{groupID}

  • pApiToken

    STRING 필수

    연동토큰

    UDPAY 부가서비스 연동토큰

  • groupID

    STRING

  • state

    STRING 필수

    요청 결과

    true 성공, false 실패

  • message

    STRING

    메세지

    요청 결과 메세지

  • errorMessage

    STRING

    오류 메세지

    요청 결과에 대한 오류 메세지

  • errorType

    STRING

    오류 번호

    요청 결과에 대한 오류 번호

코드샘플
// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01


HttpResponse response = Unirest.get("https://papi.udpay.co.kr/api/v1/msg/reservation/cancel/{groupID}")
.header("accept", "application/json")
.header("pApiToken", "") // 연동토큰
.routeParam("groupID", "") // 
.asJson();

// JSONObject obj = response.getBody().getObject().getJSONObject("objKey");
// String strVal = obj.getString ("strKey");
// JSONArray arr = response.getBody().getObject().getJsonArray("arrayKey");
문자 메세지 리스트
post

발송한 메세지를 보여줍니다.

https://papi.udpay.co.kr/api/v1/msg/list/{page}

  • pApiToken

    STRING 필수

    연동토큰

    UDPAY 부가서비스 연동토큰

  • pageNumber

    STRING

    페이지 번호 [최초 페이지 1]

  • perPage

    STRING

    페이지 크기

    한 페이지당 보여지는 데이터 사이즈[최대 100]

  • sort

    BOOLEAN

    정렬

    true : 등록일 ASC
    false : 등록일 DESC

  • state

    STRING 필수

    요청 결과

    true 성공, false 실패

  • message

    STRING

    메세지

    요청 결과 메세지

  • errorMessage

    STRING

    오류 메세지

    요청 결과에 대한 오류 메세지

  • errorType

    STRING

    오류 번호

    요청 결과에 대한 오류 번호

  • result

    OBJECT

    결과 데이터

    결과 데이터 정보

    • total

      STRING

      전체 데이터 갯수

    • pageNumber

      STRING

      페이지 번호

    • perPage

      STRING

      페이지 크기

    • pageCount

      STRING

      페이지 갯수

    • content

      ARRAY

      리스트 데이터

      • data

        OBJECT

        테이터

        • groupID

          STRING

          그룹ID

          해당 요청건에 대한 ID값

        • sendType

          STRING

          메세지 타입

          허용값 리스트
          SMS 단문
          LMS 메세지 장문
          MMS 메세지 장문 + 이미지

        • totalCnt

          NUMBER

          총 발송 건수

        • subject

          STRING

          제목

          문자 제목

        • message

          STRING

          메세지

          발송 메세지

        • sendNumber

          STRING

          발송번호

          발신자에게 보여지는 번호

        • recvNumbers

          ARRAY

          발신번호 리스트

          수신받는 번호 리스트

          • recvNumber

            STRING

            발신번호

            수신받는 번호
            [예:Arrays.asList("010XXXXXXXX", "010XXXXXXXX")]

        • requestState

          STRING

          문자 상태

          허용값 리스트
          READY 대기
          SENDING 발송 요청중
          COMPLETE 발송 완료
          REQUEST_RES 예약 요청
          CANCEL_RES 예약 취소

        • requestDate

          STRING

          요청 날짜

          발송 요청 날짜(yyyyMMddHHmmss)

        • regDate

          STRING

          등록 날짜

          문자 등록 날짜(yyyyMMddHHmmss)

        • sendDate

          STRING

          발송 날짜

          문자 발송 날짜(yyyyMMddHHmmss)

코드샘플
// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01

Map<String, Object> paramMap = new HashMap<> ();

paramMap.put ("perPage", "20");	// 페이지 크기
paramMap.put ("sort", "false");	// 정렬

HttpResponse response = Unirest.post("https://papi.udpay.co.kr/api/v1/msg/list/{page}")
.header("accept", "application/json")
.header("Content-Type", "application/json")
.header("pApiToken", "") // 연동토큰
.routeParam("pageNumber", "") // 페이지 번호 [최초 페이지 1]
.body(paramMap)
.asJson();

// JSONObject obj = response.getBody().getObject().getJSONObject("objKey");
// String strVal = obj.getString ("strKey");
// JSONArray arr = response.getBody().getObject().getJsonArray("arrayKey");
문자 메세지 상세 정보
get

발송한 메세지 상세 정보입니다.

https://papi.udpay.co.kr/api/v1/msg/detail/{groupID}

  • pApiToken

    STRING 필수

    연동토큰

    UDPAY 부가서비스 연동토큰

  • groupID

    STRING

    그룹ID

  • state

    STRING 필수

    요청 결과

    true 성공, false 실패

  • message

    STRING

    메세지

    요청 결과 메세지

  • errorMessage

    STRING

    오류 메세지

    요청 결과에 대한 오류 메세지

  • errorType

    STRING

    오류 번호

    요청 결과에 대한 오류 번호

  • result

    ARRAY

    결과 데이터

    결과 데이터 정보

    • data

      OBJECT

      데이터

      • groupID

        STRING

        그룹ID

        해당 요청건에 대한 ID값

      • sendNumber

        STRING

        발송번호

        발신자에게 보여지는 번호

      • recvNumber

        STRING

        발신번호

        수신받는 번호

      • subject

        STRING

        제목

        문자 제목

      • message

        STRING

        메세지

        발송 메세지

      • attachFiles

        ARRAY

        파일 리스트

        파일 URL 리스트

        • url

          STRING

          파일 URL

          파일 URL

      • sendState

        STRING

        발송 상태

        허용값 리스트
        SMS 단문
        LMS 메세지 장문
        MMS 메세지 장문 + 이미지

      • sendType

        STRING

        문자 상태

        허용값 리스트
        READY 대기
        SENDING 발송중
        COMPLETE 발송 요청완료
        SUCCESS 발송 성공
        REQUEST_RES 예약 요청
        CANCEL_RES 예약 취소
        ERROR 발송 에러

      • sendDate

        STRING

        발송 날짜

        문자 발송 날짜(yyyyMMddHHmmss)

      • requestDate

        STRING

        요청 날짜

        발송 요청 날짜(yyyyMMddHHmmss)

      • errorCode

        STRING

        오류 코드

      • errorMessage

        STRING

        오류 메세지

코드샘플
// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01


HttpResponse response = Unirest.get("https://papi.udpay.co.kr/api/v1/msg/detail/{groupID}")
.header("accept", "application/json")
.header("pApiToken", "") // 연동토큰
.routeParam("groupID", "") // 그룹ID
.asJson();

// JSONObject obj = response.getBody().getObject().getJSONObject("objKey");
// String strVal = obj.getString ("strKey");
// JSONArray arr = response.getBody().getObject().getJsonArray("arrayKey");