UDPAY API Developers

본문내용

알림톡

알림톡 프로필 토큰 요청

get

알림톡 프로필 등록에 필요한 토큰을 요청합니다.

https://papi.udpay.co.kr/api/v1/kakao/notice/manage/token/{yellowId}/{phoneNumber}

pApiToken

STRING 필수

연동토큰

UDPAY 부가서비스 연동토큰

yellowId

STRING

플러스친구ID [예시 : @유디페이, @udid_dev2]
phoneNumber

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/kakao/notice/manage/token/{yellowId}/{phoneNumber}")
.header("accept", "application/json")
.header("pApiToken", "") // 연동토큰
.routeParam("yellowId", "") // 플러스친구ID [예시 : @유디페이, @udid_dev2]
.routeParam("phoneNumber", "") // 카카오톡채널 관리자에 등록한 휴대폰번호
.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/kakao/notice/manage/categoryAll

pApiToken

STRING 필수

연동토큰

UDPAY 부가서비스 연동토큰

state

STRING 필수

요청 결과

true 성공, false 실패
message

STRING

메세지

요청 결과 메세지
errorMessage

STRING

오류 메세지

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

STRING

오류 번호

요청 결과에 대한 오류 번호
result

ARRAY

결과 데이터

결과 데이터 정보
예 :
[{"code":"00100010001","name":"건강,병원,종합병원"}, {"code":"00100010002","name":"건강,병원,피부과"}]
- category
  
  OBJECT
  
  카테고리 데이터
  - code
    
    STRING
    
    카테고리 코드
  - name
    
    STRING
    
    카테고리 명

코드샘플

// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01


HttpResponse response = Unirest.get("https://papi.udpay.co.kr/api/v1/kakao/notice/manage/categoryAll")
.header("accept", "application/json")
.header("pApiToken", "") // 연동토큰
.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/kakao/notice/manage/category

pApiToken

STRING 필수

연동토큰

UDPAY 부가서비스 연동토큰

categoryCode

STRING

카테고리 코드

state

STRING 필수

요청 결과

true 성공, false 실패
message

STRING

메세지

요청 결과 메세지
errorMessage

STRING

오류 메세지

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

STRING

오류 번호

요청 결과에 대한 오류 번호
result

OBJECT

결과 데이터

결과 데이터 정보
- code
  
  STRING
  
  카테고리 코드
- name
  
  STRING
  
  카테고리 명

코드샘플

// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01


HttpResponse response = Unirest.get("https://papi.udpay.co.kr/api/v1/kakao/notice/manage/category")
.header("accept", "application/json")
.header("pApiToken", "") // 연동토큰
.queryString("categoryCode", "") // 카테고리 코드
.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/kakao/notice/manage/sendProfile

pApiToken

STRING 필수

연동토큰

UDPAY 부가서비스 연동토큰

token

STRING 필수

토큰

알림톡 프로필 토큰 요청 시 카카오톡으로 보내주는 토큰 값
phoneNumber

STRING 필수

토큰 요청시 입력받은 전화번호

카카오톡채널 관리자에 등록한 휴대폰번호
yellowId

STRING 필수

플러스친구ID

[예시 : @유디페이, @udid_dev2]
categoryCode

STRING 필수

카테고리 코드

알림톡 카테고리 리스트 정보중에 code 정보

state

STRING 필수

요청 결과

true 성공, false 실패
message

STRING

메세지

요청 결과 메세지
errorMessage

STRING

오류 메세지

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

STRING

오류 번호

요청 결과에 대한 오류 번호

result

OBJECT

결과 데이터

결과 데이터 정보

senderKey

STRING

발신 프로필 키
uuid

STRING

플러스친구ID

[예시 : @유디아이디, @udid_dev2]
name

STRING

플러스친구 프로필명

status

STRING

상태

허용값 리스트
A	정상
S	차단
D	삭제

profileStatus

STRING

플러스친구 상태

허용값 리스트
A	활성화
C	비활성화
B	차단
E	삭제중
D	삭제

createdAt

DATE

등록일
modifiedAt

DATE

수정일
categoryCode

STRING

카테고리 코드

alimtalk

BOOLEAN

알림톡 사용 여부

허용값 리스트
true	사용
false	중지

bizchat

BOOLEAN

알림톡 상담 여부

알림톡 상담기능 사용 여부

허용값 리스트
true	사용함
false	사용안함

코드샘플

// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01

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

paramMap.put ("token", "");	// 토큰
paramMap.put ("phoneNumber", "");	// 토큰 요청시 입력받은 전화번호
paramMap.put ("yellowId", "");	// 플러스친구ID
paramMap.put ("categoryCode", "");	// 카테고리 코드

HttpResponse response = Unirest.post("https://papi.udpay.co.kr/api/v1/kakao/notice/manage/sendProfile")
.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/kakao/notice/manage/getSenderProfile

pApiToken

STRING 필수

연동토큰

UDPAY 부가서비스 연동토큰

senderKey

STRING 필수

발신 프로필 키

state

STRING 필수

요청 결과

true 성공, false 실패
message

STRING

메세지

요청 결과 메세지
errorMessage

STRING

오류 메세지

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

STRING

오류 번호

요청 결과에 대한 오류 번호

result

OBJECT

결과 데이터

결과 데이터 정보

senderKey

STRING

발신 프로필 키
uuid

STRING

플러스친구ID

[예시 : @유디아이디, @udid_dev2]
name

STRING

플러스친구 프로필명

status

STRING

상태

허용값 리스트
A	정상
S	차단
D	삭제

profileStatus

STRING

플러스친구 상태

허용값 리스트
A	활성화
C	비활성화
B	차단
E	삭제중
D	삭제

createdAt

DATE

등록일
modifiedAt

DATE

수정일
categoryCode

STRING

카테고리 코드

alimtalk

BOOLEAN

알림톡 사용 여부

허용값 리스트
true	사용
false	중지

bizchat

BOOLEAN

알림톡 상담 여부

알림톡 상담기능 사용 여부

허용값 리스트
true	사용함
false	사용안함

코드샘플

// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01


HttpResponse response = Unirest.get("https://papi.udpay.co.kr/api/v1/kakao/notice/manage/getSenderProfile")
.header("accept", "application/json")
.header("pApiToken", "") // 연동토큰
.queryString("senderKey", "") // 발신 프로필 키
.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/kakao/notice/manage/getSenderProfiles

pApiToken

STRING 필수

연동토큰

UDPAY 부가서비스 연동토큰

senderKey

STRING 필수

발신 프로필 키

state

STRING 필수

요청 결과

true 성공, false 실패
message

STRING

메세지

요청 결과 메세지
errorMessage

STRING

오류 메세지

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

STRING

오류 번호

요청 결과에 대한 오류 번호

result

ARRAY

결과 데이터

결과 데이터 정보

profile

OBJECT

알림톡 발신 프로필

senderKey

STRING

발신 프로필 키
uuid

STRING

플러스친구ID

[예시 : @유디아이디, @udid_dev2]
name

STRING

플러스친구 프로필명

status

STRING

상태

허용값 리스트
A	정상
S	차단
D	삭제

profileStatus

STRING

플러스친구 상태

허용값 리스트
A	활성화
C	비활성화
B	차단
E	삭제중
D	삭제

createdAt

DATE

등록일
modifiedAt

DATE

수정일
categoryCode

STRING

카테고리 코드

alimtalk

BOOLEAN

알림톡 사용 여부

허용값 리스트
True	사용
False	중지

bizchat

BOOLEAN

알림톡 상담 여부

알림톡 상담기능 사용 여부

허용값 리스트
True	사용함
False	사용안함

코드샘플

// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01


HttpResponse response = Unirest.get("https://papi.udpay.co.kr/api/v1/kakao/notice/manage/getSenderProfiles")
.header("accept", "application/json")
.header("pApiToken", "") // 연동토큰
.queryString("senderKey", "") // 발신 프로필 키
.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/kakao/notice/manage/template/category/all

pApiToken

STRING 필수

연동토큰

UDPAY 부가서비스 연동토큰

state

STRING 필수

요청 결과

true 성공, false 실패
message

STRING

메세지

요청 결과 메세지
errorMessage

STRING

오류 메세지

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

STRING

오류 번호

요청 결과에 대한 오류 번호
result

ARRAY

결과 데이터

결과 데이터 정보
예:
[{"code":"001001","name":"회원가입","groupName":"회원","inclusion":"회원가입 완료 내용의 템플릿이 대상입니다. 가입에 따른 축하적립금/쿠폰을 포함합니다.","exclusion":"상품/서비스가입은 구매 > 상품가입 (002002)로 분류합니다."},{"code":"001002","name":"인증/비밀번호/로그인","groupName":"회원","inclusion":"OTP, 로그인여부, 임시비밀번호, 본인확인 용도의 템플릿이 대상입니다.","exclusion":""}]
- templateCategory
  
  OBJECT
  
  템플릿 카테고리 데이터
  - code
    
    STRING
    
    카테고리 코드
  - name
    
    STRING
    
    카테고리 이름
  - groupName
    
    STRING
    
    카테고리 그룹 이름
  - inclusion
    
    STRING
    
    카테고리 적용 대상 템플릿 설명
  - exclusion
    
    STRING
    
    카테고리 제외 대상 템플릿 설명

코드샘플

// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01


HttpResponse response = Unirest.get("https://papi.udpay.co.kr/api/v1/kakao/notice/manage/template/category/all")
.header("accept", "application/json")
.header("pApiToken", "") // 연동토큰
.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/kakao/notice/manage/template/create

pApiToken

STRING 필수

연동토큰

UDPAY 부가서비스 연동토큰

senderKey

STRING 필수

발신 프로필 키

senderKeyType G 인 경우 그룹키
templateCode

STRING 필수

템플릿 코드

회원사가 유일값으로 생성하는 코드 값
[예시 : UP_TEST_TEMPLATE]
templateName

STRING 필수

템플릿 이름
templateContent

STRING

템플릿 내용

[예시 : [#{서비스명}] 안녕하세요. #{회원명}님 회원가입을 진심으로 환영합니다. 앞으로 많은 이용 부탁 드립니다. 감사합니다.]

senderKeyType

STRING

발신 프로필 키 타입

허용값 리스트
G	그룹
S	발신 프로필

templateMessageType

STRING 필수

템플릿 메시지 유형

EX : templateExtra 필드 필수
AD : templateAd 필드 필수
MI : templateExtra, templateAd 필드 필수

허용값 리스트
BA	기본형(default)
EX	부가정보형
AD	광고추가형
MI	복합형

categoryCode

STRING 필수

템플릿 카테고리 코드(6자리 숫자)
templateExtra

STRING

부가 정보
templateAd

STRING

템플릿 내 수신 동의 요청 또는 간단 광고 문구

securityFlag

BOOLEAN 필수

보안템플릿 설정 여부

보안템플릿으로 설정한 경우 모바일 외 pc를 포함한 모든 디바이스에서 메시지 원 텍스트가 미노출되며, "모바일에서 확인해주세요"로 보여집니다
OTP, 비밀번호, 신용정보 변경 등 보안 메시지로 확인되는 경우 요청값과 무관하게 보안템플릿으로 설정됨

허용값 리스트
true	미노출
false	노출

buttons

ARRAY

버튼 정보 리스트

최대 5개 버튼 생성

button

OBJECT

버튼 정보

ordering

NUMBER 필수

버튼 노출 순서
name

STRING 필수

버튼명

linkType

STRING 필수

버튼 타입

허용값 리스트
DS	배송조회
WL	웹링크(Web, Mobile Web URL 호출 타입)
AL	앱링크(Application Custom Scheme 호출 타입)
BK	봇키워드(해당 버튼 텍스트 전송)
MD	메시지전달(해당 버튼 텍스트 + 메시지 본문 전송)
BT	봇전환
AC	채널 추가

linkTypeName

STRING

버튼의 링크타입 이름
linkMo

STRING

PC/Mobile 환경에서 버튼 클릭 시 이동할 url

linkType 값이 WL, AL 일 경우 입력
linkPc

STRING

PC 환경에서 이동할 URL

linkType 값이 WL, AL 일 경우 입력
linkAnd

STRING

mobile android 해서 실행할 application scheme

linkType 값이 AL 일 경우 입력
linkIos

STRING

mobile ios 환경에서 버튼 클릭 시 실행할 application scheme

linkType 값이 AL 일 경우 입력

state

STRING 필수

요청 결과

true 성공, false 실패
message

STRING

메세지

요청 결과 메세지
errorMessage

STRING

오류 메세지

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

STRING

오류 번호

요청 결과에 대한 오류 번호

result

OBJECT

알림톡 템플릿 결과

senderKey

STRING

발신 프로필 키
templateCode

STRING

템플릿 코드
templateName

STRING

템플릿 이름
templateContent

STRING

템플릿 내용

senderKeyType

STRING

발신 프로필 키 타입

허용값 리스트
G	그룹
S	발신 프로필

inspectionStatus

STRING

검수 상태

허용값 리스트
REG	등록
REQ	심사요청
APR	승인
REJ	반려

createdAt

STRING

등록일

yyyy-MM-dd HH:mm:ss
modifiedAt

STRING

수정일

yyyy-MM-dd HH:mm:ss

status

STRING

템플릿 상태

허용값 리스트
S	중단
A	정상
R	대기

comments

OBJECT

댓글 데이터 리스트
- comment
  
  OBJECT
  
  댓글 데이터
  - id
    
    NUMBER
    
    댓글 ID
  - content
    
    STRING
    
    댓글 내용
  - userName
    
    STRING
    
    댓글 작성자
  - createdAt
    
    STRING
    
    댓글 등록일
  - status
    
    STRING
    
    댓글 상태
  - attachment
    
    OBJECT
    
    첨부파일 데이터 리스트
    
    attach
    
    OBJECT
    
    첨부파일 데이터
    
    originalFileName
    
    STRING
    
    원본 파일명
    
    업로드 당시 기존 파일명
    
    filePath
    
    STRING
    
    파일 다운로드 경로

buttons

ARRAY

버튼 정보 리스트

button

BOOLEAN

버튼 정보

ordering

NUMBER

버튼 노출 순서
name

STRING

버튼명

linkType

STRING

버튼 타입

허용값 리스트
DS	배송조회
WL	웹링크(Web, Mobile Web URL 호출 타입)
AL	앱링크(Application Custom Scheme 호출 타입)
BK	봇키워드(해당 버튼 텍스트 전송)
MD	메시지전달(해당 버튼 텍스트 + 메시지 본문 전송)
BT	봇전환
AC	채널 추가

linkTypeName

STRING

버튼의 링크타입 이름
linkMo

STRING

mobile 환경에서 버튼 클릭 시 이동할 url

linkType 값이 WL, AL 일 경우 입력
linkPc

STRING

PC 환경에서 이동할 URL

linkType 값이 WL, AL 일 경우 입력
linkAnd

STRING

mobile android 해서 실행할 application scheme

linkType 값이 AL 일 경우 입력
linkIos

STRING

mobile ios 환경에서 버튼 클릭 시 실행할 application scheme

linkType 값이 AL 일 경우 입력

코드샘플

// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01

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

paramMap.put ("senderKey", "");	//  발신 프로필 키
paramMap.put ("templateCode", "");	// 템플릿 코드
paramMap.put ("templateName", "");	// 템플릿 이름
paramMap.put ("templateContent", "");	// 템플릿 내용
paramMap.put ("senderKeyType", "S");	// 발신 프로필 키 타입
paramMap.put ("templateMessageType", "BA");	// 템플릿 메시지 유형
paramMap.put ("categoryCode", "");	// 템플릿 카테고리 코드(6자리 숫자)
paramMap.put ("templateExtra", "");	// 부가 정보
paramMap.put ("templateAd", "");	// 템플릿 내 수신 동의 요청 또는 간단 광고 문구
paramMap.put ("securityFlag", "false");	// 보안템플릿 설정 여부
paramMap.put ("buttons", "");	// 버튼 정보 리스트

HttpResponse response = Unirest.post("https://papi.udpay.co.kr/api/v1/kakao/notice/manage/template/create")
.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");

알림톡 템플릿 수정 요청

put

알림톡에 등록된 템플릿 수정을 카카오톡에 요청합니다.

https://papi.udpay.co.kr/api/v1/kakao/notice/manage/template/update

pApiToken

STRING 필수

연동토큰

UDPAY 부가서비스 연동토큰

senderKey

STRING 필수

발신 프로필 키

senderKeyType G 인 경우 그룹키
templateCode

STRING 필수

템플릿 코드

회원사가 유일값으로 생성하는 코드 값
[예 : UP_TEST_TEMPLATE]
templateName

STRING 필수

템플릿 이름
templateContent

STRING 필수

템플릿 내용

senderKeyType

STRING

발신 프로필 키 타입

허용값 리스트
G	그룹
S	발신 프로필

templateMessageType

STRING 필수

템플릿 메시지 유형

EX : templateExtra 필드 필수
AD : templateAd 필드 필수
MI : templateExtra, templateAd 필드 필수

허용값 리스트
BA	기본형(default)
EX	부가정보형
AD	광고추가형
MI	복합형

categoryCode

STRING 필수

템플릿 카테고리 코드(6자리 숫자)
templateExtra

STRING

부가 정보
templateAd

STRING

템플릿 내 수신 동의 요청 또는 간단 광고 문구

securityFlag

BOOLEAN 필수

보안템플릿 설정 여부

허용값 리스트
true	미노출
false	노출

buttons

ARRAY

버튼 정보 리스트

최대 5개 버튼 생성

button

OBJECT

버튼 정보

name

STRING 필수

버튼명

linkType

STRING 필수

버튼 타입

허용값 리스트
DS	배송조회
WL	웹링크(Web, Mobile Web URL 호출 타입)
AL	앱링크(Application Custom Scheme 호출 타입)
BK	봇키워드(해당 버튼 텍스트 전송)
MD	메시지전달(해당 버튼 텍스트 + 메시지 본문 전송)
BT	봇전환
AC	채널 추가

linkTypeName

STRING

버튼의 링크타입 이름
ordering

STRING 필수

버튼 노출 순서
linkMo

STRING

PC/Mobile 환경에서 버튼 클릭 시 이동할 url

linkType 값이 WL, AL 일 경우 입력
linkPc

STRING

PC 환경에서 이동할 URL

linkType 값이 WL, AL 일 경우 입력
linkAnd

STRING

mobile android 해서 실행할 application scheme

linkType 값이 AL 일 경우 입력
linkIos

STRING

mobile ios 환경에서 버튼 클릭 시 실행할 application scheme

linkType 값이 AL 일 경우 입력

state

STRING 필수

요청 결과

true 성공, false 실패
message

STRING

메세지

요청 결과 메세지
errorMessage

STRING

오류 메세지

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

STRING

오류 번호

요청 결과에 대한 오류 번호

코드샘플

// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01

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

paramMap.put ("senderKey", "");	// 발신 프로필 키
paramMap.put ("templateCode", "");	// 템플릿 코드
paramMap.put ("templateName", "");	// 템플릿 이름
paramMap.put ("templateContent", "");	// 템플릿 내용
paramMap.put ("senderKeyType", "");	// 발신 프로필 키 타입
paramMap.put ("templateMessageType", "");	// 템플릿 메시지 유형
paramMap.put ("categoryCode", "");	// 템플릿 카테고리 코드(6자리 숫자)
paramMap.put ("templateExtra", "");	// 부가 정보
paramMap.put ("templateAd", "");	// 템플릿 내 수신 동의 요청 또는 간단 광고 문구
paramMap.put ("securityFlag", "false");	// 보안템플릿 설정 여부
paramMap.put ("buttons", "");	// 버튼 정보 리스트

HttpResponse response = Unirest.put("https://papi.udpay.co.kr/api/v1/kakao/notice/manage/template/update")
.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/kakao/notice/manage/templates

pApiToken

STRING 필수

연동토큰

UDPAY 부가서비스 연동토큰

state

STRING 필수

요청 결과

true 성공, false 실패
message

STRING

메세지

요청 결과 메세지
errorMessage

STRING

오류 메세지

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

STRING

오류 번호

요청 결과에 대한 오류 번호

result

ARRAY

결과 데이터

결과 데이터 정보

template

OBJECT

알림톡 템플릿

senderKey

STRING

발신 프로필 키
templateCode

STRING

템플릿 코드
templateName

STRING

템플릿 이름
templateContent

STRING

템플릿 내용

senderKeyType

STRING

발신 프로필 키 타입

허용값 리스트
G	그룹
S	발신 프로필

templateMessageType

STRING

템플릿 메시지 유형

EX : templateExtra 필드 필수
AD : templateAd 필드 필수
MI : templateExtra, templateAd 필드 필수

허용값 리스트
BA	기본형(default)
EX	부가정보형
AD	광고추가형
MI	복합형

inspectionStatus

STRING

검수 상태

허용값 리스트
REG	등록
REQ	심사요청
APR	승인
REJ	반려

createdAt

STRING

등록일
modifiedAt

STRING

수정일

status

STRING

템플릿 상태

허용값 리스트
S	중단
A	정상
R	대기

categoryCode

STRING

템플릿 카테고리 코드(6자리 숫자)
templateExtra

STRING

부가 정보
templateAd

STRING

템플릿 내 수신 동의 요청 또는 간단 광고 문구

securityFlag

STRING

보안템플릿 설정 여부

허용값 리스트
true	미노출
false	노출

buttons

ARRAY

버튼 정보 리스트

최대 5개 버튼 생성

button

OBJECT

버튼 정보

name

STRING

버튼명

linkType

STRING

버튼 타입

허용값 리스트
DS	배송조회
WL	웹링크(Web, Mobile Web URL 호출 타입)
AL	앱링크(Application Custom Scheme 호출 타입)
BK	봇키워드(해당 버튼 텍스트 전송)
MD	메시지전달(해당 버튼 텍스트 + 메시지 본문 전송)
BT	봇전환
AC	버튼의 링크타입 이름

linkTypeName

STRING

버튼의 링크타입 이름
ordering

STRING

버튼 노출 순서
linkMo

STRING

PC/Mobile 환경에서 버튼 클릭 시 이동할 url

linkType 값이 WL, AL 일 경우 입력
linkPc

STRING

PC 환경에서 이동할 URL

linkType 값이 WL, AL 일 경우 입력
linkAnd

STRING

mobile android 해서 실행할 application scheme

linkType 값이 AL 일 경우 입력
linkIos

STRING

mobile ios 환경에서 버튼 클릭 시 실행할 application scheme

linkType 값이 AL 일 경우 입력

comments

ARRAY

댓글 데이터 리스트

comment

OBJECT

댓글 데이터

id

NUMBER

댓글 ID
content

STRING

댓글 내용
userName

STRING

댓글 작성자
createdAt

STRING

댓글 등록일

status

STRING

댓글 상태

허용값 리스트
INQ	문의
APR	승인
REJ	반려
REP	답변

attachment

ARRAY

첨부파일 데이터 리스트
- attach
  
  OBJECT
  
  첨부파일 데이터
  - originalFileName
    
    STRING
    
    원본 파일명
    
    업로드 당시 기존 파일명
  - filePath
    
    STRING
    
    파일 다운로드 경로

코드샘플

// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01


HttpResponse response = Unirest.get("https://papi.udpay.co.kr/api/v1/kakao/notice/manage/templates")
.header("accept", "application/json")
.header("pApiToken", "") // 연동토큰
.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/kakao/notice/manage/template

pApiToken

STRING 필수

연동토큰

UDPAY 부가서비스 연동토큰

templateCode

STRING 필수

템플릿 코드

state

STRING 필수

요청 결과

true 성공, false 실패
message

STRING

메세지

요청 결과 메세지
errorMessage

STRING

오류 메세지

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

STRING

오류 번호

요청 결과에 대한 오류 번호

result

OBJECT

결과 데이터

결과 데이터 정보

senderKey

STRING

발신 프로필 키
templateCode

STRING

템플릿 코드
templateName

STRING

템플릿 이름
templateContent

STRING

템플릿 내용

senderKeyType

STRING

발신 프로필 키 타입

허용값 리스트
G	그룹
S	발신 프로필

templateMessageType

STRING

템플릿 메시지 유형

EX : templateExtra 필드 필수
AD : templateAd 필드 필수
MI : templateExtra, templateAd 필드 필수

허용값 리스트
BA	기본형(default)
EX	부가정보형
AD	광고추가형
MI	복합형

inspectionStatus

STRING

검수 상태

허용값 리스트
REG	등록
REQ	심사요청
APR	승인
REJ	반려

categoryCode

STRING

템플릿 카테고리 코드(6자리 숫자)
createdAt

STRING

등록일

yyyy-MM-dd HH:mm:ss
modifiedAt

STRING

수정일

yyyy-MM-dd HH:mm:ss

status

STRING

템플릿 상태

허용값 리스트
S	중단
A	정상
R	대기

templateExtra

STRING

부가 정보
templateAd

STRING

템플릿 내 수신 동의 요청 또는 간단 광고 문구

securityFlag

BOOLEAN

보안템플릿 설정 여부

허용값 리스트
true	미노출
false	노출

buttons

ARRAY

버튼 정보 리스트

button

OBJECT

버튼 정보

name

STRING

버튼명

linkType

STRING

버튼 타입

허용값 리스트
DS	배송조회
WL	웹링크(Web, Mobile Web URL 호출 타입)
AL	앱링크(Application Custom Scheme 호출 타입)
BK	봇키워드(해당 버튼 텍스트 전송)
MD	메시지전달(해당 버튼 텍스트 + 메시지 본문 전송)
BT	봇전환
AC	버튼의 링크타입 이름

linkTypeName

STRING

버튼의 링크타입 이름
ordering

NUMBER

버튼 노출 순서
linkMo

STRING

PC/Mobile 환경에서 버튼 클릭 시 이동할 url

linkType 값이 WL, AL 일 경우 입력
linkPc

STRING

PC 환경에서 이동할 URL

linkType 값이 WL, AL 일 경우 입력
linkAnd

STRING

mobile android 해서 실행할 application scheme

linkType 값이 AL 일 경우 입력
linkIos

STRING

mobile ios 환경에서 버튼 클릭 시 실행할 application scheme

linkType 값이 AL 일 경우 입력

comments

ARRAY

댓글 데이터 리스트

comment

OBJECT

댓글 데이터

id

NUMBER

댓글 ID
content

STRING

댓글 내용
userName

STRING

댓글 작성자
createdAt

STRING

댓글 등록일

status

STRING

댓글 상태

허용값 리스트
INQ	문의
APR	승인
REJ	반려
REP	답변

attachment

ARRAY

첨부파일 데이터 리스트
- attach
  
  OBJECT
  
  첨부파일 데이터
  - originalFileName
    
    STRING
    
    원본 파일명
    
    업로드 당시 기존 파일명
  - filePath
    
    STRING
    
    파일 다운로드 경로

코드샘플

// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01


HttpResponse response = Unirest.get("https://papi.udpay.co.kr/api/v1/kakao/notice/manage/template")
.header("accept", "application/json")
.header("pApiToken", "") // 연동토큰
.queryString("templateCode", "") // 템플릿 코드
.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/kakao/notice/manage/template/request

pApiToken

STRING 필수

연동토큰

UDPAY 부가서비스 연동토큰

templateCode

STRING 필수

템플릿 코드

state

STRING 필수

요청 결과

true 성공, false 실패
message

STRING

메세지

요청 결과 메세지
errorMessage

STRING

오류 메세지

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

STRING

오류 번호

요청 결과에 대한 오류 번호

코드샘플

// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01

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

paramMap.put ("templateCode", "");	// 템플릿 코드

HttpResponse response = Unirest.post("https://papi.udpay.co.kr/api/v1/kakao/notice/manage/template/request")
.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/kakao/notice/manage/template/refresh

pApiToken

STRING 필수

연동토큰

UDPAY 부가서비스 연동토큰

templateCode

STRING 필수

템플릿 코드

state

STRING 필수

요청 결과

true 성공, false 실패
message

STRING

메세지

요청 결과 메세지
errorMessage

STRING

오류 메세지

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

STRING

오류 번호

요청 결과에 대한 오류 번호

result

OBJECT

알림톡 템플릿 결과

senderKey

STRING

발신 프로필 키
templateCode

STRING

템플릿 코드
templateName

STRING

템플릿 이름
templateContent

STRING

템플릿 내용

senderKeyType

STRING

발신 프로필 키 타입

허용값 리스트
G	그룹
S	발신 프로필

templateMessageType

STRING

템플릿 메시지 유형

EX : templateExtra 필드 필수
AD : templateAd 필드 필수
MI : templateExtra, templateAd 필드 필수

허용값 리스트
BA	기본형(default)
EX	부가정보형
AD	광고추가형
MI	복합형

inspectionStatus

STRING

검수 상태

허용값 리스트
REG	등록
REQ	심사요청
APR	승인
REJ	반려

createdAt

STRING

등록일
modifiedAt

STRING

수정일

status

STRING

템플릿 상태

허용값 리스트
S	중단
A	정상
R	대기

categoryCode

STRING

템플릿 카테고리 코드(6자리 숫자)
templateExtra

STRING

부가 정보
templateAd

STRING

템플릿 내 수신 동의 요청 또는 간단 광고 문구

securityFlag

BOOLEAN

보안템플릿 설정 여부

허용값 리스트
true	미노출
false	노출

buttons

ARRAY

버튼 정보 리스트

최대 5개 버튼 생성

button

OBJECT

버튼 정보

name

STRING

버튼명

linkType

STRING

버튼 타입

허용값 리스트
DS	배송조회
WL	웹링크(Web, Mobile Web URL 호출 타입)
AL	앱링크(Application Custom Scheme 호출 타입)
BK	봇키워드(해당 버튼 텍스트 전송)
MD	메시지전달(해당 버튼 텍스트 + 메시지 본문 전송)
BT	봇전환
AC	버튼의 링크타입 이름

linkTypeName

STRING

버튼의 링크타입 이름
ordering

STRING

버튼 노출 순서
linkMo

STRING

PC/Mobile 환경에서 버튼 클릭 시 이동할 url

linkType 값이 WL, AL 일 경우 입력
linkPc

STRING

PC 환경에서 이동할 URL

linkType 값이 WL, AL 일 경우 입력
linkAnd

STRING

mobile android 해서 실행할 application scheme

linkType 값이 AL 일 경우 입력
linkIos

STRING

mobile ios 환경에서 버튼 클릭 시 실행할 application scheme

linkType 값이 AL 일 경우 입력

comments

ARRAY

댓글 데이터 리스트

comment

OBJECT

댓글 데이터

id

STRING

댓글 ID
content

STRING

댓글 내용
userName

STRING

댓글 작성자
createdAt

STRING

댓글 등록일

status

STRING

댓글 상태

허용값 리스트
INQ	문의
APR	승인
REJ	반려
REP	답변

attachment

ARRAY

첨부파일 데이터 리스트
- attach
  
  OBJECT
  
  첨부파일 데이터
  - originalFileName
    
    STRING
    
    원본 파일명
    
    업로드 당시 기존 파일명
  - filePath
    
    STRING
    
    파일 다운로드 경로

코드샘플

// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01


HttpResponse response = Unirest.get("https://papi.udpay.co.kr/api/v1/kakao/notice/manage/template/refresh")
.header("accept", "application/json")
.header("pApiToken", "") // 연동토큰
.queryString("templateCode", "") // 템플릿 코드
.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/kakao/notice/manage/template/comment

pApiToken

STRING 필수

연동토큰

UDPAY 부가서비스 연동토큰

templateCode

STRING 필수

템플릿 코드
comment

STRING 필수

문의 내역

state

STRING 필수

요청 결과

true 성공, false 실패
message

STRING

메세지

요청 결과 메세지
errorMessage

STRING

오류 메세지

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

STRING

오류 번호

요청 결과에 대한 오류 번호

result

OBJECT

결과 데이터

결과 데이터 정보

senderKey

STRING

발신 프로필 키
templateCode

STRING

템플릿 코드
templateName

STRING

템플릿 이름
templateContent

STRING

템플릿 내용

senderKeyType

STRING

발신 프로필 키 타입

허용값 리스트
G	그룹
S	발신 프로필

inspectionStatus

STRING

검수 상태

허용값 리스트
REG	등록
REQ	심사요청
APR	승인
REJ	반려

createdAt

STRING

등록일

yyyy-MM-dd HH:mm:ss
modifiedAt

STRING

수정일

yyyy-MM-dd HH:mm:ss

status

STRING

템플릿 상태

허용값 리스트
S	중단
A	정상
R	대기

categoryCode

STRING

템플릿 카테고리 코드(6자리 숫자)
templateExtra

STRING

부가 정보
templateAd

STRING

템플릿 내 수신 동의 요청 또는 간단 광고 문구
securityFlag

BOOLEAN

보안템플릿 설정 여부

보안템플릿으로 설정한 경우 모바일 외 pc를 포함한 모든 디바이스에서 메시지 원 텍스트가 미노출되며, "모바일에서 확인해주세요"로 보여집니다
OTP, 비밀번호, 신용정보 변경 등 보안 메시지로 확인되는 경우 요청값과 무관하게 보안템플릿으로 설정됨

comments

ARRAY

댓글 데이터 리스트

comment

OBJECT

댓글 데이터

id

NUMBER

댓글 ID
content

STRING

댓글 내용
userName

STRING

댓글 작성자
createdAt

STRING

댓글 등록일

yyyy-MM-dd HH:mm:ss

status

STRING

댓글 상태

허용값 리스트
INQ	문의
APR	승인
REJ	반려
REP	답변

buttons

ARRAY

버튼 정보 리스트
- button
  
  OBJECT
  
  버튼 정보
  - name
    
    STRING
    
    버튼명
  - linkType
    
    STRING
    
    버튼 타입
  - ordering
    
    NUMBER
    
    버튼 노출 순서
  - linkMo
    
    STRING
    
    PC/Mobile 환경에서 버튼 클릭 시 이동할 url
    
    linkType 값이 WL, AL 일 경우 입력
  - linkPc
    
    STRING
    
    PC 환경에서 이동할 URL
    
    linkType 값이 WL, AL 일 경우 입력
  - linkAnd
    
    STRING
    
    mobile android 해서 실행할 application scheme
    
    linkType 값이 AL 일 경우 입력
  - linkIos
    
    STRING
    
    mobile ios 환경에서 버튼 클릭 시 실행할 application scheme
    
    linkType 값이 AL 일 경우 입력

코드샘플

// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01

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

paramMap.put ("templateCode", "");	// 템플릿 코드
paramMap.put ("comment", "");	// 문의 내역

HttpResponse response = Unirest.post("https://papi.udpay.co.kr/api/v1/kakao/notice/manage/template/comment")
.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");

알림톡 템플릿 문의하기 (파일첨부)

post

알림톡 템플릿 관련되어서 카카오톡에 파일을 첨부해서 문의합니다.

https://papi.udpay.co.kr/api/v1/kakao/notice/manage/template/commentFile

pApiToken

STRING 필수

연동토큰

UDPAY 부가서비스 연동토큰

templateCode

STRING 필수

템플릿 코드
comment

STRING 필수

문의 내역
attachment1

FILE

파일첨부1
attachment2

FILE

파일첨부2
attachment3

FILE

파일첨부3
attachment4

FILE

파일첨부4
attachment5

FILE

파일첨부5

state

STRING 필수

요청 결과

true 성공, false 실패
message

STRING

메세지

요청 결과 메세지
errorMessage

STRING

오류 메세지

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

STRING

오류 번호

요청 결과에 대한 오류 번호

코드샘플

// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01


HttpResponse response = Unirest.post("https://papi.udpay.co.kr/api/v1/kakao/notice/manage/template/commentFile")
.header("accept", "application/json")
.header("pApiToken", "") // 연동토큰
.field("templateCode", "") // 템플릿 코드
.field("comment", "") // 문의 내역
.field("attachment1", "") // 파일첨부1
.field("attachment2", "") // 파일첨부2
.field("attachment3", "") // 파일첨부3
.field("attachment4", "") // 파일첨부4
.field("attachment5", "") // 파일첨부5
.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/kakao/notice/send

pApiToken

STRING 필수

연동토큰

UDPAY 부가서비스 연동토큰

senderKey

STRING 필수

발신 프로필 키
templateCode

STRING 필수

템플릿 코드
recvNumbers

ARRAY 필수

발신번호 리스트
- recvNumber
  
  STRING 필수
  
  발신번호
  
  수신받는 번호
  [예:Arrays.asList("010XXXXXXXX", "010XXXXXXXX")]
message

STRING 필수

알림톡 메세지

state

STRING 필수

요청 결과

true 성공, false 실패
message

STRING

메세지

요청 결과 메세지
errorMessage

STRING

오류 메세지

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

STRING

오류 번호

요청 결과에 대한 오류 번호
result

OBJECT

결과 데이터

결과 데이터 정보
- groupID
  
  STRING
  
  그룹ID
  
  해당 요청건에 대한 ID값
- successCnt
  
  NUMBER
  
  요청 성공 건수
- errorCnt
  
  NUMBER
  
  요청 에러 건수

error 알림톡 오류코드
- 1001
  
  NoJsonBody
  
  Request Body가 Json형식이 아님
- 1002
  
  InvalidHubPartnerKey
  
  허브 파트너 키가 유효하지 않음
- 1003
  
  InvalidSenderKey
  
  발신 프로필 키가 유효하지 않음
- 1004
  
  NoValueJsonElement
  
  Request Body(Json)에서 name을 찾을 수 없음
- 1005
  
  SenderNotFound
  
  발신프로필을 찾을 수 없음
- 1006
  
  DeletedSender
  
  삭제된 발신프로필. (메시지 사업 담당자에게 문의)
- 1007
  
  StoppedSender
  
  차단 상태의 발신프로필. (메시지 사업 담당자에게 문의)
- 1011
  
  ContractNotFound
  
  계약정보를 찾을 수 없음. (메시지 사업 담당자에게 문의)
- 1012
  
  InvalidUserKeyException
  
  잘못된 형식의 유저키 요청
- 1021
  
  BlockedProfile
  
  차단 상태의 플러스친구 (플러스친구 운영툴에서 확인)
- 1022
  
  DeactivatedProfile
  
  닫힘 상태의 플러스친구 (플러스친구 운영툴에서 확인)
- 1023
  
  DeletedProfile
  
  삭제된 플러스친구 (플러스친구 운영툴에서 확인)
- 1024
  
  DeletingProfile
  
  삭제대기 상태의 플러스친구 (플러스친구 운영툴에서 확인)
- 1025
  
  SpammedProfile
  
  메시지차단 상태의 플러스친구 (플러스친구 운영툴에서 확인)
- 1030
  
  InvalidParameterException
  
  잘못된 파라메터 요청
- 2003
  
  FailedToSendMessageByNoFriendshi pException
  
  메시지 전송 실패(테스트 서버에서 친구관계가 아닌 경우)
- 2004
  
  FailedToMatchTemplateException
  
  템플릿 일치 확인시 오류 발생 (내부 오류 발생)
- 3000
  
  UnexpectedException
  
  예기치 않은 오류 발생
- 3005
  
  AckTimeoutException
  
  메시지를 발송했으나 10초 이내에 고객 단말기로부터 ACK 수신 을 받지못한 경우 (성공불확실) - 서버에는 암호화 되어 보관되며 3일 이내 수신 가능 (카카오측 내부 운영방침)
- 3006
  
  FailedToSendMessageException
  
  내부 시스템 오류로 메시지 전송 실패
- 3008
  
  InvalidPhoneNumberException
  
  전화번호 오류
- 3010
  
  JsonParseException
  
  Json 파싱 오류
- 3011
  
  MessageNotFoundException
  
  메시지가 존재하지 않음
- 3012
  
  SerialNumberDuplicatedException
  
  메시지 일련번호가 중복됨 - 메시지 일련번호는 CS처리를 위해 고유한 값이 부여되어야 함.
- 3013
  
  MessageEmptyException
  
  메시지가 비어 있음
- 3014
  
  MessageLengthOverLimitException
  
  메시지 길이 제한 오류 (템플릿별 제한 길이 또는 1000자 초과)
- 3015
  
  TemplateNotFoundException
  
  템플릿을 찾을 수 없음
- 3016
  
  NoMatchedTemplateException
  
  메시지 내용이 템플릿과 일치하지 않음
- 3018
  
  NoSendAvailableException
  
  메시지를 전송할 수 없음 (카카오톡을 사용하지 않음, 최근 3일 동안 카카오톡을 사용 안함, 알림톡 차단을 선택한 사용자)
- 3019
  
  MessageNotSentException
  
  메시지가 발송되지 않은 상태
- 3020
  
  SeenInfoNotFoundException
  
  메시지 확인 정보를 찾을 수 없음
- 3022
  
  NoSendAvailableTimeException
  
  메시지 발송 가능한 시간이 아님 (친구톡 / 마케팅 메시지는 08시부터 20시까지 발송 가능)
- 3024
  
  MessageInvalidImageException
  
  메시지에 포함된 이미지를 전송할 수 없음
- 4000
  
  ResponseHistoryNotFoundException
  
  메시지 전송 결과를 찾을 수 없음
- 4001
  
  UnknownMessageStatusError
  
  알 수 없는 메시지 상태
- 9998
  
  8 현재 서비스를 제공하고 있지 않습 니다.
  
  시스템에 문제가 발생하여 담당자가 확인하고 있는 경우
- 9999
  
  시스템에서 알 수 없는 문제가 발 생하였습니다. 담당자가 확인 중입니다.
  
  시스템에 문제가 발생하여 담당자가 확인하고 있는 경우
- 888
  
  시스템 오류
  
  카카오톡 서버로부터 정상적인 응답 혹은 발송 결과 응답을 받 지 못한 경우 등
- 999
  
  시스템 Timeout
  
  카카오톡 서버와 통신중 Timeout

코드샘플

// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01

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

paramMap.put ("senderKey", "");	// 발신 프로필 키
paramMap.put ("templateCode", "");	// 템플릿 코드
paramMap.put ("recvNumbers", "");	// 발신번호 리스트
paramMap.put ("message", "");	// 알림톡 메세지

HttpResponse response = Unirest.post("https://papi.udpay.co.kr/api/v1/kakao/notice/send")
.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");

친구톡

친구톡 텍스트 발송

post

카카오톡 채널 친구로 추가한 고객에게 텍스트로 메시지를 보냅니다

https://papi.udpay.co.kr/api/v1/kakao/friend/text/send

pApiToken

STRING 필수

연동토큰

UDPAY 부가서비스 연동토큰

senderKey

STRING 필수

발신 프로필 키
recvNumbers

ARRAY 필수

발신번호 리스트
- recvNumber
  
  STRING
  
  발신번호
  
  수신받는 번호
  [예:Arrays.asList("010XXXXXXXX", "010XXXXXXXX")]
message

STRING 필수

발송 메시지

adFlag

STRING

친구톡 광고문구 기본 표시 여부

광고 표기 시 메세지 하단에 수신거부 안내 메세지 추가
수신거부 : 홈 > 친구차단

허용값 리스트
Y	광고 표기
N	광고 미표기

buttons

ARRAY

버튼 정보 리스트

최대 5개 버튼 생성

button

OBJECT

버튼 정보

name

STRING 필수

버튼명

type

STRING 필수

버튼 타입

허용값 리스트
WL	웹링크
AL	앱링크
BK	봇키워드
MD	메시지전달

url_pc

STRING

PC 웹링크

type : WL
PC 환경에서 버튼 클릭 시 이동할 URL
url_mobile

STRING

Mobile 웹링크

type : WL
Mobile 환경에서 버튼 클릭 시 이동할 URL
scheme_ios

STRING

Ios 앱링크

type : AL
Ios 환경 Application Custom Scheme
scheme_android

STRING

Android 앱링크

type : AL
Android 환경 Application Custom Scheme

state

STRING 필수

요청 결과

true 성공, false 실패
message

STRING

메세지

요청 결과 메세지
errorMessage

STRING

오류 메세지

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

STRING

오류 번호

요청 결과에 대한 오류 번호
result

OBJECT

결과 데이터

결과 데이터 정보
- groupID
  
  STRING
  
  그룹ID
  
  해당 요청건에 대한 ID값
- successCnt
  
  NUMBER
  
  요청 성공 건수
- errorCnt
  
  NUMBER
  
  요청 에러 건수

error 알림톡 오류코드
- 1001
  
  NoJsonBody
  
  Request Body가 Json형식이 아님
- 1002
  
  InvalidHubPartnerKey
  
  허브 파트너 키가 유효하지 않음
- 1003
  
  InvalidSenderKey
  
  발신 프로필 키가 유효하지 않음
- 1004
  
  NoValueJsonElement
  
  Request Body(Json)에서 name을 찾을 수 없음
- 1005
  
  SenderNotFound
  
  발신프로필을 찾을 수 없음
- 1006
  
  DeletedSender
  
  삭제된 발신프로필. (메시지 사업 담당자에게 문의)
- 1007
  
  StoppedSender
  
  차단 상태의 발신프로필. (메시지 사업 담당자에게 문의)
- 1011
  
  ContractNotFound
  
  계약정보를 찾을 수 없음. (메시지 사업 담당자에게 문의)
- 1012
  
  InvalidUserKeyException
  
  잘못된 형식의 유저키 요청
- 1021
  
  BlockedProfile
  
  차단 상태의 플러스친구 (플러스친구 운영툴에서 확인)
- 1022
  
  DeactivatedProfile
  
  닫힘 상태의 플러스친구 (플러스친구 운영툴에서 확인)
- 1023
  
  DeletedProfile
  
  삭제된 플러스친구 (플러스친구 운영툴에서 확인)
- 1024
  
  DeletingProfile
  
  삭제대기 상태의 플러스친구 (플러스친구 운영툴에서 확인)
- 1025
  
  SpammedProfile
  
  메시지차단 상태의 플러스친구 (플러스친구 운영툴에서 확인)
- 1030
  
  InvalidParameterException
  
  잘못된 파라메터 요청
- 2003
  
  FailedToSendMessageByNoFriendshi pException
  
  메시지 전송 실패(테스트 서버에서 친구관계가 아닌 경우)
- 2004
  
  FailedToMatchTemplateException
  
  템플릿 일치 확인시 오류 발생 (내부 오류 발생)
- 3000
  
  UnexpectedException
  
  예기치 않은 오류 발생
- 3005
  
  AckTimeoutException
  
  메시지를 발송했으나 10초 이내에 고객 단말기로부터 ACK 수신 을 받지못한 경우 (성공불확실) - 서버에는 암호화 되어 보관되며 3일 이내 수신 가능 (카카오측 내부 운영방침)
- 3006
  
  FailedToSendMessageException
  
  내부 시스템 오류로 메시지 전송 실패
- 3008
  
  InvalidPhoneNumberException
  
  전화번호 오류
- 3010
  
  JsonParseException
  
  Json 파싱 오류
- 3011
  
  MessageNotFoundException
  
  메시지가 존재하지 않음
- 3012
  
  SerialNumberDuplicatedException
  
  메시지 일련번호가 중복됨 - 메시지 일련번호는 CS처리를 위해 고유한 값이 부여되어야 함.
- 3013
  
  MessageEmptyException
  
  메시지가 비어 있음
- 3014
  
  MessageLengthOverLimitException
  
  메시지 길이 제한 오류 (템플릿별 제한 길이 또는 1000자 초과)
- 3015
  
  TemplateNotFoundException
  
  템플릿을 찾을 수 없음
- 3016
  
  NoMatchedTemplateException
  
  메시지 내용이 템플릿과 일치하지 않음
- 3018
  
  NoSendAvailableException
  
  메시지를 전송할 수 없음 (카카오톡을 사용하지 않음, 최근 3일 동안 카카오톡을 사용 안함, 알림톡 차단을 선택한 사용자)
- 3019
  
  MessageNotSentException
  
  메시지가 발송되지 않은 상태
- 3020
  
  SeenInfoNotFoundException
  
  메시지 확인 정보를 찾을 수 없음
- 3022
  
  NoSendAvailableTimeException
  
  메시지 발송 가능한 시간이 아님 (친구톡 / 마케팅 메시지는 08시부터 20시까지 발송 가능)
- 3024
  
  MessageInvalidImageException
  
  메시지에 포함된 이미지를 전송할 수 없음
- 4000
  
  ResponseHistoryNotFoundException
  
  메시지 전송 결과를 찾을 수 없음
- 4001
  
  UnknownMessageStatusError
  
  알 수 없는 메시지 상태
- 9998
  
  8 현재 서비스를 제공하고 있지 않습 니다.
  
  시스템에 문제가 발생하여 담당자가 확인하고 있는 경우
- 9999
  
  시스템에서 알 수 없는 문제가 발 생하였습니다. 담당자가 확인 중입니다.
  
  시스템에 문제가 발생하여 담당자가 확인하고 있는 경우
- 888
  
  시스템 오류
  
  카카오톡 서버로부터 정상적인 응답 혹은 발송 결과 응답을 받 지 못한 경우 등
- 999
  
  시스템 Timeout
  
  카카오톡 서버와 통신중 Timeout

코드샘플

// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01

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

paramMap.put ("senderKey", "");	// 발신 프로필 키
paramMap.put ("recvNumbers", "");	// 발신번호 리스트
paramMap.put ("message", "");	// 발송 메시지
paramMap.put ("adFlag", "Y");	// 친구톡 광고문구 기본 표시 여부
paramMap.put ("buttons", "");	// 버튼 정보 리스트

HttpResponse response = Unirest.post("https://papi.udpay.co.kr/api/v1/kakao/friend/text/send")
.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");

친구톡 이미지 첨부

post

친구톡으로 이미지 첨부해서 메세지 발송할때 사용하는 이미지를 업로드합니다.

1. 권장 크기 : 720px*720px
2. 제한 크기 - 가로 500px 미만 또는 가로:세로 비율이 2:1 미만 또는 3:4 초과시 업로드 불가
3. 파일형식 및 크기 : jpg, png / 최대 500KB

https://papi.udpay.co.kr/api/v1/kakao/friend/image/upload

pApiToken

STRING 필수

연동토큰

UDPAY 부가서비스 연동토큰

name

STRING 필수

파일명

파일 이름 확장자 포함
image

STRING 필수

이미지

base64 인코딩 파일

state

STRING 필수

요청 결과

true 성공, false 실패
message

STRING

메세지

요청 결과 메세지
errorMessage

STRING

오류 메세지

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

STRING

오류 번호

요청 결과에 대한 오류 번호
result

STRING

이미지 URL

해당 이미지로 등록된 URL 정보

코드샘플

// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01

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

paramMap.put ("name", "");	// 파일명
paramMap.put ("image", "");	// 이미지

HttpResponse response = Unirest.post("https://papi.udpay.co.kr/api/v1/kakao/friend/image/upload")
.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/kakao/friend/images

pApiToken

STRING 필수

연동토큰

UDPAY 부가서비스 연동토큰

state

STRING 필수

요청 결과

true 성공, false 실패
message

STRING

메세지

요청 결과 메세지
errorMessage

STRING

오류 메세지

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

STRING

오류 번호

요청 결과에 대한 오류 번호
result

OBJECT

결과 데이터
- id
  
  STRING
  
  이미지 ID
- memberID
  
  STRING
  
  회원 ID
- name
  
  STRING
  
  파일명
- image
  
  STRING
  
  이미지 URL
- regModDate
  
  OBJECT
  
  등록 수정일
  - regDate
    
    DATE
    
    등록일
  - modDate
    
    DATE
    
    수정일

코드샘플

// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01


HttpResponse response = Unirest.get("https://papi.udpay.co.kr/api/v1/kakao/friend/images")
.header("accept", "application/json")
.header("pApiToken", "") // 연동토큰
.asJson();

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

친구톡 이미지 발송

post

카카오톡 채널 친구로 추가한 고객에게 이미지를 첨부해서 메시지를 보냅니다

친구톡 이미지를 업로드 후 결과로 받은 URL경로를 추가해야합니다.

https://papi.udpay.co.kr/api/v1/kakao/friend/image/send

pApiToken

STRING 필수

연동토큰

UDPAY 부가서비스 연동토큰

senderKey

STRING 필수

발신 프로필 키
recvNumbers

ARRAY 필수

발신번호 리스트
- recvNumber
  
  STRING 필수
  
  발신번호
  
  수신받는 번호
  [예:Arrays.asList("010XXXXXXXX", "010XXXXXXXX")]
message

STRING 필수

메세지

친구톡 메세지

adFlag

STRING

광고문구 표기 여부

광고 표기 시 메세지 하단에 수신거부 안내 메세지 추가
수신거부 : 홈 > 친구차단

허용값 리스트
Y	광고 표기

imgUrl

STRING

이미지 URL

친구톡 이미지 첨부 후 리턴받은 이미지 URL
imgLink

STRING

이미지 링크

buttons

ARRAY

버튼 정보 리스트

최대 5개 버튼 생성

button

OBJECT

버튼 정보

name

STRING 필수

버튼명

type

STRING 필수

버튼 타입

허용값 리스트
WL	웹링크
AL	앱링크
BK	봇키워드
MD	메시지전달

url_pc

STRING

PC 웹링크

type : WL
PC 환경에서 버튼 클릭 시 이동할 URL
url_mobile

STRING

Mobile 웹링크

type : WL
Mobile 환경에서 버튼 클릭 시 이동할 URL
scheme_ios

STRING

Ios 앱링크

type : AL
Ios 환경 Application Custom Scheme
scheme_android

STRING

Android 앱링크

type : AL
Android 환경 Application Custom Scheme

state

STRING 필수

요청 결과

true 성공, false 실패
message

STRING

메세지

요청 결과 메세지
errorMessage

STRING

오류 메세지

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

STRING

오류 번호

요청 결과에 대한 오류 번호
result

OBJECT

결과 데이터

결과 데이터 정보
- groupID
  
  STRING
  
  그룹ID
  
  해당 요청건에 대한 ID값
- successCnt
  
  NUMBER
  
  요청 성공 건수
- errorCnt
  
  NUMBER
  
  요청 에러 건수

error 알림톡 오류코드
- 1001
  
  NoJsonBody
  
  Request Body가 Json형식이 아님
- 1002
  
  InvalidHubPartnerKey
  
  허브 파트너 키가 유효하지 않음
- 1003
  
  InvalidSenderKey
  
  발신 프로필 키가 유효하지 않음
- 1004
  
  NoValueJsonElement
  
  Request Body(Json)에서 name을 찾을 수 없음
- 1005
  
  SenderNotFound
  
  발신프로필을 찾을 수 없음
- 1006
  
  DeletedSender
  
  삭제된 발신프로필. (메시지 사업 담당자에게 문의)
- 1007
  
  StoppedSender
  
  차단 상태의 발신프로필. (메시지 사업 담당자에게 문의)
- 1011
  
  ContractNotFound
  
  계약정보를 찾을 수 없음. (메시지 사업 담당자에게 문의)
- 1012
  
  InvalidUserKeyException
  
  잘못된 형식의 유저키 요청
- 1021
  
  BlockedProfile
  
  차단 상태의 플러스친구 (플러스친구 운영툴에서 확인)
- 1022
  
  DeactivatedProfile
  
  닫힘 상태의 플러스친구 (플러스친구 운영툴에서 확인)
- 1023
  
  DeletedProfile
  
  삭제된 플러스친구 (플러스친구 운영툴에서 확인)
- 1024
  
  DeletingProfile
  
  삭제대기 상태의 플러스친구 (플러스친구 운영툴에서 확인)
- 1025
  
  SpammedProfile
  
  메시지차단 상태의 플러스친구 (플러스친구 운영툴에서 확인)
- 1030
  
  InvalidParameterException
  
  잘못된 파라메터 요청
- 2003
  
  FailedToSendMessageByNoFriendshi pException
  
  메시지 전송 실패(테스트 서버에서 친구관계가 아닌 경우)
- 2004
  
  FailedToMatchTemplateException
  
  템플릿 일치 확인시 오류 발생 (내부 오류 발생)
- 3000
  
  UnexpectedException
  
  예기치 않은 오류 발생
- 3005
  
  AckTimeoutException
  
  메시지를 발송했으나 10초 이내에 고객 단말기로부터 ACK 수신 을 받지못한 경우 (성공불확실) - 서버에는 암호화 되어 보관되며 3일 이내 수신 가능 (카카오측 내부 운영방침)
- 3006
  
  FailedToSendMessageException
  
  내부 시스템 오류로 메시지 전송 실패
- 3008
  
  InvalidPhoneNumberException
  
  전화번호 오류
- 3010
  
  JsonParseException
  
  Json 파싱 오류
- 3011
  
  MessageNotFoundException
  
  메시지가 존재하지 않음
- 3012
  
  SerialNumberDuplicatedException
  
  메시지 일련번호가 중복됨 - 메시지 일련번호는 CS처리를 위해 고유한 값이 부여되어야 함.
- 3013
  
  MessageEmptyException
  
  메시지가 비어 있음
- 3014
  
  MessageLengthOverLimitException
  
  메시지 길이 제한 오류 (템플릿별 제한 길이 또는 1000자 초과)
- 3015
  
  TemplateNotFoundException
  
  템플릿을 찾을 수 없음
- 3016
  
  NoMatchedTemplateException
  
  메시지 내용이 템플릿과 일치하지 않음
- 3018
  
  NoSendAvailableException
  
  메시지를 전송할 수 없음 (카카오톡을 사용하지 않음, 최근 3일 동안 카카오톡을 사용 안함, 알림톡 차단을 선택한 사용자)
- 3019
  
  MessageNotSentException
  
  메시지가 발송되지 않은 상태
- 3020
  
  SeenInfoNotFoundException
  
  메시지 확인 정보를 찾을 수 없음
- 3022
  
  NoSendAvailableTimeException
  
  메시지 발송 가능한 시간이 아님 (친구톡 / 마케팅 메시지는 08시부터 20시까지 발송 가능)
- 3024
  
  MessageInvalidImageException
  
  메시지에 포함된 이미지를 전송할 수 없음
- 4000
  
  ResponseHistoryNotFoundException
  
  메시지 전송 결과를 찾을 수 없음
- 4001
  
  UnknownMessageStatusError
  
  알 수 없는 메시지 상태
- 9998
  
  8 현재 서비스를 제공하고 있지 않습 니다.
  
  시스템에 문제가 발생하여 담당자가 확인하고 있는 경우
- 9999
  
  시스템에서 알 수 없는 문제가 발 생하였습니다. 담당자가 확인 중입니다.
  
  시스템에 문제가 발생하여 담당자가 확인하고 있는 경우
- 888
  
  시스템 오류
  
  카카오톡 서버로부터 정상적인 응답 혹은 발송 결과 응답을 받 지 못한 경우 등
- 999
  
  시스템 Timeout
  
  카카오톡 서버와 통신중 Timeout

코드샘플

// https://mvnrepository.com/artifact/com.konghq/unirest-java/3.6.01

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

paramMap.put ("senderKey", "");	// 발신 프로필 키
paramMap.put ("recvNumbers", "");	// 발신번호 리스트
paramMap.put ("message", "");	// 메세지
paramMap.put ("adFlag", "");	// 광고문구 표기 여부
paramMap.put ("imgUrl", "");	// 이미지 URL
paramMap.put ("imgLink", "");	// 이미지 링크
paramMap.put ("buttons", "");	// 버튼 정보 리스트

HttpResponse response = Unirest.post("https://papi.udpay.co.kr/api/v1/kakao/friend/image/send")
.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");