카카오 연동 관리

카카오 카테고리 정보 리스트 #

카카오 카테고리 정보 리스트를 조회합니다

▶ Request

URL

POST /kko/v2/channel/category/all HTTP/1.1
Authorization: Bearer {token}
Content-Type: application/json
Host: mnt-api.msghub.uplus.co.kr

Header

Name	Type	Required	Description
Authorization	String	true	사용자 인증 토큰

▶ Response

Name	Type	Description
code	String	결과 코드
message	String	결과 코드 설명
data	List	결과 데이터 목록
data.code	String	카테고리 코드
data.name	String	카테고리 명

▶ Sample

Curl

curl -X POST "https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/category/all"
-H  "accept: */*"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiYWNjZXNzVXJsIjoiYXV0aCIsImlzcyI6ImNtLmxndXBsdX..."
-d ""

Response

{
    "code": "10000",
    "message": "성공",
    "data": [
        {
        "code": "00100010001",
        "name": "건강,병원,종합병원"
        },
        ...
    ]
}

참고

결과 코드 참고

카카오 채널등록 사전정보 요청하기 #

알림톡 채널등록 사전정보 요청. (카카오 채널 등록시 사전 요청 필요)

▶ Request

URL

POST /kko/v2/channel/relayinfo HTTP/1.1
Authorization: Bearer {token}
Content-Type: application/json
Host: mnt-api.msghub.uplus.co.kr

Header

Name	Type	Required	Description
Authorization	String	true	사용자 인증 토큰

▶ Response

Name	Type	Description
code	String	결과 코드
message	String	결과 코드 설명
data.relayInfo	List	relay ID

▶ Sample

Curl

curl -X POST "https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/relayinfo"
-H  "accept: */*"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiYWNjZXNzVXJsIjoiYXV0aCIsImlzcyI6ImNtLmxndXBsdX..."
-H  "Content-Type: application/json"
-d ''"

Response

{
  "code": "10000",
  "message": "성공",
  "data": {
    "relay": [
      "r01",
      "r02"
    ]
  }
}

참고

결과 코드 참고

카카오 인증 토큰 요청하기 #

인증 토큰이 단말로 전달됩니다. (카카오 채널 등록시 사전 요청 필요)

▶ Request

URL

POST /kko/v2/channel/token HTTP/1.1
Authorization: Bearer {token}
Content-Type: application/json
Host: mnt-api.msghub.uplus.co.kr

Header

Name	Type	Required	Description
Authorization	String	true	사용자 인증 토큰

Requeset body

Name	Type	Required	Description
phoneNumber	String	true	휴대폰 번호
kkoChId	String	true	카카오 채널 ID (카카오비즈니스의 “내 채널” 목록에 있는 채널 아이디 ex) @내채널)
relay	String	true	카카오채널 등록 relay ID

▶ Response

Name	Type	Description
code	String	결과 코드
message	String	결과 코드 설명
data	Object	결과데이터목록
data.phoneNumber	String	휴대폰 번호
data.yellowId	String	카카오 채널 ID
data.kkoChId	String	카카오 채널 ID
data.relay	String	카카오채널 등록 relay ID

▶ Sample

Curl

curl -X POST "https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/token"
-H  "accept: */*"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiYWNjZXNzVXJsIjoiYXV0aCIsImlzcyI6ImNtLmxndXBsdX..."
-H  "Content-Type: application/json"
-d '
    {
        "phoneNumber": "01099999999",
        "kkoChId": "@kkoChId",
        "relay":"r01"
    }
'

Response

{
    "code": "10000",
    "message": "성공"
}

참고

결과 코드 참고

카카오 채널 등록 #

카카오 채널을 등록 합니다. (*카카오 채널 생성은 카카오비즈센터에서 합니다.)

▶ Request

URL

POST /kko/v2/channel/create HTTP/1.1
Authorization: Bearer {token}
Content-Type: application/json
Host: mnt-api.msghub.uplus.co.kr

Header

Name	Type	Required	Description
Authorization	String	true	사용자 인증 토큰

▶ Request body

Name	Type	Required	Description
tokens	List<RelayToken>	true	relay token 정보
categoryCode	String	true	카테고리 코드
kkoChId	String	true	카카오채널 검색용ID (카카오비즈니스의 “내 채널” 목록에 있는 채널 아이디 ex) @내채널)
memo	String	false	메모

tokens

Name	Type	Required	Description
rid	String	true	relay ID
token	Integer	true	인증 코드
phoneNumber	String	true	플러스친구 관리자번호

▶ Response

Name	Type	Description
code	String	결과 코드
message	String	결과 코드 설명

참고

카카오 채널 상태(kkoChStat)

A : activated
C : deactivated
B : block
E : deleting
D : deleted

▶ Sample

Curl

curl -X GET "https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/create"
-H  "accept: */*"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiYWNjZXNzVXJsIjoiYXV0aCIsImlzcyI6ImNtLmxndXBsdX..."
-d '
    {
      "tokens": [
    {
      "rid": "r01",
      "token": 364481,
      "phoneNumber": "0100000000"
    },
    "categoryCode": "01800040001",
    "kkoChId": "@채널아이디",
    "memo": "memo"
    }
'

Response

{
  "code": "10000",
  "message": "성공"
  }
}

참고

결과 코드 참고

카카오 채널 조회 #

카카오 채널을 조회합니다.

▶ Request

URL

POST /kko/v2/channel/get HTTP/1.1
Authorization: Bearer {token}
Content-Type: application/json
Host: mnt-api.msghub.uplus.co.kr

Header

Name	Type	Required	Description
Authorization	String	true	사용자 인증 토큰

Request Body

Name	Type	Required	Description
kkoChId	String	true	카카오 채널 ID (카카오비즈니스의 “내 채널” 목록에 있는 채널 아이디 ex) @내채널)

▶ Response

Name	Type	Description
code	String	결과 코드
message	String	결과 코드 설명
data	Object	결과 데이터 목록
data.kkoChId	String	카카오 채널 ID
data.stat	String	상태(A:정상, D:삭제)
data.createDate	String	생성일자
data.categoryCode	String	카테고리 코드

참고

카카오 채널 상태(kkoChStat)
A : activated
C : deactivated
B : block
E : deleting
D : deleted

▶ Sample

Curl

curl -X POST "https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/get"
-H  "accept: */*"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiYWNjZXNzVXJsIjoiYXV0aCIsImlzcyI6ImNtLmxndXBsdX..."
-H  "Content-Type: application/json"
-d '
    {
        "kkoChId": "@채널아이디"
    }
'

Response

{
  "code": "10000",
  "message": "성공",
  "data": {
    "kkoChId": "@kkoChId",
    "stat": "A",
    "createData":"2023-09-25T11:37:03",
    "categoryCode": "01300010001"
  }
}

참고

결과 코드 참고

템플릿 카테고리 코드 조회 #

템플릿 카테고리 코드를 조회합니다.

▶ Request

URL

POST /kko/v2/channel/template/category/all HTTP/1.1
Authorization: Bearer {token}
Content-Type: application/json
Host: mnt-api.msghub.uplus.co.kr

Header

Name	Type	Required	Description
Authorization	String	true	사용자 인증 토큰

▶ Response

Name	Type	Description
code	String	결과 코드
message	String	결과 코드 설명
data	List	결과 데이터 목록
data.code	String	카테고리 코드
data.name	String	카테고리 이름
data.groupName	String	카테고리 그룹 이름
data.iclusion	String	포함예시, 카테고리 적용대상 템플릿 설명
data.exclusion	String	제외예시, 카테고리 제외대상 템플릿 설명

▶ Sample

Curl

curl -X POST "https://mnt-api.msghub.uplus.co.kr/kko/v1/channel/template/category/all"
-H  "accept: */*"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiYWNjZXNzVXJsIjoiYXV0aCIsImlzcyI6ImNtLmxndXBsdX..."
-d ""

Response

{
    "code": "10000",
    "message": "성공",
    "data": [
        {
            "code": "001001",
            "name": "회원가입",
            "groupName": "회원",
            "iclusion": null,
            "exclusion": "상품/서비스가입은 구매 > 상품가입 (002002)로 분류합니다."
        },
        ...
    ]
}

참고

결과 코드 참고

템플릿 문의하기 #

템플릿 등록 요청합니다. (*L.Message ID 로만 문의 가능 합니다.)
부결(반려)된 템플릿에 대해 카카오에 문의 후 검수 요청 합니다.
부결(반려) 상태의 템플릿만 가능합니다.

▶ Request

URL

POST /kko/v2/channel/template/comment HTTP/1.1
Authorization: Bearer {token}
Content-Type: application/json
Host: mnt-api.msghub.uplus.co.kr

Header

Name	Type	Required	Description
Authorization	String	true	사용자 인증 토큰

Requeset body

Name	Type	Required	Description
kkoChId	String	true	카카오 채널ID (카카오비즈니스의 “내 채널” 목록에 있는 채널 아이디 ex) @내채널)
kkoGrpId	String	false	카카오 그룹ID
templateCode	String	true	템플릿 코드 (공백X)
senderType	String	true	발신프로필 타입(S:카카오채널, G:그룹)
comment	String	true	문의 내용

▶ Response

Name	Type	Description
code	String	결과 코드
message	String	결과 코드 설명

▶ Sample

Curl

curl -X POST "https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/template/comment"
-H  "accept: */*"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiYWNjZXNzVXJsIjoiYXV0aCIsImlzcyI6ImNtLmxndXBsdX..."
-H  "Content-Type: application/json"
-d '
    {
          "kkoChId": "@채널아이디",
          "kkoGrpId": "",
          "templateCode": "string",
          "senderType": "S",
           "comment": "(테스트)반려 시 문의하기 테스트"
    }
'

Response

{
    "code": "10000",
    "message": "성공"
}

참고

결과 코드 참고

템플릿 생성하기 #

템플릿을 생성합니다.

▶ Request

URL (이미지파일 없이 본문만 발송하는 경우)

POST /kko/v2/channel/template/create HTTP/1.1
Authorization: Bearer {token}
Content-Type: application/json
Host: mnt-api.msghub.uplus.co.kr

URL (이미지파일이 있는 경우)

POST /kko/v2/channel/template/create HTTP/1.1
Authorization: Bearer {token}
Content-Type: multipart/form-data
Host: mnt-api.msghub.uplus.co.kr

Header

Name	Type	Required	Description
Authorization	String	true	사용자 인증 토큰

Requeset body

Name	Type	Required	Description
kkoChId	String	true	채널아이디 (카카오비즈니스의 “내 채널” 목록에 있는 채널 아이디 ex) @내채널)
kkoGrpId	String	false	카카오 그룹ID
senderType	String	true	채널 타입(S:카카오채널, G:그룹)
templateCode	String	true	템플릿 코드 (공백X)
templateName	String	true	템플릿명
templateContent	String	true	템플릿내용
categoryCode	String	true	템플릿 카테고리코드
templateMessageType	String	true	메시지 유형
templateExtra	String	true	부가정보
templateAd	String	true	광고성메시지
templateEmphasizeType	String	true	강조표기유형
itemHeader	String	false	아이템리스트형 헤더정보
itemHighlightTitle	String	false	아이템하이라이트 타이틀
itemHighlightDescription	String	false	아이템하이라이트 설명
itemList	List<LMItemList>	false	아이템리스트
itemSummaryTitle	String	false	아이템 요약 정보 타이틀
itemSummarydescription	String	false	아이템 요약 정보 설명
templateTitle	String	false	강조표기핵심 정보
templateSubtitle	String	false	강조표기보조 문구
securityFlag	String	true	보안템플릿, 보안 템플릿 여부
buttons	List<button>	true	템플릿버튼

참고

메시지 유형(templateMessageType)
- BA : 기본형
- EX : 부가 정보형 (templateExtra 필드 필수)
- AD : 채널 추가형(기존. 광고 추가형, templateAd 필드 필수, 템플릿버튼 중 첫번째로 “name”:”채널 추가”, “type”:”AC” 필수)
- MI : 부가 정보형 (templateExtra, templateAd 필드 필수, 템플릿버튼 중 첫번째로 “name”:”채널 추가”, “type”:”AC” 필수)
강조표기유형(templateEmphasizeType)
- NONE : 선택안함
- TEXT: templateTitle, templateSubtitle 필드 필수
보안템플릿(securityFlag)
- OTP 등 보안 메시지 일 경우 설정 발신 당시의 메인 디바이스를 제외한 모든 디바이스에 메시지 텍스트 미노출
템플릿 등록 시 이모지를 사용하실 경우에는 Unicode 5.2 버전 이하만 가능합니다.

itemList

Name	Type	Required	Description
title	String	true	아이템리스트 타이틀
description	String	true	아이템리스트 설명

button

Name	Type	Required	Description
name	String	true	name
linkType	String	true	종류
linkMo	String	false	모바일링크
linkPc	String	false	pc 링크
linkAnd	String	false	android 실행
linkIos	String	false	ios 실행

buttons 타입별 속성

필수 파라미터를 모두 입력하셔야 정상적인 템플릿등록 가능

버튼 타입	속성	타입	필수	Description
WL	linkMo	text	Y	버튼 클릭 시 이동할 pc/mobile 환경별 web url
WL	linkPc	text	N
AL	linkAnd	text		linkIos, linkAnd, linkMo 중 2 가지 필수 입력mobile android 환경에서 버튼 클릭 시 실행할application custom scheme
AL	linkAnd	text		mobile android 환경에서 버튼 클릭 시 실행할application custom scheme
AL	linkMo	text		mobile 환경에서 버튼 클릭 시 이동할 url
AL	linkPc	text	N	pc 환경에서 버튼 클릭 시 이동할 url
BK				해당 버튼 텍스트 전송
MD				해당 버튼 텍스트 + 메시지 본문 전송
BC				상담톡 전환
BT				봇 전환
DS				메시지 내 송장번호 이용한 배송조회페이지로 연결
AC AC				채널추가- 광고추가형, 복합형템플릿에서만 사용가능- 버튼단톡 또는 최상단(첫번째버튼)에만 추가가능

▶ Response

Name	Type	Description
code	String	결과 코드
message	String	결과 코드 설명
data	Object	결과 데이터
data.templateKey	String	템플릿 키
data.templateCode	String	템플릿 코드
data.templateName	String	템플릿 이름
data.kkoChId	String	카카오 채널 ID
data.templateInfo	List	템플릿 정보
data.templateInfo.senderKey	String	발신 프로필 키
data.templateInfo.senderType	String	발신 프로필 타입
data.templateInfo.templateName	String	템플릿 이름
data.templateInfo.templateContent	String	템플릿 내용
data.templateInfo.categoryCode	String	카테고리 코드
data.templateInfo.templateMessageType	String	메세지 유형 (BA: 기본형, EX: 부가정보형, AD: 광고추가형, MI: 복합형)
data.templateInfo.templateExtra	String	부가정보
data.templateInfo.tempateAd	String	광고성메시지
data.templateInfo.templateEmphasizeType	String	강조표기유형 (NONE: 선택안함, TEXT: 강조표기형, IMAGE: 이미지형)
data.templateInfo.templateTitle	String	강조표기핵심 정보
data.templateInfo.templateSubtitle	String	강조표기보조 문구
data.templateInfo.securityFlag	String	보안템플릿 설정
data.templateInfo.buttons	List	템플릿 버튼
data.templateInfo.templateCode	String	템플릿 코드
data.templateInfo.kkoTemplateCode	String	카카오 템플릿 코드
data.templateInfo.templateStatusCode	String	템플릿 코드
data.templateInfo.block	String	차단여부
data.templateInfo.dormant	String	휴면여부
data.templateInfo.createId	String	생성자 ID
data.templateInfo.creatDate	String	생성일자
data.templateInfo.approvalDate	String	검수일자
data.templateInfo.comments	List	문의 내용 목록
data.templateInfo.templateKey	String	템플릿 키
data.templateInfo.relay	String	카카오채널 등록 relay ID
data.templateInfo.imageFileName	String	이미지파일명
data.templateInfo.itemHighlightImageFileName	String	아이템하이라이트 이미지파일명
data.regDt	String	등록일자
data.updDt	String	수정일자

템플릿 상태 코드

T : 신청완료
R : 검수요청완료 (롯데정보통신 검수중)
Q : 카카오 검수중
A : 템플릿 승인
S : 템플릿 반려

buttons

Name	Type	Description
name	String	name
linkType	String	종류
linkMo	String	모바일링크
linkPc	String	pc 링크
linkAnd	String	android 실행
linkIos	String	ios 실행
varUrlYn	String	URL 가변 값 포함 여부
kkoBtnOutbrowserYn	String	(WL 인경우만) 버튼 클릭시 URL 열리는 브라우저 설정 (N: 카카오톡에서 열림 (기본값) Y: 브라우저에서 열림)
chat_extra	String	봇관련 정보
chat_event	String	봇관련 이벤트정보

comments

Name	Type	Description
idx	String	댓글아이디
createId	String	작성자
content	String	내용
createDate	String	등록일
status	String	댓글 상태 (INQ: 문의, APR: 승인, REJ: 반려, REP: 답변)

▶ Sample

Curl (이미지파일 없이 본문만 발송하는 경우)

curl -X POST "https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/template/create"
-H  "accept: */*"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiYWNjZXNzVXJsIjoiYXV0aCIsImlzcyI6ImNtLmxndXBsdX..."
-H  "Content-Type: application/json"
-d '
    {
        "senderKey": "senderkey123456789123456789",
        "senderType": "S",
        "templateName": "환영인사",
        "templateContent": "#{이름}님 환영합니다..",
        "categoryCode": "008002",
        "templateMessageType": "BA",
        "templateExtra": "string",
        "templateAd": "string",
        "templateEmphasizeType": "NONE",
        "templateTitle": "string",
        "templateSubtitle": "string",
        "securityFlag": false,
        "buttons": [
            {
                "name": "연결하기",
                "linkType": "WL",
                "linkMo": "http://",
                "linkPc": "http://",
                "linkAnd": "http://",
                "linkIos": "http://"
            }
        ]
    }
'

Curl (이미지파일이 있는 경우)

curl -X POST "https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/template/create"
-H  "accept: */*"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiYWNjZXNzVXJsIjoiYXV0aCIsImlzcyI6ImNtLmxndXBsdX..."
-H  "Content-Type: multipart/form-data"
-F "reqBody={
  "senderKey": "da17d231bbf13f83174a36a4bb0353476ae012b3",
  "senderType": "S",
  "templateName": "환영인사",
  "templateContent": "#{이름}님 환영합니다..",
  "categoryCode": "008002",
  "templateMessageType": "BA",
  "templateExtra": "string",
  "templateAd": "string",
  "templateEmphasizeType": "NONE",
  "templateTitle": "string",
  "templateSubtitle": "string",
  "securityFlag": false,
  "buttons": [
    {
      "name": "사용량 제한 이용안내",
      "linkType": "WL",
      "linkMo": "http://m.naver.com",
      "linkPc": "http://www.naver.com",
      "linkAnd": "string",
      "linkIos": "string",
      "varUrlYn": "N",
      "kkoBtnOutbrowserYn": "N",
      "chat_extra": "chatExtraValue",
      "chat_event": "chatEventValue"
    }
  ]
}" 
-F "image=@300x300.png;type=image/png" (알림톡 이미지 등록 시)
-F "itemHighlightImage=@300x300.png;type=image/png" (아이템하이라이트 이미지 등록 시)

Response

{
  "code": "10000",
  "message": "성공",
  "data": {
    "templateKey": "string",
    "templateCode": "string",
    "templateName": "string",
    "kkoChId": "string",
    "templateInfo": {
      "senderKey": "da17d231bbf13f83174a36a4bb0353476ae012b3",
      "senderType": "S",
      "templateName": "환영인사",
      "templateContent": "#{이름}님 환영합니다..",
      "categoryCode": "008002",
      "templateMessageType": "BA",
      "templateExtra": "string",
      "templateAd": "string",
      "templateEmphasizeType": "NONE",
      "templateTitle": "string",
      "templateSubtitle": "string",
      "securityFlag": false,
      "buttons": [
        {
          "name": "사용량 제한 이용안내",
          "linkType": "WL",
          "linkMo": "http://m.naver.com",
          "linkPc": "http://www.naver.com",
          "linkAnd": "string",
          "linkIos": "string",
          "varUrlYn": "N",
          "kkoBtnOutbrowserYn": "N",
          "chat_extra": "chatExtraValue",
          "chat_event": "chatEventValue"
        }
      ],
      "templateCode": "LMSG_20210427164809574205",
      "kkoTemplateCode": "string",
      "templateStatusCode": "Q",
      "block": false,
      "dormant": false,
      "createId": "string",
      "createDate": "string",
      "approvalDate": "string",
      "comments": [
        {
          "idx": "86",
          "createId": "test11",
          "content": "템플릿 반려의견에 관한문의사항이 있습니다........(중략)",
          "createDate": "2019-08-06 16:03:33",
          "status": "INQ"
        }
      ],
      "templateKey": "string",
      "relay": "string",
      "imageFileName": "string",
      "itemHighlightImageFileName": "string"
    },
    "regDt": "string",
    "updDt": "string"
  }
}

참고

결과 코드 참고

템플릿 삭제하기 #

템플릿을 삭제합니다.

templateStatusCode = ‘T’(신청완료)

  ※ 템플릿 상태가 ‘T’ & 템플릿 등록 요청 L.Message ID & 등록한 senderKey가 모두 일치할 경우에만 삭제 가능합니다.

  ※ 삭제된 템플릿은 API 로 조회 등이 불가능합니다

▶ Request

URL

POST /kko/v2/channel/template/delete HTTP/1.1
Authorization: Bearer {token}
Content-Type: application/json
Host: mnt-api.msghub.uplus.co.kr

Header

Name	Type	Required	Description
Authorization	String	true	사용자 인증 토큰

Requeset body

Name	Type	Required	Description
kkoChId	String	true	카카오 채널ID (카카오비즈니스의 “내 채널” 목록에 있는 채널 아이디 ex) @내채널)
kkoGrpId	String	false	카카오 그룹ID
templateCode	String	true	템플릿 코드 (공백X)
senderKeyType	String	true	채널ID 유형 (S: 일반ID, G: 그룹ID)

▶ Response

Name	Type	Description
code	String	결과 코드
message	String	결과 코드 설명

▶ Sample

Curl

curl -X POST "https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/template/delete"
-H  "accept: */*"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiYWNjZXNzVXJsIjoiYXV0aCIsImlzcyI6ImNtLmxndXBsdX..."
-H  "Content-Type: application/json"
-d '
    {
        "kkoChId": "@채널아이디",
        "kkoGrpId": "",
        "templateCode": "string",
        "senderKeyType": "S"
    }
'

Response

{
    "code": "10000",
    "message": "성공"
}

참고

결과 코드 참고

템플릿 조회하기 #

템플릿을 조회합니다.

▶ Request

URL

POST /kko/v2/channel/template/get HTTP/1.1
Authorization: Bearer {token}
Content-Type: application/json
Host: mnt-api.msghub.uplus.co.kr

Header

Name	Type	Required	Description
Authorization	String	true	사용자 인증 토큰

Requeset body

Name	Type	Required	Description
kkoChId	String	true	카카오 채널ID (카카오비즈니스의 “내 채널” 목록에 있는 채널 아이디 ex) @내채널)
kkoGrpId	String	false	카카오 그룹ID
templateCode	String	true	템플릿 코드 (공백 X)
senderKeyType	String	true	채널ID 유형 (S: 일반ID, G: 그룹ID)

▶ Response

Name	Type	Description
code	String	결과 코드
message	String	결과 코드 설명
data	String	결과 데이터
data.templateKey	String	템플릿 키
data.templateCode	String	템플릿 코드
data.templateName	String	템플릿명
data.kkoChId	String	카카오 채널 아이디
data.templateInfo	Object	템플릿 정보
data.templateInfo.senderKey	String	발신프로필키
data.templateInfo.senderType	String	발신프로필타입(일반 : S, 그룹 : G)
data.templateInfo.templateName	String	템플릿명
data.templateInfo.templateContent	String	템플릿내용
data.templateInfo.categoryCode	String	카테고리코드
data.templateInfo.templateMessageType	String	메시지 유형
data.templateInfo.templateExtra	String	부가정보
data.templateInfo.templateAd	String	고성메시지
data.templateInfo.templateEmphasizeType	String	강조표기유형(NONE: 선택안함, TEXT:강조표기형)
data.templateInfo.templateTitle	String	강조표기핵심 정보
data.templateInfo.templateSubtitle	String	강조표기보조 문구
data.templateInfo.securityFlag	String	보안템플릿, 보안 템플릿 여부
data.templateInfo.buttons	List	템플릿버튼
data.templateInfo.buttons.name	String	name
data.templateInfo.buttons.linkType	String	종류
data.templateInfo.buttons.linkMo	String	모바일링크
data.templateInfo.buttons.linkPc	String	pc 링크
data.templateInfo.buttons.linkAnd	String	android 실행
data.templateInfo.buttons.linkIos	String	ios 실행
data.templateInfo.templateCode	String	템플릿코드
data.templateInfo.kkoTemplateCode	String	템플릿코드
data.templateInfo.templateStatusCode	String	템플릿 상태
data.templateInfo.imageFileName	String	템플릿 이미지 이름
data.templateInfo.itemHighlightImageFileName	String	템플릿 이미지 이름
data.templateInfo.templateKey	String	템플릿코드
data.templateInfo.relay	String	카카오채널 등록 relay ID
data.templateInfo.block	String	차단 여부
data.templateInfo.dormant	String	휴면 여부
data.templateInfo.createDate	String	생성 일자
data.templateInfo.approvalDate	String	승인 일자
data.templateInfo.comments	List	문의 내용 목록
data.templateInfo.comments.idx	String	문의 내용 번호
data.templateInfo.comments.createId	String	문의 내용 생성 ID
data.templateInfo.comments.content	String	문의 내용
data.templateInfo.comments.createDate	String	문의 내용 생성 일자
data.templateInfo.comments.status	String	문의 내용 상태
data.regDt	String	템플릿 등록일자
data.updDt	String	템플릿 수정일자

참고

메시지 유형(templateMessageType)
- BA : 기본형
- EX : 부가 정보형 (templateExtra 필드 필수)
- AD : 광고 추가형 (templateAd 필드 필수)
- MI : 부가 정보형 (templateExtra, templateAd 필드 필수)
강조표기유형(templateEmphasizeType)
- NONE : 선택안함
- TEXT: templateTitle, templateSubtitle 필드 필수
보안템플릿(securityFlag)
- OTP 등 보안 메시지 일 경우 설정 발신 당시의 메인 디바이스를 제외한 모든 디바이스에 메시지 텍스트 미노출

button

Name	Type	Required	Description
name	String	true	name
linkType	String	true	종류
linkMo	String	false	모바일링크
linkPc	String	false	pc 링크
linkAnd	String	false	android 실행
linkIos	String	false	ios 실행

buttons 타입별 속성

필수 파라미터를 모두 입력하셔야 정상적인 템플릿등록 가능

버튼 타입	속성	타입	필수	Description
WL	linkMo	text	Y	버튼 클릭 시 이동할 pc/mobile 환경별 web url
WL	linkPc	text	N
AL	linkAnd	text		linkIos, linkAnd, linkMo 중 2 가지 필수 입력mobile android 환경에서 버튼 클릭 시 실행할application custom scheme
AL	linkAnd	text		mobile android 환경에서 버튼 클릭 시 실행할application custom scheme
AL	linkMo	text		mobile 환경에서 버튼 클릭 시 이동할 url
AL	linkPc	text	N	pc 환경에서 버튼 클릭 시 이동할 url
BK				해당 버튼 텍스트 전송
MD				해당 버튼 텍스트 + 메시지 본문 전송
BC				상담톡 전환
BT				봇 전환
DS				메시지 내 송장번호 이용한 배송조회페이지로 연결
AC AC				채널추가- 광고추가형, 복합형템플릿에서만 사용가능- 버튼단톡 또는 최상단(첫번째버튼)에만 추가가능

▶ Sample

Curl

curl -X POST "https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/template/get"
-H  "accept: */*"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiYWNjZXNzVXJsIjoiYXV0aCIsImlzcyI6ImNtLmxndXBsdX..."
-H  "Content-Type: application/json"
-d '
    {
         "kkoChId": "@ntk07j20ote0mey",
         "kkoGrpId": "",
         "templateCode": "TPWoBjTRqz",
         "senderKeyType": "S"
    }'

Response

{
    "code": "10000",
    "message": "성공",
    "data": {
        "senderKey": "senderkey123456789123456789",
        "senderType": "S",
        "templateName": "환영인사",
        "templateContent": "#{이름}님 환영합니다..",
        "categoryCode": "008002",
        "templateMessageType": "BA",
        "templateExtra": "string",
        "templateAd": "string",
        "templateEmphasizeType": "NONE",
        "templateTitle": "string",
        "templateSubtitle": "string",
        "securityFlag": false,
        "buttons": [
            {
                "name": "연결하기",
                "linkType": "WL",
                "linkMo": "http://",
                "linkPc": "http://",
                "linkAnd": "http://",
                "linkIos": "http://"
            }
        ],
        "templateCode": "LMSG_2022123456789123456789",
        "templateStatusCode": "Q",
        "block": false,
        "dormant": false,
        "createId": "검수자",
        "createDate": "2021-06-30 10:45:32",
        "approvalDate": "2021-06-30 10:45:32",
        "comments": [
            {
                "idx": 86,
                "createId": "createId",
                "content": "템플릿 반려의견에 관한문의사항이 있습니다........(중략)",
                "createDate": "2019-08-06 16:03:33",
                "status": "INQ"
            }
        ],
        "templateKey": "TEST1dEIf"
    }
}

참고

템플릿상태

T : 신청완료
R : 검수요청완료 (롯데정보통신 검수중)
Q : 카카오 검수중
Y : 검수완료(운영이관전)
M : 사용요청중 (운영이관 요청중인 상태)
A : 템플릿 승인
S : 템플릿 반려

참고

결과 코드 참고

템플릿 검수 요청 #

templateStatusCode  = ‘T’(신청완료)※ 템플릿 상태가 ‘T’ / 템플릿 등록 요청 L.Message ID / 등록한 senderKey 인 경우에만 검수요청 가능합니다. 
※ 템플릿 검수 중 상태코드 전이 과정(T -> R -> Q -> S / A)

▶ Request

URL

POST /kko/v2/channel/template/request HTTP/1.1
Authorization: Bearer {token}
Content-Type: application/json
Host: mnt-api.msghub.uplus.co.kr

Header

Name	Type	Required	Description
Authorization	String	true	사용자 인증 토큰

Requeset body

Name	Type	Required	Description
kkoChId	String	true	카카오 채널ID (카카오비즈니스의 “내 채널” 목록에 있는 채널 아이디 ex) @내채널)
kkoGrpId	String	false	카카오 그룹ID
templateCode	String	true	템플릿 코드
senderKeyType	String	true	채널ID 유형 (S: 일반ID, G: 그룹ID)

▶ Response

Name	Type	Description
code	String	결과 코드
message	String	결과 코드 설명

▶ Sample

Curl

curl -X POST "https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/template/request"
-H  "accept: */*"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiYWNjZXNzVXJsIjoiYXV0aCIsImlzcyI6ImNtLmxndXBsdX..."
-H  "Content-Type: application/json"
-d '
    {
        "kkoChId": "@채널아이디",
        "kkoGrpId": "",
        "senderKeyType": "S",
        "templateCode": "string"
    }
'

Response

{
    "code": "10000",
    "message": "성공"
}

참고

결과 코드 참고

템플릿 수정 #

templateStatusCode  = ‘T’(신청완료) or ‘S’(반려) ※ 템플릿 상태가 ‘T’ or ‘S’ / 템플릿 등록 요청상태인 경우에만 수정 가능합니다. ※ 버튼 전체 수정(버튼 추가 및 삭제) 가능합니다.

▶ Request

URL

POST /kko/v2/channel/template/update HTTP/1.1
Authorization: Bearer {token}
Content-Type: application/json
Host: mnt-api.msghub.uplus.co.kr

Header

Name	Type	Required	Description
Authorization	String	true	사용자 인증 토큰

Requeset body

Name	Type	Required	Description
kkoChId	String	true	카카오 채널ID (카카오비즈니스의 “내 채널” 목록에 있는 채널 아이디 ex) @내채널)
kkoGrpId	String	false	카카오 그룹ID
senderType	String	true	채널ID 유형 (S: 일반ID, G: 그룹ID)
templateCode	String	true	템플릿 코드
templateName	String	true	템플릿명
templateContent	String	true	템플릿내용
categoryCode	String	true	카테고리코드
templateMessageType	String	true	메시지 유형
templateExtra	String	true	부가정보
templateAd	String	true	광고성메시지
templateEmphasizeType	String	true	강조표기유형(NONE: 선택안함, TEXT:강조표기형)
itemHeader	String	false	아이템리스트형 헤더정보
itemHighlightTitle	String	false	아이템하이라이트 타이틀
itemHighlightDescription	String	false	아이템하이라이트 설명
itemList	List<LMItemList>	false	아이템리스트
itemSummaryTitle	String	false	아이템 요약 정보 타이틀
itemSummarydescription	String	false	아이템 요약 정보 설명
templateTitle	String	false	강조표기핵심 정보
templateSubtitle	String	false	강조표기보조 문구
securityFlag	String	true	보안템플릿, 보안 템플릿 여부
buttons	button	true	템플릿버튼
templateTitleFixYn	String	false	템플릿 타이틀 강조형은 본문에 등록된 가변 영역 외 독립적으로 사용할 수 있는 구분값(LGCNS)

참고

메시지 유형(templateMessageType)
- BA : 기본형
- EX : 부가 정보형 (templateExtra 필드 필수)
- AD : 광고 추가형 (templateAd 필드 필수)
- MI : 부가 정보형 (templateExtra, templateAd 필드 필수)
강조표기유형(templateEmphasizeType)
- NONE : 선택안함
- TEXT: templateTitle, templateSubtitle 필드 필수
보안템플릿(securityFlag)
- OTP 등 보안 메시지 일 경우 설정 발신 당시의 메인 디바이스를 제외한 모든 디바이스에 메시지 텍스트 미노출

button

Name	Type	Required	Description
name	String	true	name
linkType	String	true	종류
linkMo	String	false	모바일링크
linkPc	String	false	pc 링크
linkAnd	String	false	android 실행
linkIos	String	false	ios 실행

buttons 타입별 속성

필수 파라미터를 모두 입력하셔야 정상적인 템플릿등록 가능

버튼 타입	속성	타입	필수	Description
WL	linkMo	text	Y	버튼 클릭 시 이동할 pc/mobile 환경별 web url
WL	linkPc	text	N
AL	linkAnd	text		linkIos, linkAnd, linkMo 중 2 가지 필수 입력mobile android 환경에서 버튼 클릭 시 실행할application custom scheme
AL	linkAnd	text		mobile android 환경에서 버튼 클릭 시 실행할application custom scheme
AL	linkMo	text		mobile 환경에서 버튼 클릭 시 이동할 url
AL	linkPc	text	N	pc 환경에서 버튼 클릭 시 이동할 url
BK				해당 버튼 텍스트 전송
MD				해당 버튼 텍스트 + 메시지 본문 전송
BC				상담톡 전환
BT				봇 전환
DS				메시지 내 송장번호 이용한 배송조회페이지로 연결
AC				채널추가- 광고추가형, 복합형템플릿에서만 사용가능- 버튼단톡 또는 최상단(첫번째버튼)에만 추가가능

▶ Response

Name	Type	Description
code	String	결과 코드
message	String	결과 코드 설명
data	Object	결과 데이터
data.senderKey	String	발신 프로필 키
data.senderType	String	발신 프로필 타입(S:카카오채널, G:그룹)
data.templateName	String	템플릿명
data.templateContent	String	템플릿내용
data.categoryCode	String	카테고리코드
data.templateMessageType	String	메시지 유형
data.templateExtra	String	부가정보
data.templateAd	String	고성메시지
data.templateEmphasizeType	String	강조표기유형(NONE: 선택안함, TEXT:강조표기형)
data.templateTitle	String	강조표기핵심 정보
data.templateSubtitle	String	강조표기보조 문구
data.securityFlag	String	보안템플릿, 보안 템플릿 여부
data.buttons	List	템플릿버튼
data.buttons.name	String	name
data.buttons.linkType	String	종류
data.buttons.linkMo	String	모바일링크
data.buttons.linkPc	String	pc 링크
data.buttons.linkAnd	String	android 실행
data.buttons.linkIos	String	ios 실행
data.buttons.varUrlYn	String	가변 url 사용 여부
data.buttons.kkoBtnOutbrowserYn	String	버튼 클릭시 url 이 열리는 브라우저 설정 버튼 링크타입이 웹링크(WL)인 경우에만 적용 N : 카카오톡에서 열림 , Y : 사용자 브라우저에서 열림 default : N
data.buttons.chat_extra	String	봇 관련 정보
data.buttons.chat_event	String	봇 관련 이벤트 정보
data.templateCode	String	템플릿코드
data.templateStatusCode	String	템플릿 상태 코드
data.createDate	String	생성 일시
data.block	String	차단 여부
data.dormant	String	휴면 여부
data.createId	String	생성 ID
data.approvalDate	String	승인 일자
data.comments	List	문의 내용 목록
data.comments.idx	String	문의 내용 번호
data.comments.createId	String	문의 내용 생성 ID
data.comments.content	String	문의 내용
data.comments.createDate	String	문의 내용 생성 일자
data.comments.status	String	문의 내용 상태
data.templateKey	String	템플릿 키

▶ Sample

Curl

curl -X POST "https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/template/update"
-H  "accept: */*"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiYWNjZXNzVXJsIjoiYXV0aCIsImlzcyI6ImNtLmxndXBsdX..."
-H  "Content-Type: application/json"
-d '
    {  
        "kkoChId": "@채널아이디",
       "kkoGrpId": "",
        "senderType": "S",
        "templateCode": "string",
        "templateName": "환영인사",
        "templateContent": "#{이름}님 환영합니다..",
        "categoryCode": "008002",
        "templateMessageType": "BA",
        "templateExtra": "string",
        "templateAd": "string",
        "templateEmphasizeType": "NONE",
        "templateTitle": "string",
        "templateSubtitle": "string",
        "securityFlag": false,
        "buttons": [
            {
                "name": "연결하기",
                "linkType": "WL",
                "linkMo": "http://",
                "linkPc": "http://",
                "linkAnd": "http://",
                "linkIos": "http://"
            }
        ]
    }'

Response

{
    "code": "10000",
    "message": "성공",
    "data": {
        "templateKey": "TEST1dEIf",
        "senderKey": "senderkey123456789123456789",
        "senderType": "S",
        "templateName": "환영인사",
        "templateContent": "#{이름}님 환영합니다..",
        "categoryCode": "008002",
        "templateMessageType": "BA",
        "templateExtra": "string",
        "templateAd": "string",
        "templateEmphasizeType": "NONE",
        "templateTitle": "string",
        "templateSubtitle": "string",
        "securityFlag": false,
        "buttons": [
            {
                "name": "연결하기",
                "linkType": "WL",
                "linkMo": "http://",
                "linkPc": "http://",
                "linkAnd": "http://",
                "linkIos": "http://"
            }
        ],
        "templateCode": "LMSG_2022123456789123456789",
        "templateStatusCode": "Q",
        "block": false,
        "dormant": false,
        "createId": "검수자",
        "createDate": "2021-06-30 10:45:32",
        "approvalDate": "2021-06-30 10:45:32",
        "comments": [
            {
                "idx": 86,
                "createId": "createId",
                "content": "템플릿 반려의견에 관한문의사항이 있습니다........(중략)",
                "createDate": "2019-08-06 16:03:33",
                "status": "INQ"
            }
        ]
    }
}

참고

결과 코드 참고

템플릿 목록 조회 #

템플릿 목록을 조회합니다.

▶ Request

URL

POST /kko/v2/channel/template/all HTTP/1.1
Authorization: Bearer {token}
Content-Type: application/json
Host: mnt-api.msghub.uplus.co.kr

Header

Name	Type	Required	Description
Authorization	String	true	사용자 인증 토큰

Requeset body

Name	Type	Required	Description
kkoChId	String	true	카카오 채널 ID (카카오비즈니스의 “내 채널” 목록에 있는 채널 아이디 ex) @내채널)
kkoGrpId	String	false	카카오 그룹 ID
senderType	String	true	채널ID 유형 (S: 일반ID, G: 그룹ID)
updateDt	String	false	최종갱신일시

▶ Response

Name	Type	Description
code	String	결과 코드
message	String	결과 코드 설명
data	List	결과 데이터 목록
data[].kkoChId	String	카카오 채널 ID
data[].templateName	String	템플릿 명
data[].templateKey	String	템플릿 키
data[].templateCode	String	템플릿 코드
data[].templateStatusCode	String	템플릿 상태 코드

참고

템플릿 상태 코드

T : 신청완료
R : 검수요청완료 (롯데정보통신 검수중)
Q : 카카오 검수중
A : 템플릿 승인
S : 템플릿 반려

▶ Sample

Curl

curl -X POST "https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/template/all"
-H  "accept: */*"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiYWNjZXNzVXJsIjoiYXV0aCIsImlzcyI6ImNtLmxndXBsdX..."
-H  "Content-Type: application/json"
-d '
    {
          "kkoChId": "@채널아이디",
          "kkoGrpId": "",
          "senderType": "S",
          "updateDt": "20230915"
    }'

Response

{
  "code": "10000",
  "message": "성공",
  "data": [
    {
      "kkoChId": "@채널아이디",
      "templateName": "테스트템플릿",
      "templateKey": "123",
      "templateCode": "123",
      "templateStatusCode": "R"
    },
    {
      "kkoChId": "@채널아이디",
      "templateName": "테스트",
      "templateKey": "123456",
      "templateCode": "123456",
      "templateStatusCode": "A"
    }
}

참고

템플릿상태

T : 신청완료
R : 검수요청완료 (롯데정보통신 검수중)
Q : 카카오 검수중
A : 템플릿 승인
S : 템플릿 반려

참고

결과 코드 참고

카카오 템플릿 운영이관요청 #

검수완료 후 운영이관요청을 하여야 발송이 가능하다.

▶ Request

URL

POST /kko/v2/channel/release HTTP/1.1
Authorization: Bearer {token}
Content-Type: application/json
Host: mnt-api.msghub.uplus.co.kr

Header

Name	Type	Required	Description
Authorization	String	true	사용자 인증 토큰

Requeset body

Name	Type	Required	Description
kkoChId	String	true	카카오 채널 ID (카카오비즈니스의 “내 채널” 목록에 있는 채널 아이디 ex) @내채널)
kkoGrpId	String	false	카카오 그룹ID
templateCodeList	List	true	템플릿코드 목록
senderKeyType	String	true	채널 ID 유형 (S: 일반ID, G: 그룹ID)
startValidDate	String	false	사용가능일자 (운영이관일자)

▶ Response

Name	Type	Description
code	String	결과 코드
message	String	결과 코드 설명

▶ Sample

Curl

curl -X POST "https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/template/release"
-H  "accept: */*"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiYWNjZXNzVXJsIjoiYXV0aCIsImlzcyI6ImNtLmxndXBsdX..."
-H  "Content-Type: application/json"
-d '
    {
        "kkoChId": "@kkoChId",
        "kkoGrpId": "",
        "templateCodeList":["String"],
        "senderKeyType":"S",
        "startValidDate":"20230918110000"
    }
'

Response

{
    "code": "10000",
    "message": "성공"
}

참고

결과 코드 참고

미사용 프로필 휴면 해제 #

미사용 프로필 휴면 해제합니다.

▶ Request

URL

POST /kko/v1/senderkey/channel/recover HTTP/1.1
Authorization: Bearer {token}
Content-Type: application/json
Host: mnt-api.msghub.uplus.co.kr

Header

Name	Type	Required	Description
Authorization	String	true	사용자 인증 토큰

Request Body

Name	Type	Required	Description
senderKey	String	true	발신 프로필 키

▶ Response

Name	Type	Description
code	String	결과 코드
message	String	결과 코드 설명

▶ Sample

Curl

curl -X POST "https://mnt-api.msghub.uplus.co.kr/kko/v1/senderkey/channel/recover"
-H  "accept: */*"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiYWNjZXNzVXJsIjoiYXV0aCIsImlzcyI6ImNtLmxndXBsdX..."
-H  "Content-Type: application/json"
-d '
    {
        "senderKey": "senderkey123456789123456789"
    }
'

Response

{
    "code": "10000",
    "message": "성공"
}

참고

결과 코드 참고

최근 변경 템플릿을 조회합니다. 
(2024년 04월 30일 이후 사용 가능)

최근 변경 템플릿 조회 #

▶ Request

URL

POST /kko/v1/senderkey/template/last_modified HTTP/1.1
Authorization: Bearer {token}
Content-Type: application/json
Host: mnt-api.msghub.uplus.co.kr

Header

Name	Type	Required	Description
Authorization	String	true	사용자 인증 토큰

Request Body

Name	Type	Required	Description
senderKey	String	true	발신 프로필 키
senderKeyType	String	true	발신 프로필 키 타입 (개별 : S / 그룹 :G)
since	String	true	2024-04-29 09:00:00
page	Integer	true	1
count	Integer	true	1000

▶ Response

Name	Type	Description
code	String	결과 코드
message	String	결과 코드 설명
data	List	결과 데이터 목록
data[].senderKey	String	발신 프로필 키
data[].templateCode	String	템플릿 코드
data[].senderKeyType	String	발신 프로필 키 타

▶ Sample

Curl

curl -X POST "https://mnt-api.msghub-qa.uplus.co.kr/kko/v1/senderkey/template/last_modified" 
-H  "accept: */*" 
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJHV19URVNUXzEiLCJhY2Nlc3NVcmwiOiJhcGkiLCJp..." 
-H  "Content-Type: application/json" 
-d "{\"senderKey\":\"da17d231bbf13f83174a36a4bb0353476ae012b3\",\"senderKeyType\":\"S\",\"since\":\"2024-03-12 15:00:00\",\"page\":1,\"count\":1000}"

Response

{
  "code": "10000",
  "message": "성공",
  "data": [
    {
      "senderKey": "da17d231bbf13f83174a36a4bb0353476ae012b3",
      "templateCode": "LMSG_20240425130703000164",
      "senderKeyType": "S"
    },
    {
      "senderKey": "da17d231bbf13f83174a36a4bb0353476ae012b3",
      "templateCode": "LMSG_20240425130813000029",
      "senderKeyType": "S"
    },
    {
      "senderKey": "da17d231bbf13f83174a36a4bb0353476ae012b3",
      "templateCode": "LMSG_20240425131138000283",
      "senderKeyType": "S"
    }
  ]
}

참고

결과 코드 참고

카카오 그룹에 포함된 채널 조회 #

롯데정보통신의 카카오 그룹에 포함된 채널을 조회합니다. 
(2024년 04월 30일 이후 사용 가능)

▶ Request

URL

GET /kko/v2/channel/group/{groupKey} HTTP/1.1
Authorization: Bearer {token}
Content-Type: application/json
Host: mnt-api.msghub.uplus.co.kr

Header

Name	Type	Required	Description
Authorization	String	true	사용자 인증 토큰

Request Body

Name	Type	Required	Description
chGrpKey	String	true	채널 그룹 키

▶ Response

Name	Type	Description
code	String	결과 코드
message	String	결과 코드 설명
data	List	결과 데이터 목록
data[].chGrpKey	String	채널 그룹 키
data[].kkoChId	String	카카오 채널 아이디
data[].regDt	String	등록 일시

▶ Sample

Curl

curl -X GET "https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/group/{groupKey}"
-H  "accept: */*" 
-H  "chGrpKey: t5es1SI" 
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJHV19URVNUXzEiLCJhY2Nl..."

Response

{
  "code": "10000",
  "message": "성공",
  "data": [
    {
      "chGrpKey": "t5es1SI",
      "kkoChId": "@msghub",
      "regDt": "2023-04-10T15:29:29"
    },
    {
      "chGrpKey": "t5es1SI",
      "kkoChId": "@msghub_csm",
      "regDt": "2024-04-26T00:00:00"
    },
    {
      "chGrpKey": "t5es1SI",
      "kkoChId": "@이커머스테크",
      "regDt": "2023-04-14T16:04:15"
    }
  ]
}

참고

결과 코드 참고

카카오 그룹에 채널 등록 #

롯데정보통신의 카카오 그룹에 채널 등록합니다.
(2024년 04월 30일 이후 사용 가능)

▶ Request

URL

POST /kko/v2/channel/group/add HTTP/1.1
Authorization: Bearer {token}
Content-Type: application/json
Host: mnt-api.msghub.uplus.co.kr

Header

Name	Type	Required	Description
Authorization	String	true	사용자 인증 토큰

Request Body

Name	Type	Required	Description
chGrpKey	String	true	채널 그룹 키
kkoChId	String	true	카카오 채널 아이

▶ Response

Name	Type	Description
code	String	결과 코드
message	String	결과 코드 설명
data	Json	결과 데이터 목록
data.chGrpKey	String	채널 그룹 키
data.kkoChId	String	카카오 채널 아이디

▶ Sample

Curl

curl -X POST "https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/group/add" 
-H  "accept: */*" 
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJHV19URVNUXzEiLCJhY2Nl..."
-H  "Content-Type: application/json" 
-d "{\"chGrpKey\":\"t5es1SI\",\"kkoChId\":\"@msghub_csm\"}"

Response

{
  "code": "10000",
  "message": "성공",
  "data": {
    "chGrpKey": "t5es1SI",
    "kkoChId": "@msghub_csm"
  }
}

참고

결과 코드 참고

카카오 그룹에 채널 삭제 #

롯데정보통신의 카카오 그룹에 채널 삭제합니다.
(2024년 04월 30일 이후 사용 가능)

▶ Request

URL

DELETE /kko/v2/channel/group/remove HTTP/1.1
Authorization: Bearer {token}
Content-Type: application/json
Host: mnt-api.msghub.uplus.co.kr

Header

Name	Type	Required	Description
Authorization	String	true	사용자 인증 토큰

Request Body

Name	Type	Required	Description
chGrpKey	String	true	채널 그룹 키
kkoChId	String	true	카카오 채널 아이디

▶ Response

Name	Type	Description
code	String	결과 코드
message	String	결과 코드 설명
data	Json	결과 데이터 목록
data.chGrpKey	String	채널 그룹 키
data.kkoChId	String	카카오 채널 아이디

▶ Sample

Curl

curl -X DELETE "https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/group/remove"
-H  "accept: */*" 
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJHV19URVNUXzEiLCJhY2Nl..."
-H  "Content-Type: application/json" -d "{\"chGrpKey\":\"t5es1SI\",\"kkoChId\":\"@msghub_csm\"}"

Response

{
  "code": "10000",
  "message": "성공",
  "data": {
    "chGrpKey": "t5es1SI",
    "kkoChId": "@msghub_csm"
  }
}

참고

결과 코드 참고

카카오 그룹 목록 조회 #

롯데정보통신의 카카오 그룹 목록을 조회합니다.
(2024년 04월 30일 이후 사용 가능)

▶ Request

URL

GET /kko/v2/channel/group/all HTTP/1.1
Authorization: Bearer {token}
Content-Type: application/json
Host: mnt-api.msghub.uplus.co.kr

Header

Name	Type	Required	Description
Authorization	String	true	사용자 인증 토큰

▶ Response

Name	Type	Description
code	String	결과 코드
message	String	결과 코드 설명
data	List	결과 데이터 목록
data[].chGrpKey	String	채널 그룹 키
data[].chGrpName	String	채널 그룹 이름
data[].chGrpStatCd	String	채널 그룹 상태 코드
data[].regDt	String	채널 그룹 등록 일시
data[].updDt	String	채널 그룹 수정 일

▶ Sample

Curl

curl -X GET "https://mnt-api.msghub-qa.uplus.co.kr/kko/v2/channel/group/all" 
-H  "accept: */*"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJHV19URVNUXzEiLCJhY2Nl..."

Response

{
  "code": "10000",
  "message": "성공",
  "data": [
   {
      "chGrpKey": "MiOxRL6",
      "chGrpName": "그룹키테스트",
      "chGrpStatCd": "A",
      "regDt": "2024-04-23T09:35:48",
      "updDt": "2024-04-23T09:36:03"
    },
    {
      "chGrpKey": "yLJ6iSK",
      "chGrpName": "0619테스트",
      "chGrpStatCd": "C",
      "regDt": "2023-06-19T16:02:51",
      "updDt": "2024-03-12T10:26:46"
    }
  ]
}

참고

결과 코드 참고

카카오 채널로 그룹 목록 조회 #

롯데정보통신에 등록된 채널로 카카오 그룹 목록을 조회합니다.

URL

POST /kko/v2/channel/group/list HTTP/1.1
Authorization: Bearer {token}
Content-Type: application/json
Host: mnt-api.msghub.uplus.co.kr

Header

Name	Type	Required	Description
Authorization	String	true	사용자 인증 토큰

▶ Request

Name	Type	Description
kkoChId	String	채널아이디

▶ Response

Name	Type	Description
code	String	결과 코드
message	String	결과 코드 설명
data	List	결과 데이터 목록
data[].chGrpKey	String	채널 그룹 키
data[].chGrpName	String	채널 그룹 이름
data[].regDt	String	채널 그룹 등록 일시

▶ Sample

Curl

curl -X POST "https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/group/list" 
-H  "accept: */*" 
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJB..." 
-H  "Content-Type: application/json" 
-d "{\"kkoChId\":\"@이커머스테크\"}"

Request

{
“kkoChId”: “@이커머스테크”
}

Response

{
  "code": "10000",
  "message": "성공",
  "data": [
    {
      "chGrpKey": "HnRMvjr",
      "chGrpName": "그룹명",
      "regDt": "2024-01-29T13:38:22"
    },
    {
      "chGrpKey": "BhKIChP",
      "chGrpName": "그룹명",
      "regDt": "2023-02-23T20:32:10"
    }
  ]
}

참고

결과 코드 참고

카카오 미사용 채널 휴면 해제(롯데) #

장기 미사용으로 휴면 처리된 채널의 휴면 상태를 해제합니다.

URL

POST /kko/v2/channel/recover HTTP/1.1
Authorization: Bearer {token}
Content-Type: application/json
Host: mnt-api.msghub.uplus.co.kr

Header

Name	Type	Required	Description
Authorization	String	true	사용자 인증 토큰

▶ Request

Name	Type	Description
kkoChId	String	채널아이디

▶ Response

Name	Type	Description
code	String	결과 코드
message	String	결과 코드 설명
data	Object	결과 데이터 목록

▶ Sample

Curl

curl -X POST "https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/recover" 
-H  "accept: */*" 
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJB..." 
-H  "Content-Type: application/json" 
-d "{\"kkoChId\":\"@이커머스테크\"}"

Request

{
“kkoChId”: “@이커머스테크”
}

Response

{
  "code": "10000",
  "message": "성공",
  "data": null
}

결과 코드 참고

고객사 카카오 채널 기간별 조회 API #

고객사 카카오톡 채널을 기간별 조회한다.

URL POST /kko/v2/kkoChannelList
HTTP/1.1 Authorization: Bearer {token} Content-Type: application/json Host: mnt-api.msghub.uplus.co.kr

Header

Name	Type	Required	Description
Authorization	String	true	사용자 인증 토큰

▶ RequestBody

Name	Type	Description
standardDateTime	String	조회날짜 (ex: 20240926203000 ) 없을 경우 전체 날짜 조회
page	Integer	페지이 번호 (ex : 1 ) 없을 경우 기본값 1
pageSize	Integer	페이지 노출 개수 (ex: 10) 없을 경우 기본값 1000

▶ Response

Name	Type	Description
code	String	결과 코드
message	String	결과 코드 설명
data[]	List	결과 데이터 목록
data[].kkoChId	String	카카오 채널 아이디
data[].kkoChStat	String	카카오 채널 상태
data[].createDate	String	카카오 채널 등록 일시
data[].categoryCode	String	카카오 채널 카테고리 코드

▶ Sample

Curl

curl -X POST "https://mnt-api.msghub-qa.uplus.co.kr/kko/v2/kkoChannelList" 
-H  "accept: */*" 
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJHV19URVN..." 
-H  "Content-Type: application/json" 
-d "{\"standardDateTime\":\"20230912000000\",\"page\":1,\"pageSize\":1}"

Request

{
“standardDateTime”: “20230912000000”,
“page”: 1,
“pageSize”: 2
}

Response

{
  "code": "10000",
  "message": "성공",
  "data": [
    {
      "kkoChId": "@dalbodre6321",
      "kkoChStat": "A",
      "createDate": "2024-05-16 18:13:05",
      "categoryCode": "01100010001"
    },
    {
      "kkoChId": "@hapjeong",
      "kkoChStat": "A",
      "createDate": "2024-05-16 18:13:05",
      "categoryCode": "01100010001"
    }
  ]
}

결과 코드 참고

Updated on 2024년 10월 10일

Quick Guide

서비스 개요

계정 안내

관리자 콘솔

사용자 콘솔

API 가이드

Push 앱개발 가이드

Agent 가이드

서비스 정보