알림톡

알림톡 프로필 토큰 요청
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 필수

    보안템플릿 설정 여부

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

    허용값 리스트
    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

        보안템플릿 설정 여부

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

        허용값 리스트
        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

      보안템플릿 설정 여부

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

      허용값 리스트
      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 일 경우 입력