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

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

▶ 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": [
      "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": 888999,
           "phoneNumber": "01099999999"
         }
       ],
       "categoryCode": "01800040001",
       "kkoChId": "@채널아이디",
       "memo": "string"
     }
'

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	템플릿버튼
templatePreviewMessage	String	false	템플릿 미리보기 메시지

참고

• 메시지 유형(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.templatePreviewMessage	String	템플릿 미리보기 메시지
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 실행

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 '
    {
        "kkoChId": "@메시지허브",
        "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={
 "kkoChId": "@메시지허브",
  "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"
    }
  ]
}" 
-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"
        }
      ],
      "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.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.templatePreviewMessage	String	템플릿 미리보기 메시지
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": {
    "templateKey": "ABcD82uK8x",
    "templateCode": "ABcD82uK8x",
    "templateName": "고고모바일 통신사 요금제 개통알림",
    "kkoChId": "@gogomobile",
    "templateInfo": {
      "senderType": "S",
      "templateCode": "TPdQ82uK8x",
      "templateName": "고고모바일 통신사 요금제 개통알림",
      "templateContent": "[알뜰폰 개통완료 안내] ",
      "categoryCode": "002001",
      "templateMessageType": "BA",
      "templateEmphasizeType": "NONE",
      "templateTitle": "",
      "templateSubtitle": "",
      "securityFlag": false,
      "buttons": [
        {
          "name": "1:1게시판 문의하기",
          "linkType": "WL",
          "linkMo": "https://gogomobile.co.kr/#{BTNURL1}",
          "linkPc": "https://gogomobile.co.kr/#{BTNURL1}",
          "ordering": 0,
          "varUrlYn": "N"
        }
      ],
      "kkoTemplateCode": null,
      "templateStatusCode": "A",
      "block": false,
      "dormant": false,
      "createId": null,
      "createDate": null,
      "approvalDate": null,
      "comments": null,
      "templateKey": "TPdQ82uK8x",
      "relay": null,
      "imageFileName": null,
      "itemHighlightImageFileName": null,
      "templateTitleFixYn": null,
      "item": {},
      "regId": null
    },
    "regDt": "2024-04-02T17:46:39",
    "updDt": "2024-04-29T07:55:03"
  }
}

참고

템플릿상태

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	템플릿버튼
templatePreviewMessage	String	false	템플릿 미리보기 메시지
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.templatePreviewMessage	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/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
kkoChId	String	true	채널ID (카카오비즈니스의 “내 채널” 목록에 있는 채널ID ex) @내채널)
senderType	String	true	채널 타입(S: 카카오채널, G: 그룹)
since	String	true	최종갱신일시(‘YYYY-MM-DD HH24:MI:SS’)
page	Integer	true	1
count	Integer	true	1000

▶ Response

Name	Type	Description
code	String	결과 코드
message	String	결과 코드 설명
data	List	결과 데이터 목록
data[].kkoChId	String	채널아이디
data[].templateCode	String	템플릿 코드
data[].senderType	String	채널 타입(S: 카카오채널, G: 그룹)

▶ Sample

Curl

curl -X POST "https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/template/last_modified" -H  "accept: */*" -H  "Authorization: Bearer eyJ....1Mzd....81h0" -H  "Content-Type: application/json" -d "{\"kkoChId\":\"@메시지허브\",\"senderType\":\"S\",\"since\":\"2025-04-19 18:00:00\",\"page\":1,\"count\":4}"

Response

{
  "code": "10000",
  "message": "성공",
  "data": [
    {
      "kkoChId": "@메시지허브",
      "templateCode": "SAMPLE001",
      "senderType": "S"
    },
    {
      "kkoChId": "@메시지허브",
      "templateCode": "SAMPLE002",
      "senderType": "S"
    },
    {
      "kkoChId": "@메시지허브",
      "templateCode": "SAMPLE003",
      "senderType": "S"
    },
    {
      "kkoChId": "@메시지허브",
      "templateCode": "SAMPLE004",
      "senderType": "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"
    }
  ]
}

결과 코드 참고

브랜드 광고성 정보 수신동의 증적 자료 파일 업로드 #

채널의 브랜드 광고성 정보 수신동의 증적 자료 파일 업로드합니다.

URL POST /kko/v2/channel/brand/marketingAgree/upload
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	사용자 인증 토큰

▶ Query Parameters

Name	Type	Required	Description
kkoChId	String	true	카카오 채널 ID

▶ RequestBody

Name	Type	Description
filePart	File[]	수신동의 증적 파일

▶ Response

Name	Type	Description
code	String	결과코드
message	String	결과코드설명
data	Object	결과 데이터
meta	Object	메타 정보

▶ Sample

Curl

curl -X POST "https://mnt-api.msghub-qa.uplus.co.kr/kko/v2/channel/brand/marketingAgree/upload?kkoChId=test_channel" 
-H  "accept: */*" 
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJHV19URVN..." 
-H  "Content-Type: multipart/form-data" 
-F  "filePart=@marketing_consent.pdf"

Request

Query: ?kkoChId=test_channel
Body: multipart/form-data
– filePart: marketing_consent.pdf

Response

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

결과 코드 참고

브랜드메시지 카카오 채널 타켓팅 M,N 사용신청 #

채널의 브랜드메시지 타겟팅 M,N 사용을 신청합니다.

URL POST /kko/v2/channel/brand/use
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
bizppurioStatus	String	BIZPPURIO 상태

▶ Response

Name	Type	Description
code	String	결과코드
message	String	결과코드설명
data	Object	결과 데이터
meta	Object	메타 정보

▶ Sample

Curl

curl -X POST "https://mnt-api.msghub-qa.uplus.co.kr/kko/v2/channel/brand/use" 
-H  "accept: */*" 
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJHV19URVN..." 
-H  "Content-Type: application/json" 
-d "{\"bizppurioStatus\":\"ACTIVE\"}"

Request

{
  "bizppurioStatus": "ACTIVE"
}

Response

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

결과 코드 참고

브랜드 템플릿 채널 무료수신거부정보 수정 #

※ 브랜드 메시지 발송시 사용되는 080무료수신거부 정보를 수정합니다.
※ 무료수신거부 정보는 톡 채널 단위로 저장되므로 변경시 동일 톡 채널 딜러사의 발신프로필에 일괄 적용됩니다.

URL POST /kko/v2/channel/brand/template/unsubscribeContent/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	사용자 인증 토큰

▶ RequestBody

Name	Type	Description
kkoChId	String	카카오 채널 ID
kkoGrpId	String	카카오그룹 ID
unsubscribeContent	String	무료수신거부 내용

▶ Response

Name	Type	Description
code	String	결과코드
message	String	결과코드설명
data	Object	결과 데이터
meta	Object	메타 정보

▶ Sample

Curl

curl -X POST "https://mnt-api.msghub-qa.uplus.co.kr/kko/v2/channel/brand/template/unsubscribeContent/update" 
-H  "accept: */*" 
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJHV19URVN..." 
-H  "Content-Type: application/json" 
-d "{\"kkoChId\":\"@메시지허브\",\"unsubscribeContent\":\"무료수신거부 080-000-0000\"}"

Request

{
  "kkoChId": "@메시지허브",
  "unsubscribeContent": "무료수신거부 080-000-0000"
}

Response

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

결과 코드 참고

브랜드 템플릿 등록 #

브랜드 템플릿 등록한다.

URL POST /kko/v2/channel/brand/template/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	사용자 인증 토큰

▶ RequestBody

Name	Type	Description
kkoChId	String	카카오 채널 ID
kkoGrpId	String	카카오그룹 ID
senderKeyType	String	샌더키 타입
tmpltCode	String	템플릿코드 (미입력시 자동 생성)
name	String	템플릿 이름 (필수)
chatBubbleType	String	메시지 타입 (TEXT, IMAGE, WIDE, WIDE_ITEM_LIST, CAROUSEL_FEED, PREMIUM_VIDEO, COMMERCE, CAROUSEL_COMMERCE)
adult	Boolean	성인용 메시지 여부. true: 성인용 메시지, false: 모든 연령 메시지 (기본값)
header	String	템플릿 헤더 – WIDE_ITEM_LIST: 최소 1자, 최대 20자 (줄 바꿈: 불가), PREMIUM_VIDEO: 최대 20자 (줄 바꿈: 불가)
content	String	템플릿 내용 – TEXT: 최대 1,300자 (줄 바꿈: 최대 99개), IMAGE: 최대 400자 (줄 바꿈: 최대 29개)
additionalContent	String	템플릿 부가 정보 – 공백 포함 최대 34자 (줄 바꿈: 최대 1개)
securityFlag	Boolean	보안 템플릿 여부
categoryCode	String	카테고리 코드
buttons	Array	버튼 목록
quickReplies	Array	바로 연결 목록
supplement	Object	템플릿 부가 정보
image	Object	이미지 정보
imageLink	Object	이미지 링크
itemList	Object	아이템 리스트
video	Object	비디오 정보

▶ Response

Name	Type	Description
code	String	결과코드
message	String	결과코드설명
data	Object	결과 데이터
meta	Object	메타 정보

▶ Sample

Curl

curl -X POST "https://mnt-api.msghub-qa.uplus.co.kr/kko/v2/channel/brand/template/create" 
-H  "accept: */*" 
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJHV19URVN..." 
-H  "Content-Type: application/json" 
-d "{\"kkoChId\":\"@메시지허브\",\"name\":\"테스트템플릿\",\"chatBubbleType\":\"TEXT\",\"content\":\"테스트 내용입니다.\"}"

Request

{
  "kkoChId": "@메시지허브",
  "kkoGrpId": "123456",
  "senderKeyType": "S",
  "tmpltCode": "msghub",
  "name": "템플릿 이름",
  "chatBubbleType": "TEXT",
  "adult": false,
  "header": "템플릿 헤더",
  "content": "템플릿 내용입니다.",
  "additionalContent": "템플릿 부가 정보",
  "imageUrl": "https://example.com/image.jpg",
  "imageLink": "string",
  "buttons": [
    {
      "name": "string",
      "linkType": "string",
      "linkMobile": "string",
      "linkPc": "string",
      "linkAndroid": "string",
      "linkIos": "string"
    }
  ],
  "carousel": {
    "head": {
      "header": "string",
      "content": "string",
      "imageUrl": "string",
      "linkMobile": "string",
      "linkPc": "string",
      "linkIos": "string",
      "linkAndroid": "string"
    },
    "list": [
      {
        "header": "string",
        "content": "string",
        "additionalContent": "string",
        "imageUrl": "string",
        "imageLink": "string",
        "commerce": {
          "title": "string",
          "regularPrice": 0,
          "discountPrice": 0,
          "discountRate": 0,
          "discountFixed": 0
        },
        "buttons": [
          {
            "name": "string",
            "linkType": "string",
            "linkMobile": "string",
            "linkPc": "string",
            "linkAndroid": "string",
            "linkIos": "string"
          }
        ],
        "coupon": {
          "title": "string",
          "description": "string",
          "linkMobile": "string",
          "linkPc": "string",
          "linkAndroid": "string",
          "linkIos": "string"
        }
      }
    ],
    "tail": {
      "linkMobile": "string",
      "linkPc": "string",
      "linkIos": "string",
      "linkAndroid": "string"
    }
  },
  "mainWideItem": {
    "title": "string",
    "imageUrl": "string",
    "linkMobile": "string",
    "linkPc": "string",
    "linkAndroid": "string",
    "linkIos": "string"
  },
  "subWideItemList": [
    {
      "title": "string",
      "imageUrl": "string",
      "linkMobile": "string",
      "linkPc": "string",
      "linkAndroid": "string",
      "linkIos": "string"
    }
  ],
  "video": {
    "videoUrl": "https://tv.kakao.com/channel/4105399/cliplink/443851665",
    "thumbnailUrl": "https://mud-kage.kakao.com/dn/tlGjF/btsAp1PLh4f/C73wPaesrA0i3HDtnhD2yk/img_l.jpg"
  },
  "commerce": {
    "title": "string",
    "regularPrice": 0,
    "discountPrice": 0,
    "discountRate": 0,
    "discountFixed": 0
  },
  "coupon": {
    "title": "string",
    "description": "string",
    "linkMobile": "string",
    "linkPc": "string",
    "linkAndroid": "string",
    "linkIos": "string"
  }
}

Response

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

결과 코드 참고

브랜드 템플릿 수정 #

브랜드 메시지 템플릿을 수정합니다.

URL POST /kko/v2/channel/brand/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	사용자 인증 토큰

▶ RequestBody

Name	Type	Description
kkoChId	String	카카오 채널 ID
kkoGrpId	String	카카오그룹 ID
senderKeyType	String	샌더키 타입
tmpltCode	String	템플릿코드
name	String	템플릿 이름 (필수)
chatBubbleType	String	메시지 타입
adult	Boolean	성인용 메시지 여부
header	String	템플릿 헤더
content	String	템플릿 내용
additionalContent	String	템플릿 부가 정보
securityFlag	Boolean	보안 템플릿 여부
categoryCode	String	카테고리 코드
buttons	Array	버튼 목록
quickReplies	Array	바로 연결 목록
supplement	Object	템플릿 부가 정보
image	Object	이미지 정보
imageLink	Object	이미지 링크
itemList	Object	아이템 리스트
video	Object	비디오 정보

▶ Response

Name	Type	Description
code	String	결과코드
message	String	결과코드설명
data	Object	결과 데이터
meta	Object	메타 정보

▶ Sample

Curl

curl -X POST "https://mnt-api.msghub-qa.uplus.co.kr/kko/v2/channel/brand/template/update" 
-H  "accept: */*" 
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJHV19URVN..." 
-H  "Content-Type: application/json" 
-d "{\"kkoChId\":\"@메시지허브\",\"tmpltCode\":\"TEST001\",\"name\":\"수정된템플릿\",\"chatBubbleType\":\"TEXT\",\"content\":\"수정된 내용입니다.\"}"

Request

{
  "kkoChId": "@메시지허브",
  "kkoGrpId": "123456",
  "senderKeyType": "S",
  "tmpltCode": "TEST",
  "name": "템플릿 이름",
  "chatBubbleType": "TEXT",
  "adult": false,
  "header": "템플릿 헤더",
  "content": "템플릿 내용입니다.",
  "additionalContent": "템플릿 부가 정보",
  "imageUrl": "https://example.com/image.jpg",
  "imageLink": "string",
  "buttons": [
    {
      "name": "string",
      "linkType": "string",
      "linkMobile": "string",
      "linkPc": "string",
      "linkAndroid": "string",
      "linkIos": "string"
    }
  ],
  "carousel": {
    "head": {
      "header": "string",
      "content": "string",
      "imageUrl": "string",
      "linkMobile": "string",
      "linkPc": "string",
      "linkIos": "string",
      "linkAndroid": "string"
    },
    "list": [
      {
        "header": "string",
        "content": "string",
        "additionalContent": "string",
        "imageUrl": "string",
        "imageLink": "string",
        "commerce": {
          "title": "string",
          "regularPrice": 0,
          "discountPrice": 0,
          "discountRate": 0,
          "discountFixed": 0
        },
        "buttons": [
          {
            "name": "string",
            "linkType": "string",
            "linkMobile": "string",
            "linkPc": "string",
            "linkAndroid": "string",
            "linkIos": "string"
          }
        ],
        "coupon": {
          "title": "string",
          "description": "string",
          "linkMobile": "string",
          "linkPc": "string",
          "linkAndroid": "string",
          "linkIos": "string"
        }
      }
    ],
    "tail": {
      "linkMobile": "string",
      "linkPc": "string",
      "linkIos": "string",
      "linkAndroid": "string"
    }
  },
  "mainWideItem": {
    "title": "string",
    "imageUrl": "string",
    "linkMobile": "string",
    "linkPc": "string",
    "linkAndroid": "string",
    "linkIos": "string"
  },
  "subWideItemList": [
    {
      "title": "string",
      "imageUrl": "string",
      "linkMobile": "string",
      "linkPc": "string",
      "linkAndroid": "string",
      "linkIos": "string"
    }
  ],
  "video": {
    "videoUrl": "https://tv.kakao.com/channel/4105399/cliplink/443851665",
    "thumbnailUrl": "https://mud-kage.kakao.com/dn/tlGjF/btsAp1PLh4f/C73wPaesrA0i3HDtnhD2yk/img_l.jpg"
  },
  "commerce": {
    "title": "string",
    "regularPrice": 0,
    "discountPrice": 0,
    "discountRate": 0,
    "discountFixed": 0
  },
  "coupon": {
    "title": "string",
    "description": "string",
    "linkMobile": "string",
    "linkPc": "string",
    "linkAndroid": "string",
    "linkIos": "string"
  }
}

Response

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

결과 코드 참고

브랜드 템플릿 삭제 #

브랜드 메시지 템플릿을 삭제합니다.

URL POST /kko/v2/channel/brand/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	사용자 인증 토큰

▶ RequestBody

Name	Type	Description
kkoChId	String	카카오 채널 ID
kkoGrpId	String	카카오그룹 ID
tmpltCode	String	템플릿코드
senderKeyType	String	샌더키 타입

▶ Response

Name	Type	Description
code	String	결과코드
message	String	결과코드설명
data	Object	결과 데이터
meta	Object	메타 정보

▶ Sample

Curl

curl -X POST "https://mnt-api.msghub-qa.uplus.co.kr/kko/v2/channel/brand/template/delete" 
-H  "accept: */*" 
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJHV19URVN..." 
-H  "Content-Type: application/json" 
-d "{\"kkoChId\":\"@메시지허브\",\"tmpltCode\":\"TEST001\"}"

Request

{
  "kkoChId": "@메시지허브",
  "tmpltCode": "TEST001"
}

Response

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

결과 코드 참고

브랜드 템플릿 상세 조회 #

브랜드 메시지 템플릿을 조회합니다.

URL POST /kko/v2/channel/brand/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	사용자 인증 토큰

▶ Query Parameters

Name	Type	Description
kkoChId	String	카카오 채널 ID
tmpltCode	String	템플릿코드

▶ Response

Name	Type	Description
code	String	결과코드
message	String	결과코드설명
data	Object	결과 데이터
meta	Object	메타 정보

▶ Sample

Curl

curl -X POST "https://mnt-api.msghub-qa.uplus.co.kr/kko/v2/channel/brand/template/get" 
-H  "accept: */*" 
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJHV19URVN..." 
-H  "Content-Type: application/json"
-d "{\"kkoChId\":\"@메시지허브\",\"kkoGrpId\":\"123456\",\"tmpltCode\":\"msghub\"}"

Request

{
 "kkoChId": "@메시지허브",
 "kkoGrpId": "123456",
 "tmpltCode": "msghub"
}

Response

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

결과 코드 참고

카카오 채널별 브랜드 템플릿 전체 조회 #

카카오 채널별 브랜드 템플릿 전체 조회 (페이징 처리)
– kkoChId로 해당 채널의 브랜드 템플릿 목록을 조회합니다.
– 템플릿 코드, 이름, 상태를 리스트로 반환합니다.

URL GET /kko/v2/channel/brand/template/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	사용자 인증 토큰

▶ Query Parameters

Name	Type	Description
kkoChId	String	카카오 채널 ID
page	Integer	페이지 번호 (기본값: 0)
size	Integer	페이지 크기 (기본값: 20)
sort	String	정렬 기준

▶ Response

Name	Type	Description
code	String	결과코드
message	String	결과코드설명
data	Object	결과 데이터
meta	Object	메타 정보

▶ Sample

Curl

curl -X GET "https://mnt-api.msghub-qa.uplus.co.kr/kko/v2/channel/brand/template/list?kkoChId=test&page=0&size=20" 
-H  "accept: */*" 
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJHV19URVN..."

Request

GET /kko/v2/channel/brand/template/list?kkoChId=test&page=0&size=20

Response

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

결과 코드 참고

카카오 브랜드톡 발송 API (자유형) #

카카오 브랜드톡(자유형)을 발송한다.

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

Header

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

▶ RequestBody

Name	Type	Description
targeting	String	마수동 타입 : M(마케팅), N(일반), I(정보) (필수)
kkoChId	String	카카오 채널 ID
kkoGrpId	String	카카오그룹 ID
senderKeyType	String	샌더키 타입
tmpltCode	String	템플릿코드
chatBubbleType	String	메시지 타입 (필수: TEXT, IMAGE, WIDE, WIDE_ITEM_LIST 등)
adult	Boolean	성인용 메시지 여부
header	String	템플릿 헤더
content	String	템플릿 내용
additionalContent	String	템플릿 부가 정보 (최대 34자)
imageUrl	String	이미지 URL
imageLink	String	이미지 링크 URL
buttons	Array	버튼 목록 (최대 5개)
callback	String	발신번호 (필수, ex: 0243113369)
adFlag	String	광고 표기 여부 (필수, Y 또는 N)
clickUrlYn	String	단축URL 사용여부 (필수)
filterYn	String	필터링 여부 (필수, Y 또는 N)
filterGrpLst	Array	필터그룹 (필수)
recvInfoLst	Array	수신자 정보 목록 (필수, 최대 10개)
resvYn	String	예약발송 여부
resvReqDt	String	예약발송 시간
resendYn	String	재발송 여부
fbInfoLst	Array	Fallback 정보 목록

▶ Response

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

▶ Sample

Curl

curl -X POST "https://api-kko.msghub-qa.uplus.co.kr/kko/brandtalk/custom/v1" 
-H  "accept: */*" 
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJHV19URVN..." 
-H  "Content-Type: application/json" 
-d "{\"targeting\":\"I\",\"kkoChId\":\"test\",\"chatBubbleType\":\"TEXT\",\"content\":\"자유형 브랜드톡 메시지입니다.\",\"callback\":\"0243113369\",\"adFlag\":\"N\",\"clickUrlYn\":\"N\",\"filterYn\":\"N\",\"filterGrpLst\":[],\"recvInfoLst\":[{\"cliKey\":\"1\",\"phone\":\"01012341234\"}]}"

Request

{
  "clickUrlYn": "N",
  "filterYn": "N",
  "filterGrpLst": [
    "string"
  ],
  "resvYn": "N",
  "resvReqDt": "2023-01-13 13:15",
  "resendYn": "N",
  "resendTimeout": 0,
  "agency": {
    "kisaOrigCode": "123453678",
    "rcsAgencyId": "corpName",
    "rcsAgencyKey": "X324Ddsa34"
  },
  "callback": "0243113369",
  "deptCode": "string",
  "pushAlarm": "N",
  "adFlag": "N",
  "recvInfoLst": [
    {
      "cliKey": "1",
      "phone": "01012341234",
      "countryCd": "82",
      "cuid": "string",
      "mergeData": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "barcodeFilePath": "string",
      "userCustomFields": {
        "key1": "value1",
        "key2": 123
      }
    }
  ],
  "fbInfoLst": [
    {
      "ch": "SMS",
      "title": "제목",
      "msg": "SMS 메시지 내용",
      "fileId": "mms0812",
      "fileIdLst": [
        "mms0812",
        "mms0813",
        "mms0814"
      ]
    }
  ],
  "targeting": "I",
  "kkoChId": "@메시지허브",
  "kkoGrpId": "123456",
  "senderKeyType": "S",
  "tmpltCode": "msghub",
  "chatBubbleType": "TEXT",
  "adult": false,
  "header": "템플릿 헤더",
  "content": "템플릿 내용입니다.",
  "additionalContent": "템플릿 부가 정보",
  "imageUrl": "https://example.com/image.jpg",
  "imageLink": "string",
  "buttons": [
    {
      "name": "string",
      "linkType": "string",
      "linkMobile": "string",
      "linkPc": "string",
      "linkAndroid": "string",
      "linkIos": "string"
    }
  ],
  "carousel": {
    "head": {
      "header": "string",
      "content": "string",
      "imageUrl": "string",
      "linkMobile": "string",
      "linkPc": "string",
      "linkIos": "string",
      "linkAndroid": "string"
    },
    "list": [
      {
        "header": "string",
        "content": "string",
        "additionalContent": "string",
        "imageUrl": "string",
        "imageLink": "string",
        "commerce": {
          "title": "string",
          "regularPrice": 0,
          "discountPrice": 0,
          "discountRate": 0,
          "discountFixed": 0,
          "regularPriceName": "#{정상가격}",
          "discountPriceName": "#{할인가격}",
          "discountRateName": "#{할인율}",
          "discountFixedName": "#{정액할인가격}"
        },
        "buttons": [
          {
            "name": "string",
            "linkType": "string",
            "linkMobile": "string",
            "linkPc": "string",
            "linkAndroid": "string",
            "linkIos": "string"
          }
        ],
        "coupon": {
          "title": "string",
          "description": "string",
          "linkMobile": "string",
          "linkPc": "string",
          "linkAndroid": "string",
          "linkIos": "string"
        }
      }
    ],
    "tail": {
      "linkMobile": "string",
      "linkPc": "string",
      "linkIos": "string",
      "linkAndroid": "string"
    }
  },
  "wideItemList": [
    {
      "title": "string",
      "imageUrl": "string",
      "linkMobile": "string",
      "linkPc": "string",
      "linkAndroid": "string",
      "linkIos": "string"
    }
  ],
  "video": {
    "videoUrl": "https://tv.kakao.com/channel/4105399/cliplink/443851665",
    "thumbnailUrl": "https://mud-kage.kakao.com/dn/tlGjF/btsAp1PLh4f/C73wPaesrA0i3HDtnhD2yk/img_l.jpg"
  },
  "commerce": {
    "title": "string",
    "regularPrice": 0,
    "discountPrice": 0,
    "discountRate": 0,
    "discountFixed": 0,
    "regularPriceName": "#{정상가격}",
    "discountPriceName": "#{할인가격}",
    "discountRateName": "#{할인율}",
    "discountFixedName": "#{정액할인가격}"
  },
  "coupon": {
    "title": "string",
    "description": "string",
    "linkMobile": "string",
    "linkPc": "string",
    "linkAndroid": "string",
    "linkIos": "string"
  },
  "console": true,
  "barcode": true
}

Response

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

결과 코드 참고

카카오 브랜드톡 발송 API (템플릿) #

카카오 브랜드톡(템플릿)을 발송한다.

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

Header

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

▶ RequestBody

Name	Type	Description
targeting	String	마수동 타입 : M(마케팅), N(일반), I(정보) (필수)
kkoChId	String	카카오 채널 ID
kkoGrpId	String	카카오그룹 ID
tmpltCode	String	템플릿코드
chatBubbleType	String	메시지 타입 (필수)
callback	String	발신번호 (필수, ex: 0243113369)
adFlag	String	광고 표기 여부 (필수, Y 또는 N)
clickUrlYn	String	단축URL 사용여부 (필수)
filterYn	String	필터링 여부 (필수, Y 또는 N)
filterGrpLst	Array	필터그룹 (필수)
recvInfoLst	Array	수신자 정보 목록 (필수, 최대 10개)
resvYn	String	예약발송 여부 (ex: N)
resvReqDt	String	예약발송 시간 (ex: 2023-01-13 13:15)
resendYn	String	재발송 여부
resendTimeout	Integer	재발송 시간
deptCode	String	부서 코드
pushAlarm	String	메시지 푸시 알람 발송 여부 (Y: 발송, N: 안함)
fbInfoLst	Array	Fallback 정보 목록
agency	Object	대행사 정보

▶ Response

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

▶ Sample

Curl

curl -X POST "https://api-kko.msghub-qa.uplus.co.kr/kko/brandtalk/tmplt/v1" 
-H  "accept: */*" 
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJHV19URVN..." 
-H  "Content-Type: application/json" 
-d "{\"targeting\":\"I\",\"kkoChId\":\"test\",\"tmpltCode\":\"TEST001\",\"chatBubbleType\":\"TEXT\",\"callback\":\"0243113369\",\"adFlag\":\"N\",\"clickUrlYn\":\"N\",\"filterYn\":\"N\",\"filterGrpLst\":[],\"recvInfoLst\":[{\"cliKey\":\"1\",\"phone\":\"01012341234\"}]}"

Request

{
  "clickUrlYn": "N",
  "filterYn": "N",
  "filterGrpLst": [
    "string"
  ],
  "resvYn": "N",
  "resvReqDt": "2023-01-13 13:15",
  "resendYn": "N",
  "resendTimeout": 0,
  "agency": {
    "kisaOrigCode": "123453678",
    "rcsAgencyId": "corpName",
    "rcsAgencyKey": "X324Ddsa34"
  },
  "callback": "0243113369",
  "deptCode": "string",
  "pushAlarm": "N",
  "adFlag": "N",
  "recvInfoLst": [
    {
      "cliKey": "1",
      "phone": "01012341234",
      "countryCd": "82",
      "cuid": "string",
      "mergeData": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "barcodeFilePath": "string",
      "userCustomFields": {
        "key1": "value1",
        "key2": 123
      }
    }
  ],
  "fbInfoLst": [
    {
      "ch": "SMS",
      "title": "제목",
      "msg": "SMS 메시지 내용",
      "fileId": "mms0812",
      "fileIdLst": [
        "mms0812",
        "mms0813",
        "mms0814"
      ]
    }
  ],
  "targeting": "I",
  "kkoChId": "@메시지허브",
  "kkoGrpId": "123456",
  "senderKeyType": "S",
  "tmpltCode": "msghub",
  "chatBubbleType": "TEXT",
  "adult": false,
  "header": "템플릿 헤더",
  "content": "템플릿 내용입니다.",
  "additionalContent": "템플릿 부가 정보",
  "imageUrl": "https://example.com/image.jpg",
  "imageLink": "string",
  "buttons": [
    {
      "name": "string",
      "linkType": "string",
      "linkMobile": "string",
      "linkPc": "string",
      "linkAndroid": "string",
      "linkIos": "string"
    }
  ],
  "carousel": {
    "head": {
      "header": "string",
      "content": "string",
      "imageUrl": "string",
      "linkMobile": "string",
      "linkPc": "string",
      "linkIos": "string",
      "linkAndroid": "string"
    },
    "list": [
      {
        "header": "string",
        "content": "string",
        "additionalContent": "string",
        "imageUrl": "string",
        "imageLink": "string",
        "commerce": {
          "title": "string",
          "regularPrice": 0,
          "discountPrice": 0,
          "discountRate": 0,
          "discountFixed": 0,
          "regularPriceName": "#{정상가격}",
          "discountPriceName": "#{할인가격}",
          "discountRateName": "#{할인율}",
          "discountFixedName": "#{정액할인가격}"
        },
        "buttons": [
          {
            "name": "string",
            "linkType": "string",
            "linkMobile": "string",
            "linkPc": "string",
            "linkAndroid": "string",
            "linkIos": "string"
          }
        ],
        "coupon": {
          "title": "string",
          "description": "string",
          "linkMobile": "string",
          "linkPc": "string",
          "linkAndroid": "string",
          "linkIos": "string"
        }
      }
    ],
    "tail": {
      "linkMobile": "string",
      "linkPc": "string",
      "linkIos": "string",
      "linkAndroid": "string"
    }
  },
  "wideItemList": [
    {
      "title": "string",
      "imageUrl": "string",
      "linkMobile": "string",
      "linkPc": "string",
      "linkAndroid": "string",
      "linkIos": "string"
    }
  ],
  "video": {
    "videoUrl": "https://tv.kakao.com/channel/4105399/cliplink/443851665",
    "thumbnailUrl": "https://mud-kage.kakao.com/dn/tlGjF/btsAp1PLh4f/C73wPaesrA0i3HDtnhD2yk/img_l.jpg"
  },
  "commerce": {
    "title": "string",
    "regularPrice": 0,
    "discountPrice": 0,
    "discountRate": 0,
    "discountFixed": 0,
    "regularPriceName": "#{정상가격}",
    "discountPriceName": "#{할인가격}",
    "discountRateName": "#{할인율}",
    "discountFixedName": "#{정액할인가격}"
  },
  "coupon": {
    "title": "string",
    "description": "string",
    "linkMobile": "string",
    "linkPc": "string",
    "linkAndroid": "string",
    "linkIos": "string"
  },
  "console": true,
  "barcode": true
}

Response

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

결과 코드 참고