3.3 카카오 V2
- 1. 템플릿 카테고리 코드 조회
- 2. 카카오 카테고리 정보 리스트
- 3. 카카오 채널로 그룹 목록 조회
- 4. 카카오 그룹에 채널 등록
- 5. 카카오 그룹에 포함된 채널 조회
- 6. 카카오 그룹 목록 조회
- 7. 카카오 그룹에서 채널 삭제
- 8. 고객사 카카오 채널 기간별 조회
- 9. 알림톡 인증 토큰 요청
- 10. 삭제한 채널 아이디 복구
- 11. 알림톡 채널등록 사전정보 요청
- 12. 미사용 프로필 휴면 해제
- 13. 카카오 채널 조회
- 14. 카카오 채널 등록
- 15. 템플릿 (재)검수요청
- 16. 템플릿 삭제
- 17. 템플릿 문의하기
- 18. 템플릿 목록 조회
- 19. 템플릿 생성
- 20. 템플릿 수정
- 21. 템플릿 조회
- Appendix
1. 템플릿 카테고리 코드 조회
Section titled “1. 템플릿 카테고리 코드 조회”카카오톡 비즈니스 메시지 발송 시 필요한 템플릿 카테고리 코드 목록을 조회합니다. 각 카테고리는 메시지의 성격과 용도에 따라 분류되며, 템플릿 생성 시 반드시 지정해야 합니다.
📌 주의사항
Section titled “📌 주의사항”- 카테고리 코드는 템플릿 생성 시 필수 입력 항목입니다.
- 카테고리 코드는 6자리로 구성되며, 그룹 코드와 세부 코드로 구분됩니다.
- 카테고리 선택 시 포함/제외 예시를 참고하여 적절한 카테고리를 선택해야 합니다.
1) 요청 (Request)
Section titled “1) 요청 (Request)”POST https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/template/category/all HTTP/1.1Headers
Section titled “Headers”| Name | Type | 필수 | 설명 |
|---|---|---|---|
| Authorization | String | ● | 사용자 인증 토큰 |
| Content-Type | String | ● | application/json |
2) 응답 (Response)
Section titled “2) 응답 (Response)”Response Body
Section titled “Response Body”| Name | Type | 설명 |
|---|---|---|
| code | String | 결과 코드 |
| message | String | 결과 메시지 |
| data | Array | 결과 데이터 목록 |
| data[].code | String | 카테고리 코드 |
| data[].name | String | 카테고리 이름 |
| data[].groupName | String | 카테고리 그룹 이름 |
| data[].iclusion | String | 포함 예시 |
| data[].exclusion | String | 제외 예시 |
3) 요청 예시 (Sample)
Section titled “3) 요청 예시 (Sample)”curl -X POST "https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/template/category/all" \ -H "accept: */*" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer {token}"JSON Response
Section titled “JSON Response”{ "code": "10000", "message": "성공", "data": [ { "code": "003001", "name": "예약완료/예약내역", "groupName": "예약", "iclusion": "예약한 서비스의 확정된 예약 정보를 안내", "exclusion": "예약한 서비스의 이용안내는 서비스 이용안내(004001)로 분류 합니다.\n예약신청한 서비스의 예약 진행상황은 예약 > 예약상태(003002) 로 분류합니다." }, { "code": "001001", "name": "주문/결제완료", "groupName": "쇼핑", "iclusion": "주문 및 결제가 완료된 내역", "exclusion": "결제 안내는 결제 > 결제 안내(002001)로 분류합니다." } ]}2. 카카오 카테고리 정보 리스트
Section titled “2. 카카오 카테고리 정보 리스트”카카오톡 비즈니스 채널 설정 시 사용되는 카테고리 정보 목록을 조회합니다. 이 API를 통해 채널 등록 시 필요한 카테고리 정보를 확인할 수 있습니다.
1) 요청 (Request)
Section titled “1) 요청 (Request)”POST https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/category/all HTTP/1.1Headers
Section titled “Headers”| Name | Type | 필수 | 설명 |
|---|---|---|---|
| Authorization | String | ● | 사용자 인증 토큰 |
| Content-Type | String | ● | application/json |
2) 응답 (Response)
Section titled “2) 응답 (Response)”Response Body
Section titled “Response Body”| Name | Type | 설명 |
|---|---|---|
| code | String | 결과 코드 |
| message | String | 결과 메시지 |
| data | Array | 결과 데이터 목록 |
| data[].code | String | 카테고리 코드 |
| data[].name | String | 카테고리 정보 |
3) 요청 예시 (Sample)
Section titled “3) 요청 예시 (Sample)”curl -X POST "https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/category/list" \ -H "accept: */*" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer {token}"JSON Response
Section titled “JSON Response”{ "code": "10000", "message": "성공", "data": [ { "code": "00100010001", "name": "건강,병원,종합병원" }, { "code": "00100020001", "name": "교육,학문,학원" }, ... ]}3. 카카오 채널로 그룹 목록 조회
Section titled “3. 카카오 채널로 그룹 목록 조회”특정 카카오 채널이 속한 그룹 목록을 조회합니다. 채널 ID를 기준으로 해당 채널이 속한 모든 그룹 정보를 확인할 수 있습니다.
1) 요청 (Request)
Section titled “1) 요청 (Request)”POST https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/group/list HTTP/1.1Headers
Section titled “Headers”| Name | Type | 필수 | 설명 |
|---|---|---|---|
| Authorization | String | ● | 사용자 인증 토큰 |
| Content-Type | String | ● | application/json |
Request Body
Section titled “Request Body”| Name | Type | 필수 | 설명 | 크기 |
|---|---|---|---|---|
| kkoChId | String | ● | 카카오 채널 ID | 61자 |
2) 응답 (Response)
Section titled “2) 응답 (Response)”Response Body
Section titled “Response Body”| Name | Type | 설명 |
|---|---|---|
| code | String | 결과 코드 |
| message | String | 결과 메시지 |
| data | Array | 결과 데이터 목록 |
| data[].chGrpKey | String | 채널 그룹 키 |
| data[].chGrpName | String | 채널 그룹 이름 |
| data[].regDt | String | 채널 그룹 등록일시 |
3) 요청 예시 (Sample)
Section titled “3) 요청 예시 (Sample)”curl -X POST "https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/group/list" \ -H "accept: */*" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer {token}" \ -d '{ "kkoChId": "@myservice" }'JSON Response
Section titled “JSON Response”{ "code": "10000", "message": "성공", "data": [ { "chGrpKey": "AaAMvjr", "chGrpName": "마케팅 그룹", "regDt": "2023-02-23T20:32:34" }, { "chGrpKey": "BbAMvjd", "chGrpName": "고객 서비스 그룹", "regDt": "2024-03-12T10:31:30" }, ... ]}4. 카카오 그룹에 채널 등록
Section titled “4. 카카오 그룹에 채널 등록”기존 카카오 그룹에 새로운 채널을 추가합니다. 그룹 관리를 통해 여러 채널을 효율적으로 관리할 수 있습니다.
📌 주의사항
Section titled “📌 주의사항”- 그룹 키와 채널 ID는 필수 입력 항목입니다.
- 이미 그룹에 등록된 채널은 중복 등록할 수 없습니다.
- 채널 등록 후 그룹 내 채널 목록 조회 API로 등록 여부를 확인할 수 있습니다.
1) 요청 (Request)
Section titled “1) 요청 (Request)”POST https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/group/add HTTP/1.1Headers
Section titled “Headers”| Name | Type | 필수 | 설명 |
|---|---|---|---|
| Authorization | String | ● | 사용자 인증 토큰 |
| Content-Type | String | ● | application/json |
Request Body
Section titled “Request Body”| Name | Type | 필수 | 설명 | 크기 |
|---|---|---|---|---|
| chGrpKey | String | ● | 채널 그룹 고유 키 | - |
| kkoChId | String | ● | 카카오 채널 ID | 61자 |
2) 응답 (Response)
Section titled “2) 응답 (Response)”Response Body
Section titled “Response Body”| Name | Type | 설명 |
|---|---|---|
| code | String | 결과 코드 |
| message | String | 결과 메시지 |
| data | Object | 결과 데이터 정보 |
| data.chGrpKey | String | 채널 그룹 고유 키 |
| data.kkoChId | String | 카카오 채널 ID |
3) 요청 예시 (Sample)
Section titled “3) 요청 예시 (Sample)”curl -X POST "https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/group/add" \ -H "accept: */*" \```H "Content-Type: application/json" \ -H "Authorization: Bearer {token}" \ -d '{ "chGrpKey": "GROUP_001", "kkoChId": "@myservice" }'JSON Response
Section titled “JSON Response”{ "code": "10000", "message": "성공", "data": { "chGrpKey": "GROUP_001", "kkoChId": "@myservice" }}5. 카카오 그룹에 포함된 채널 조회
Section titled “5. 카카오 그룹에 포함된 채널 조회”특정 카카오 그룹에 포함된 모든 채널 목록을 조회합니다. 그룹 내 채널 관리 및 모니터링에 활용할 수 있습니다.
1) 요청 (Request)
Section titled “1) 요청 (Request)”GET https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/group/{groupKey} HTTP/1.1Headers
Section titled “Headers”| Name | Type | 필수 | 설명 |
|---|---|---|---|
| Authorization | String | ● | 사용자 인증 토큰 |
| Content-Type | String | ● | application/json |
Path Parameters
Section titled “Path Parameters”| Name | Type | 필수 | 설명 |
|---|---|---|---|
| groupKey | String | ● | 조회할 채널 그룹 키 |
2) 응답 (Response)
Section titled “2) 응답 (Response)”Response Body
Section titled “Response Body”| Name | Type | 설명 |
|---|---|---|
| code | String | 결과 코드 |
| message | String | 결과 메시지 |
| data | Array | 결과 데이터 목록 |
| data[].chGrpKey | String | 채널 그룹 고유 키 |
| data[].kkoChId | String | 카카오 채널 ID |
| data[].regDt | String | 등록일시 |
3) 요청 예시 (Sample)
Section titled “3) 요청 예시 (Sample)”curl -X GET "https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/group/GROUP_KEY" \ -H "accept: */*" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer {token}"JSON Response
Section titled “JSON Response”{ "code": "10000", "message": "성공", "data": [ { "chGrpKey": "GROUP_KEY", "kkoChId": "@myservice1", "regDt": "2025-07-09T09:32:20" }, { "chGrpKey": "AcQMvjr", "kkoChId": "@myservice2", "regDt": "2025-07-09T09:32:20" }, ... ]}6. 카카오 그룹 목록 조회
Section titled “6. 카카오 그룹 목록 조회”전체 카카오 채널 그룹 목록을 조회합니다. 그룹 관리 및 모니터링에 활용할 수 있습니다.
1) 요청 (Request)
Section titled “1) 요청 (Request)”GET https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/group/all HTTP/1.1Headers
Section titled “Headers”| Name | Type | 필수 | 설명 |
|---|---|---|---|
| Authorization | String | ● | 사용자 인증 토큰 |
| Content-Type | String | ● | application/json |
2) 응답 (Response)
Section titled “2) 응답 (Response)”Response Body
Section titled “Response Body”| Name | Type | 설명 |
|---|---|---|
| code | String | 결과 코드 |
| message | String | 결과 메시지 |
| data | Array | 결과 데이터 목록 |
| data[].chGrpKey | String | 채널 그룹 키 |
| data[].chGrpName | String | 채널 그룹 이름 |
| data[].chGrpStatCd | Number | 채널 그룹 상태 코드(요청:R / 승인:A / 거절:C) |
| data[].regDt | String | 생성일시 |
| data[].updDt | String | 수정일시 |
3) 요청 예시 (Sample)
Section titled “3) 요청 예시 (Sample)”curl -X GET "https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/group/all" \ -H "accept: */*" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer {token}"JSON Response
Section titled “JSON Response”{ "code": "10000", "message": "성공", "data": [ { "chGrpKey": "GroupKey1", "chGrpName": "마케팅 1그룹", "chGrpStatCd": "A", "regDt": "2025-07-09T09:40:02", "updDt": null }, { "chGrpKey": "GroupKey2", "chGrpName": "마케팅 2그룹", "chGrpStatCd": "R", "regDt": "2025-07-09T09:51:22", "updDt": null }, ... ]}7. 카카오 그룹에서 채널 삭제
Section titled “7. 카카오 그룹에서 채널 삭제”카카오 그룹에서 특정 채널을 제거합니다. 그룹 내 채널 관리에 활용할 수 있습니다.
📌 주의사항
Section titled “📌 주의사항”- 그룹 키와 채널 ID는 필수 입력 항목입니다.
- 그룹에서 채널을 삭제해도 채널 자체는 삭제되지 않습니다.
1) 요청 (Request)
Section titled “1) 요청 (Request)”DELETE https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/group/remove HTTP/1.1Headers
Section titled “Headers”| Name | Type | 필수 | 설명 |
|---|---|---|---|
| Authorization | String | ● | 사용자 인증 토큰 |
| Content-Type | String | ● | application/json |
Request Body
Section titled “Request Body”| Name | Type | 필수 | 설명 |
|---|---|---|---|
| chGrpKey | String | ● | 채널 그룹 고유 키 |
| kkoChId | String | ● | 카카오 채널 ID |
2) 응답 (Response)
Section titled “2) 응답 (Response)”Response Body
Section titled “Response Body”| Name | Type | 설명 |
|---|---|---|
| code | String | 결과 코드 |
| message | String | 결과 메시지 |
| data | Object | 결과 데이터 정보 |
| data.chGrpKey | String | 채널 그룹 고유 키 |
| data.kkoChId | String | 카카오 채널 ID |
3) 요청 예시 (Sample)
Section titled “3) 요청 예시 (Sample)”curl -X DELETE "https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/group/remove" \ -H "accept: */*" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer {token}" \ -d '{ "chGrpKey": "GROUP_001", "kkoChId": "@myservice" }'JSON Response
Section titled “JSON Response”{ "code": "10000", "message": "성공", "data": { "chGrpKey": "GROUP_001", "kkoChId": "@myservice" }}8. 고객사 카카오 채널 기간별 조회
Section titled “8. 고객사 카카오 채널 기간별 조회”특정 기간 동안 등록된 카카오톡 채널 목록을 조회합니다.
📌 주의사항
Section titled “📌 주의사항”- 표준시간 형식은 YYYYMMDDHHMMSS입니다.
- 페이지 번호와 페이지 사이즈는 선택 입력 항목입니다.
1) 요청 (Request)
Section titled “1) 요청 (Request)”POST https://mnt-api.msghub.uplus.co.kr/kko/v2/kkoChannelList HTTP/1.1Headers
Section titled “Headers”| Name | Type | 필수 | 설명 |
|---|---|---|---|
| Authorization | String | ● | 사용자 인증 토큰 |
| Content-Type | String | ● | application/json |
Request Body
Section titled “Request Body”| Name | Type | 필수 | 설명 | 크기 |
|---|---|---|---|---|
| standardDateTime | String | ● | 검색할 기간 시간 (YYYYMMDDHHMMSS 형식) | 14자 |
| page | Integer | - | 검색할 페이지 번호 | - |
| pageSize | Integer | - | 검색할 페이지 사이즈 | - |
2) 응답 (Response)
Section titled “2) 응답 (Response)”Response Body
Section titled “Response Body”| Name | Type | 설명 |
|---|---|---|
| code | String | 결과 코드 |
| message | String | 결과 메시지 |
| data | Array | 결과 데이터 목록 |
| data[].kkoChId | String | 카카오 채널 ID |
| data[].kkoChStat | String | 채널 상태 (A: 활성화, C: 비활성화, B: 차단, E: 삭제 중, D: 삭제됨) |
| data[].createDate | String | 등록 일자 (YYYY-MM-DD HH:MM:SS 형식) |
| data[].categoryCode | String | 카테고리 코드 |
3) 요청 예시 (Sample)
Section titled “3) 요청 예시 (Sample)”curl -X POST "https://mnt-api.msghub.uplus.co.kr/kko/v2/kkoChannelList" \ -H "accept: */*" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer {token}" \ -d '{ "standardDateTime": "20240912000000", "page": 1, "pageSize": 1000 }'JSON Response
Section titled “JSON Response”{ "code": "10000", "message": "성공", "data": [ { "kkoChId": "@메시지허브", "kkoChStat": "A", "createDate": "2024-05-28 19:59:26", "categoryCode": "01100010001" } ]}9. 알림톡 인증 토큰 요청
Section titled “9. 알림톡 인증 토큰 요청”알림톡 채널 등록 시 필요한 인증 토큰을 단말로 전달합니다.
1) 요청 (Request)
Section titled “1) 요청 (Request)”POST https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/token HTTP/1.1Headers
Section titled “Headers”| Name | Type | 필수 | 설명 |
|---|---|---|---|
| Authorization | String | ● | 사용자 인증 토큰 |
| Content-Type | String | ● | application/json |
Request Body
Section titled “Request Body”| Name | Type | 필수 | 설명 | 크기 |
|---|---|---|---|---|
| phoneNumber | String | ● | 플러스친구 관리자번호 | 최대 11자 |
| kkoChId | String | ● | 카카오채널 검색용ID | 최대 61자 |
| relay | String | ● | 카카오채널 등록 relay ID (LGCNS, LMESSAGE, MTS, r01, r02, …) | - |
2) 응답 (Response)
Section titled “2) 응답 (Response)”Response Body
Section titled “Response Body”| Name | Type | 설명 |
|---|---|---|
| code | String | 결과 코드 |
| message | String | 결과 메시지 |
| data | Object | 결과 데이터 정보 |
| data.phoneNumber | String | 플러스친구 관리자번호 |
| data.yellowId | String | 카카오 채널 ID |
| data.kkoChId | String | 카카오 채널 ID |
| data.relay | String | 카카오채널 등록 relay ID |
3) 요청 예시 (Sample)
Section titled “3) 요청 예시 (Sample)”curl -X POST "https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/token" \ -H "accept: */*" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer {token}" \ -d '{ "phoneNumber": "01099999999", "kkoChId": "@myservice", "relay": "LGCNS" }'JSON Response
Section titled “JSON Response”{ "code": "10000", "message": "성공", "data": { "phoneNumber": "01099999999", "yellowId": "@myservice", "kkoChId": "@myservice", "relay": "r01" }}10. 삭제한 채널 아이디 복구
Section titled “10. 삭제한 채널 아이디 복구”이전에 삭제한 카카오 채널 아이디를 복구합니다.
1) 요청 (Request)
Section titled “1) 요청 (Request)”POST https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/restore HTTP/1.1Headers
Section titled “Headers”| Name | Type | 필수 | 설명 |
|---|---|---|---|
| Authorization | String | ● | 사용자 인증 토큰 |
| Content-Type | String | ● | application/json |
Request Body
Section titled “Request Body”| Name | Type | 필수 | 설명 | 크기 |
|---|---|---|---|---|
| kkoChId | String | ● | 카카오채널 검색용ID | 최대 61자 |
2) 응답 (Response)
Section titled “2) 응답 (Response)”Response Body
Section titled “Response Body”| Name | Type | 설명 |
|---|---|---|
| code | String | 결과 코드 |
| message | String | 결과 메시지 |
3) 요청 예시 (Sample)
Section titled “3) 요청 예시 (Sample)”curl -X POST "https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/restore" \ -H "accept: */*" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer {token}" \ -d '{ "kkoChId": "@myservice" }'JSON Response
Section titled “JSON Response”{ "code": "10000", "message": "성공"}11. 알림톡 채널등록 사전정보 요청
Section titled “11. 알림톡 채널등록 사전정보 요청”알림톡 채널 등록에 필요한 사전 정보를 요청합니다.
📌 주의사항
Section titled “📌 주의사항”- 응답 필드에 사용 가능한 relay ID 목록이 포함됩니다.
1) 요청 (Request)
Section titled “1) 요청 (Request)”POST https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/relayinfo HTTP/1.1Headers
Section titled “Headers”| Name | Type | 필수 | 설명 |
|---|---|---|---|
| Authorization | String | ● | 사용자 인증 토큰 |
| Content-Type | String | ● | application/json |
2) 응답 (Response)
Section titled “2) 응답 (Response)”Response Body
Section titled “Response Body”| Name | Type | 설명 |
|---|---|---|
| code | String | 결과 코드 |
| message | String | 결과 메시지 |
| data | Object | 결과 데이터 정보 |
| data.relay | Array | 사용 가능한 relay ID 목록 |
3) 요청 예시 (Sample)
Section titled “3) 요청 예시 (Sample)”curl -X POST "https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/relayinfo" \ -H "accept: */*" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer {token}"JSON Response
Section titled “JSON Response”{ "code": "10000", "message": "성공", "data": { "relay": ["r01", "r02"] }}12. 미사용 프로필 휴면 해제
Section titled “12. 미사용 프로필 휴면 해제”장기간 미사용으로 휴면 상태가 된 카카오 채널 프로필을 활성화합니다.
📌 주의사항
Section titled “📌 주의사항”- 카카오채널 검색용ID는 필수 입력 항목입니다.
1) 요청 (Request)
Section titled “1) 요청 (Request)”POST https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/recover HTTP/1.1Headers
Section titled “Headers”| Name | Type | 필수 | 설명 |
|---|---|---|---|
| Authorization | String | ● | 사용자 인증 토큰 |
| Content-Type | String | ● | application/json |
Request Body
Section titled “Request Body”| Name | Type | 필수 | 설명 | 크기 |
|---|---|---|---|---|
| kkoChId | String | ● | 카카오채널 검색용ID | 최대 61자 |
2) 응답 (Response)
Section titled “2) 응답 (Response)”Response Body
Section titled “Response Body”| Name | Type | 설명 |
|---|---|---|
| code | String | 결과 코드 |
| message | String | 결과 메시지 |
3) 요청 예시 (Sample)
Section titled “3) 요청 예시 (Sample)”curl -X POST "https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/recover" \ -H "accept: */*" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer {token}" \ -d '{ "kkoChId": "@myservice" }'JSON Response
Section titled “JSON Response”{ "code": "10000", "message": "성공"}13. 카카오 채널 조회
Section titled “13. 카카오 채널 조회”등록된 카카오 채널의 상세 정보를 조회합니다.
1) 요청 (Request)
Section titled “1) 요청 (Request)”POST https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/get HTTP/1.1Headers
Section titled “Headers”| Name | Type | 필수 | 설명 |
|---|---|---|---|
| Authorization | String | ● | 사용자 인증 토큰 |
| Content-Type | String | ● | application/json |
Request Body
Section titled “Request Body”| Name | Type | 필수 | 설명 | 크기 |
|---|---|---|---|---|
| kkoChId | String | ● | 카카오 채널ID | 최대 61자 |
2) 응답 (Response)
Section titled “2) 응답 (Response)”Response Body
Section titled “Response Body”| Name | Type | 설명 |
|---|---|---|
| code | String | 결과 코드 |
| message | String | 결과 메시지 |
| data | Object | 결과 데이터 정보 |
| data.kkoChId | String | 카카오 채널 ID |
| data.stat | String | 상태 (A: 정상, B: 차단, P: 휴면, D: 삭제) |
| data.createDate | String | 생성 일자 |
| data.categoryCode | String | 카테고리 코드 |
3) 요청 예시 (Sample)
Section titled “3) 요청 예시 (Sample)”curl -X POST "https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/get" \ -H "accept: */*" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer {token}" \ -d '{ "kkoChId": "@myservice" }'JSON Response
Section titled “JSON Response”{ "code": "10000", "message": "성공", "data": { "kkoChId": "@myservice", "stat": "A", "createDate": "2023-09-25T11:37:03", "categoryCode": "01300010001" }}14. 카카오 채널 등록
Section titled “14. 카카오 채널 등록”카카오 채널을 시스템에 등록합니다. 실제 채널 생성은 카카오비즈센터에서 해야 합니다.
1) 요청 (Request)
Section titled “1) 요청 (Request)”POST https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/create HTTP/1.1Headers
Section titled “Headers”| Name | Type | 필수 | 설명 |
|---|---|---|---|
| Authorization | String | ● | 사용자 인증 토큰 |
| Content-Type | String | ● | application/json |
Request Body
Section titled “Request Body”| Name | Type | 필수 | 설명 | 크기 |
|---|---|---|---|---|
| tokens | Array | ● | relay token 정보 | - |
| categoryCode | String | ● | 카테고리 코드 | 11자 |
| kkoChId | String | ● | 카카오채널 검색용ID | 61자 |
| memo | String | - | 메모 | - |
tokens 객체
Section titled “tokens 객체”| Name | Type | 필수 | 설명 |
|---|---|---|---|
| rid | String | ● | relay ID |
| token | Integer | ● | 인증 코드 |
| phoneNumber | String | ● | 플러스친구 관리자번호 |
2) 응답 (Response)
Section titled “2) 응답 (Response)”Response Body
Section titled “Response Body”| Name | Type | 설명 |
|---|---|---|
| code | String | 결과 코드 |
| message | String | 결과 메시지 |
3) 요청 예시 (Sample)
Section titled “3) 요청 예시 (Sample)”curl -X POST "https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/create" \ -H "accept: */*" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer {token}" \ -d '{ "tokens": [ { "rid": "r01", "token": 888999, "phoneNumber": "01099999999" } ], "categoryCode": "01800040001", "kkoChId": "@myservice", "memo": "비즈니스 채널" }'JSON Response
Section titled “JSON Response”{ "code": "10000", "message": "성공"}15. 템플릿 (재)검수요청
Section titled “15. 템플릿 (재)검수요청”카카오톡 비즈메시지 템플릿에 대한 검수 요청을 진행합니다.
📌 주의사항
Section titled “📌 주의사항”- 템플릿 상태가 ‘T’ 인 경우에만 검수요청 가능합니다.
- 템플릿 검수 중 상태코드 전이 과정(T -> R -> Q -> S / A)
- 상태코드 설명(T : 등록완료, R : 검수요청완료, Q : 카카오 검수중, A : 템플릿 승인 완료, S: 템플릿 반려)
1) 요청 (Request)
Section titled “1) 요청 (Request)”POST https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/template/request HTTP/1.1Headers
Section titled “Headers”| Name | Type | 필수 | 설명 |
|---|---|---|---|
| Authorization | String | ● | 사용자 인증 토큰 |
| Content-Type | String | ● | application/json |
Request Body
Section titled “Request Body”| Name | Type | 필수 | 설명 | 크기 |
|---|---|---|---|---|
| kkoChId | String | ● | 카카오 채널ID | 61자 |
| kkoGrpId | String | - | 카카오 그룹ID | 100자 |
| templateCode | String | ● | 템플릿 코드 (공백 허용 안 함) | 50자 |
| senderKeyType | String | - | 채널 유형, S: 일반, G: 그룹 (Default: S) | 1자 |
| comment | String | - | 의견 또는 문의사항 | 500자 |
2) 응답 (Response)
Section titled “2) 응답 (Response)”Response Body
Section titled “Response Body”| Name | Type | 설명 |
|---|---|---|
| code | String | 결과 코드 |
| message | String | 결과 메시지 |
3) 요청 예시 (Sample)
Section titled “3) 요청 예시 (Sample)”curl -X POST "https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/template/request" \ -H "accept: */*" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer {token}" \ -d '{ "kkoChId": "@myservice", "kkoGrpId": "mygroupid", "templateCode": "template_code_123", "senderKeyType": "S", "comment": "검수요청" }'JSON Response
Section titled “JSON Response”{ "code": "10000", "message": "성공"}16. 템플릿 삭제
Section titled “16. 템플릿 삭제”등록된 카카오톡 비즈메시지 템플릿을 삭제합니다.
📌 주의사항
Section titled “📌 주의사항”- 템플릿 상태가 ‘T’ 인 경우에만 삭제 가능합니다.
- 템플릿 검수 중 상태코드 전이 과정(T -> R -> Q -> S / A)
- 상태코드 설명(T : 등록완료, R : 검수요청완료, Q : 카카오 검수중, A : 템플릿 승인 완료, S: 템플릿 반려)
- 삭제된 템플릿은 API로 조회 등이 불가능합니다.
1) 요청 (Request)
Section titled “1) 요청 (Request)”POST https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/template/delete HTTP/1.1Headers
Section titled “Headers”| Name | Type | 필수 | 설명 |
|---|---|---|---|
| Authorization | String | ● | 사용자 인증 토큰 |
| Content-Type | String | ● | application/json |
Request Body
Section titled “Request Body”| Name | Type | 필수 | 설명 | 크기 |
|---|---|---|---|---|
| kkoChId | String | ● | 카카오 채널ID | 최대 61자 |
| kkoGrpId | String | - | 카카오 그룹ID | 최대 100자 |
| templateCode | String | ● | 템플릿 코드 (공백 허용 안 함) | 최대 50자 |
| senderKeyType | String | - | 채널 유형, S: 일반, G: 그룹 (Default: S) | 1자 |
| comment | String | - | 의견 또는 문의사항 | 500자 |
2) 응답 (Response)
Section titled “2) 응답 (Response)”Response Body
Section titled “Response Body”| Name | Type | 설명 |
|---|---|---|
| code | String | 결과 코드 |
| message | String | 결과 메시지 |
3) 요청 예시 (Sample)
Section titled “3) 요청 예시 (Sample)”curl -X POST "https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/template/delete" \ -H "accept: */*" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer {token}" \ -d '{ "kkoChId": "@myservice", "kkoGrpId": "mygroupid", "templateCode": "template_code_123", "senderKeyType": "S", "comment": "검수요청" }'JSON Response
Section titled “JSON Response”{ "code": "10000", "message": "성공"}17. 템플릿 문의하기
Section titled “17. 템플릿 문의하기”템플릿에 관한 문의사항을 등록합니다.
1) 요청 (Request)
Section titled “1) 요청 (Request)”POST https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/template/comment HTTP/1.1Headers
Section titled “Headers”| Name | Type | 필수 | 설명 |
|---|---|---|---|
| Authorization | String | ● | 사용자 인증 토큰 |
| Content-Type | String | ● | application/json |
Request Body
Section titled “Request Body”| Name | Type | 필수 | 설명 | 크기 |
|---|---|---|---|---|
| kkoChId | String | ● | 카카오 채널ID | 최대 61자 |
| kkoGrpId | String | - | 카카오 그룹ID | 최대 100자 |
| templateCode | String | ● | 템플릿 코드 (공백x) | 최대 50자 |
| senderType | String | - | 채널 유형, S: 일반, G: 그룹 (Default: S) | 1자 |
| comment | String | ● | 문의내용 | 최대 500자 |
2) 응답 (Response)
Section titled “2) 응답 (Response)”Response Body
Section titled “Response Body”| Name | Type | 설명 |
|---|---|---|
| code | String | 결과 코드 |
| message | String | 결과 메시지 |
3) 요청 예시 (Sample)
Section titled “3) 요청 예시 (Sample)”curl -X POST "https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/template/comment" \ -H "accept: */*" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer {token}" \ -d '{ "kkoChId": "@myservice", "kkoGrpId": "mygroupid", "templateCode": "template_code_123", "senderType": "S", "comment": "템플릿 반려의견에 관한 문의사항이 있습니다........(중략)" }'JSON Response
Section titled “JSON Response”{ "code": "10000", "message": "성공"}18. 템플릿 목록 조회
Section titled “18. 템플릿 목록 조회”승인된 템플릿 목록을 조회합니다.
1) 요청 (Request)
Section titled “1) 요청 (Request)”POST https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/template/all HTTP/1.1Headers
Section titled “Headers”| Name | Type | 필수 | 설명 |
|---|---|---|---|
| Authorization | String | ● | 사용자 인증 토큰 |
| Content-Type | String | ● | application/json |
Request Body
Section titled “Request Body”| Name | Type | 필수 | 설명 | 크기 |
|---|---|---|---|---|
| kkoChId | String | ● | 카카오 채널ID | 최대 61자 |
| kkoGrpId | String | - | 카카오 그룹ID | 최대 100자 |
| senderType | String | ● | 발신프로필타입, S: 카카오채널(디폴트) G: 그룹 | 1자 |
| updateDt | String | - | 최종갱신일시(YYYYMMDDHHMMSS), 미입력시 전체 조회 | 14자 |
2) 응답 (Response)
Section titled “2) 응답 (Response)”Response Body
Section titled “Response Body”| Name | Type | 설명 |
|---|---|---|
| code | String | 결과 코드 |
| message | String | 결과 메시지 |
| data | Array | 결과 데이터 목록 |
| data[].kkoChId | String | 카카오 채널ID |
| data[].templateName | String | 템플릿명 |
| data[].templateKey | String | 템플릿키 |
| data[].templateCode | String | 템플릿코드 |
| data[].templateStatusCode | String | 템플릿상태코드 |
템플릿 상태 코드 정보
Section titled “템플릿 상태 코드 정보”- T: 등록완료
- R: 검수요청완료(딜러사 검수중)
- Q: 카카오 검수중
- A: 템플릿 승인 완료
- S: 템플릿 반려
3) 요청 예시 (Sample)
Section titled “3) 요청 예시 (Sample)”curl -X POST "https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/template/all" \ -H "accept: */*" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer {token}" \ -d '{ "kkoChId": "@myservice", "kkoGrpId": "mygroupid", "senderType": "S", "updateDt": "20230201120000" }'JSON Response
Section titled “JSON Response”{ "code": "10000", "message": "성공", "data": [ { "kkoChId": "@myservice", "templateName": "테스트템플릿", "templateKey": "AlefJHasfD", "templateCode": "myTemplateCode", "templateStatusCode": "R" } ]}19. 템플릿 생성
Section titled “19. 템플릿 생성”새로운 카카오톡 메시지 템플릿을 생성합니다.
📌 주의사항
Section titled “📌 주의사항”- 이미지 파일이 없는 경우 헤더의 Content-Type 은
application/json로 요청해야합니다. - 이미지 파일이 있는 경우 헤더의 Content-Type 은
multipart/form-data로 요청해야합니다. - 템플릿 유형별로 필요한 항목이 다르므로 아래 요청 예시 부분을 참고하여 등록 바랍니다.
1) 요청 (Request)
Section titled “1) 요청 (Request)”POST https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/template/create HTTP/1.1Headers
Section titled “Headers”| Name | Type | 필수 | 설명 |
|---|---|---|---|
| Authorization | String | ● | 사용자 인증 토큰 |
| Content-Type | String | ● | application/json 또는 multipart/form-data |
Request Body
Section titled “Request Body”| Name | Type | 필수 | 설명 |
|---|---|---|---|
| reqBody | Object | ● | 템플릿 생성 요청 정보 |
| itemHighlightImage | binary | - | 아이템 하이라이트 이미지 binary 데이터 |
| image | binary | - | 이미지 binary 데이터 |
reqBody 객체
Section titled “reqBody 객체”| Name | Type | 필수 | 설명 | 크기 |
|---|---|---|---|---|
| kkoChId | String | ● | 카카오채널 ID | 최대 61자 |
| kkoGrpId | String | - | 카카오그룹 ID | 최대 100자 |
| senderType | String | ● | 발신프로필타입, S : 카카오채널(디폴트) G : 그룹 | 1자 |
| templateCode | String | - | 템플릿 코드 (공백x) | 최대 50자 |
| templateName | String | ● | 템플릿명 | 최대 200자 |
| templateContent | String | ● | 템플릿내용 | 최대 1000자 |
| categoryCode | String | ● | 카테고리코드 | 최대 6자 |
| templateMessageType | String | ● | 메시지 유형 (BA: 기본형, EX: 부가 정보형, AD: 광고 추가형, MI: 복합형) | 2자 |
| templateExtra | String | - | 부가정보 | 최대 500자 |
| templateAd | String | - | 광고성 메시지 | 1000자(templateContent 글자수에 포함됨) |
| templateEmphasizeType | String | ● | 강조표기유형 (NONE: 선택안함, TEXT: 강조표기형, IMAGE: 이미지형, ITEM_LIST: 아이템리스트형) | 최대 9자 |
| itemHeader | String | - | 아이템리스트형 헤더정보 | 최대 16자 |
| itemHighlightTitle | String | - | 아이템하이라이트 타이틀(썸네일 이미지 사용 시 21자 제한) | 최대 30자 |
| itemHighlightDescription | String | - | 아이템하이라이트 설명(썸네일 이미지 사용 시 13자 제한, 타이틀 설정 시 필수) | 최대 19자 |
| itemList | Array | - | 아이템리스트, 최소 2개, 최대 10개까지 가능 | - |
| itemSummaryTitle | String | - | 아이템 요약 정보 타이틀 | 최대 6자 |
| itemSummaryDescription | String | - | 아이템 요약 정보 설명 | 최대 14자 |
| templateTitle | String | - | 강조표기핵심 정보 | - |
| templateSubtitle | String | - | 강조표기보조 문구 | - |
| securityFlag | Boolean | - | 보안 템플릿 여부 (보안 메시지 일 경우 true) | 최대 5자 |
| buttons | Array | - | 템플릿 버튼 목록 | 최대 5개 |
| templatePreviewMessage | String | - | 템플릿 미리보기 메시지 | 40자 |
2) 응답 (Response)
Section titled “2) 응답 (Response)”Response Body
Section titled “Response Body”| Name | Type | 설명 |
|---|---|---|
| code | String | 결과 코드 |
| message | String | 결과 메시지 |
| data | Object | 결과 데이터 정보 |
| data.templateKey | String | 템플릿키(유일키) |
| data.templateCode | String | 템플릿코드 |
| data.templateName | String | 템플릿명 |
| data.kkoChId | String | 카카오채널 검색용ID |
| data.templateInfo | Object | 템플릿 상세정보 |
| data.templateInfo.senderKey | String | 발신프로필키 |
| data.templateInfo.senderType | String | 발신프로필타입(S:카카오채널, G:그룹) |
| data.templateInfo.templateCode | String | 템플릿코드 |
| data.templateInfo.kkoTemplateCode | String | 카카오 템플릿코드 |
| data.templateInfo.templateName | String | 템플릿명 |
| data.templateInfo.templateContent | String | 템플릿내용 |
| data.templateInfo.categoryCode | String | 카테고리코드 |
| data.templateInfo.templateMessageType | String | 메시지 유형(BA:기본형, EX:부가 정보형, AD:광고 추가형, MI:복합형) |
| data.templateInfo.templateEmphasizeType | String | 메시지 강조표기유형 (NONE: 선택안함, TEXT: 강조표기형, IMAGE: 이미지형, ITEM_LIST: 아이템리스트형) |
| data.templateInfo.templateTitle | String | 강조표기 핵심 정보 |
| data.templateInfo.templateSubtitle | String | 강조표기 보조 문구 |
| data.templateInfo.templateStatusCode | String | 템플릿상태(T:등록완료, R:검수요청완료, Q:카카오 검수중, A:템플릿 승인 완료, S:템플릿 반려) |
| data.templateInfo.block | boolean | 차단여부(true:차단, false:차단해제) |
| data.templateInfo.dormant | boolean | 휴면여부(true:휴면, false:휴면해제) |
| data.templateInfo.createId | String | 생성자 ID |
| data.templateInfo.createDate | String | 생성일자 |
| data.templateInfo.approvalDate | String | 검수일자 |
| data.templateInfo.comments | Array | 댓글리스트 |
| data.templateInfo.comments[].idx | String | 댓글 아이디 |
| data.templateInfo.comments[].createId | String | 작성자 |
| data.templateInfo.comments[].content | String | 내용 |
| data.templateInfo.comments[].createDate | String | 등록일 |
| data.templateInfo.comments[].status | String | 댓글 상태 (INQ:문의, APR:승인, REJ:반려, REP:답변) |
| data.templateInfo.templateKey | String | 템플릿키 |
| data.templateInfo.relay | String | 중계사 정보 |
| data.templateInfo.imageFileName | String | 이미지 파일명 |
| data.templateInfo.itemHighlightImageFileName | String | 아이템 하이라이트 이미지 파일명 |
| data.templateInfo.templateTitleFixYn | String | 템플릿 타이틀 고정 여부 |
| data.templateInfo.item | Object | 아이템 정보 |
| data.templateInfo.item.list | Array | 아이템 목록 |
| data.templateInfo.item.list[].title | String | 아이템리스트 타이틀 |
| data.templateInfo.item.list[].description | String | 아이템리스트 설명 |
| data.templateInfo.item.summary | Object | 아이템 요약정보 |
| data.templateInfo.item.summary.title | String | 아이템 요약정보 타이틀 |
| data.templateInfo.item.summary.description | String | 아이템 요약정보 설명 |
| data.templateInfo.regId | String | 등록자 ID |
| data.templateInfo.templateExtra | String | 부가정보 |
| data.templateInfo.templateAd | String | 광고성메시지 |
| data.templateInfo.templatePreviewMessage | String | 템플릿 미리보기 메시지 |
| data.templateInfo.buttons | Array | 버튼 목록 |
| data.templateInfo.buttons[].name | String | 버튼이름 |
| data.templateInfo.buttons[].linkType | String | 버튼타입 |
| data.templateInfo.buttons[].linkMo | String | mobile 환경에서 버튼 클릭 시 이동할 url |
| data.templateInfo.buttons[].linkPc | String | pc 환경에서 버튼 클릭 시 이동할 url |
| data.templateInfo.buttons[].linkAnd | String | mobile android 환경에서 버튼 클릭 시 실행할 application custom scheme |
| data.templateInfo.buttons[].linkIos | String | mobile ios 환경에서 버튼 클릭 시 실행할 application custom scheme |
| data.templateInfo.buttons[].ordering | Integer | 버튼 노출 순서 |
| data.templateInfo.buttons[].varUrlYn | String | URL 가변 값 포함 여부 |
| data.templateInfo.buttons[].kkoBtnOutbrowserYn | String | 버튼 클릭시 url 이 열리는 브라우저 설정 |
| data.templateInfo.buttons[].chat_extra | String | 봇관련 정보(type:BC,BT) |
| data.templateInfo.buttons[].chat_event | String | 봇관련 이벤트정보(type:BT) |
| data.regDt | String | 등록일시 |
| data.updDt | String | 최종갱신일시 |
3) 요청 예시 (Sample)
Section titled “3) 요청 예시 (Sample)”Curl (이미지파일이 없는 경우)
Section titled “Curl (이미지파일이 없는 경우)”curl -X POST "https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/template/create" \ -H "accept: */*" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer {token}" \ -d '{ "kkoChId": "@myservice", "senderType": "S", "templateName": "환영인사 템플릿", "templateContent": "#{이름}님 환영합니다..", ... // 아래 템플릿유형별 JSON 예시 참조 }'Curl (이미지파일이 있는 경우)
Section titled “Curl (이미지파일이 있는 경우)”curl -X POST "https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/template/create" \ -H "accept: */*" \ -H "Content-Type: multipart/form-data" \ -H "Authorization: Bearer {token}" -F "reqBody={ "kkoChId": "@myservice", "senderType": "S", "templateName": "환영인사 템플릿", "templateContent": "#{이름}님 환영합니다..", ... // 아래 템플릿유형별 JSON 예시 참조 }" -F "image=@300x300.png;type=image/png" (알림톡 이미지 등록 시) -F "itemHighlightImage=@300x300.png;type=image/png" (아이템하이라이트 이미지 등록 시)템플릿유형별 JSON 예시
Section titled “템플릿유형별 JSON 예시”강조표기: 기본형(NONE), 이미지형(IMAGE, 이미지 파일 등록 필요)
Section titled “강조표기: 기본형(NONE), 이미지형(IMAGE, 이미지 파일 등록 필요)”{ "kkoChId": "@myservice", "templateName": "환영인사", "senderType":"S", "templateContent": "#{이름}님 환영합니다..", "templatePreviewMessage" : "미리보기 메시지", "categoryCode": "008002", "templateMessageType": "BA", "templateEmphasizeType": "NONE", "securityFlag": false, "buttons": [ { "name": "사용량 제한 이용안내", "linkType": "WL", "linkMo": "http://m.naver.com", "linkPc": "http://www.naver.com" } ]}강조표기: 강조표기형(TEXT)
Section titled “강조표기: 강조표기형(TEXT)”{ "kkoChId": "@myservice", "templateName": "환영인사", "senderType":"S", "templateContent": "#{이름}님 환영합니다..", "templatePreviewMessage" : "미리보기 메시지", "categoryCode": "008002", "templateMessageType": "BA", "templateEmphasizeType": "TEXT", "securityFlag": false, "templateTitle": "강조 제목", // 강조표기형 선택 시 필수 "templateSubtitle": "부제목", // 강조표기형 선택 시 필수 "buttons": [ { "name": "사용량 제한 이용안내", "linkType": "WL", "linkMo": "http://m.naver.com", "linkPc": "http://www.naver.com" } ]}강조표기: 아이템리스트형(ITEM_LIST)
Section titled “강조표기: 아이템리스트형(ITEM_LIST)”{ "kkoChId": "@myservice", "templateName": "환영인사", "senderType":"S", "templateContent": "#{이름}님 환영합니다..", "templatePreviewMessage" : "미리보기 메시지", "categoryCode": "008002", "templateMessageType": "BA", "templateEmphasizeType": "ITEM_LIST", "itemHeader": "헤더", // 아이템리스트형 선택 시 사용 가능 "itemHighlightTitle": "하이라이트제목", // 아이템리스트형 선택 시 사용 가능 "itemHighlightDescription": "설명", // 아이템리스트형 선택 시 사용 가능 "itemList": [ // 아이템리스트형 선택 시 필수 { "title": "제목", "description": "설명" }, { "title": "아이템", "description": "설명" } ], "itemSummaryTitle": "가격", // itemList 입력 시에만 사용 가능 "itemSummaryDescription": "1,000,000원", // itemList 입력 시에만 사용 가능 "securityFlag": false}강조표기: 기본형(NONE), 메세지 유형: 부가정보형(EX)
Section titled “강조표기: 기본형(NONE), 메세지 유형: 부가정보형(EX)”{ "kkoChId": "@myservice", "templateName": "환영인사", "senderType":"S", "templateContent": "#{이름}님 환영합니다..", "templatePreviewMessage" : "미리보기 메시지", "categoryCode": "008002", "templateMessageType": "EX", "templateEmphasizeType": "NONE", "securityFlag": false, "buttons": [ { "name": "사용량 제한 이용안내", "linkType": "WL", "linkMo": "http://m.naver.com", "linkPc": "http://www.naver.com" } ], "templateExtra": "부가정보 추가" // 부가정보형/복합형 선택 시 필수}강조표기: 기본형, 메세지 유형: 광고형(AD)
Section titled “강조표기: 기본형, 메세지 유형: 광고형(AD)”{ "kkoChId": "@myservice", "templateName": "환영인사", "senderType":"S", "templateContent": "#{이름}님 환영합니다..", "templatePreviewMessage" : "미리보기 메시지", "categoryCode": "008002", "templateMessageType": "AD", "templateAd": "채널 추가하고 이 채널의 광고와 마케팅 메시지를 카카오톡으로 받기", // 광고형/복합형 선택 시 해당 문구 고정 입력 "templateEmphasizeType": "NONE", "securityFlag": false, "buttons": [ { "name": "채널 추가", // 광고형/복합형 선택 시 버튼 리스트의 첫번째 버튼에 채널추가형 버튼 필수 "linkType": "AC" } ], "regId":"-"}강조표기: 기본형, 메세지 유형: 복합형(MI)
Section titled “강조표기: 기본형, 메세지 유형: 복합형(MI)”{ "kkoChId": "@myservice", "templateName": "환영인사", "senderType":"S", "templateContent": "#{이름}님 환영합니다..", "templatePreviewMessage" : "미리보기 메시지", "categoryCode": "008002", "templateMessageType": "MI", "templateEmphasizeType": "NONE", "securityFlag": false, "templateAd": "채널 추가하고 이 채널의 광고와 마케팅 메시지를 카카오톡으로 받기", // 광고형/복합형 선택 시 해당 문구 고정 입력 "templateExtra": "EX추가", // 부가정보형/복합형 선택 시 필수 "buttons": [ { "name": "채널 추가", // 광고형/복합형 선택 시 버튼 리스트의 첫번째 버튼에 채널추가형 버튼 필수 "linkType": "AC" } ], "regId":"-"}JSON Response
Section titled “JSON Response”{ "code": "10000", "message": "성공", "data": { "templateKey": "ABehB0XQMW", "templateCode": "ABehB0XQMW", "templateName": "환영인사 템플릿", "kkoChId": "@myservice", "templateInfo": { "senderKey": "12345566184a130f3b5...", "senderType": "S", "templateCode": "ABehB0XQMW", "templateName": "환영인사 템플릿", "templateContent": "#{이름}님 환영합니다..", "categoryCode": "008002", "templateMessageType": "BA", "templateEmphasizeType": "NONE", "securityFlag": false, "buttons": [ { "name": "사용량 제한 이용안내", "linkType": "WL", "linkMo": "http://m.example.com", "linkPc": "http://www.example.com" } ], "kkoTemplateCode": null, "templateStatusCode": "T", "block": false, "dormant": false, "createId": null, "createDate": "2025-07-12 13:18:29", "approvalDate": null, "comments": [], "templateKey": "ABehB0XQMW", "relay": "r02", "imageFileName": null, "itemHighlightImageFileName": null, "templateTitleFixYn": null, "item": {}, "regId": null }, "regDt": "2025-07-12T13:18:29", "updDt": "2025-07-12T13:18:29" }}20. 템플릿 수정
Section titled “20. 템플릿 수정”기존에 등록된 카카오톡 메시지 템플릿을 수정합니다.
📌 주의사항
Section titled “📌 주의사항”- 템플릿 상태가 등록완료(T), 반려(S) 인 경우에만 수정 가능합니다.
- 버튼은 전체 수정(버튼 추가 및 삭제) 가능합니다.
- 템플릿 코드는 수정할 수 없습니다.
- 카테고리 코드는 수정할 수 없습니다.
- 이미지 파일이 없는 경우 헤더의 Content-Type 은
application/json로 요청해야합니다. - 이미지 파일이 있는 경우 헤더의 Content-Type 은
multipart/form-data로 요청해야합니다.
1) 요청 (Request)
Section titled “1) 요청 (Request)”POST https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/template/update HTTP/1.1Headers
Section titled “Headers”| Name | Type | 필수 | 설명 |
|---|---|---|---|
| Authorization | String | ● | 사용자 인증 토큰 |
| Content-Type | String | ● | application/json 또는 multipart/form-data |
Request Body
Section titled “Request Body”| Name | Type | 필수 | 설명 |
|---|---|---|---|
| reqBody | Object | ● | 템플릿 생성 요청 정보 |
| itemHighlightImage | binary | - | 아이템 하이라이트 이미지 binary 데이터 |
| image | binary | - | 이미지 binary 데이터 |
reqBody 객체
Section titled “reqBody 객체”| Name | Type | 필수 | 설명 | 크기 |
|---|---|---|---|---|
| kkoChId | String | ● | 카카오채널 ID | 최대 61자 |
| kkoGrpId | String | - | 카카오그룹 ID | 최대 100자 |
| senderType | String | ● | 발신프로필타입, S : 카카오채널(디폴트) G : 그룹 | 1자 |
| templateCode | String | - | 템플릿 코드 (공백x) | 최대 50자 |
| templateName | String | ● | 템플릿명 | 최대 200자 |
| templateContent | String | ● | 템플릿내용 | 최대 1000자 |
| categoryCode | String | ● | 카테고리코드 | 최대 6자 |
| templateMessageType | String | ● | 메시지 유형 (BA: 기본형, EX: 부가 정보형, AD: 광고 추가형, MI: 복합형) | 2자 |
| templateExtra | String | - | 부가정보 | 최대 500자 |
| templateAd | String | - | 광고성 메시지 | 1000자(templateContent 글자수에 포함됨) |
| templateEmphasizeType | String | ● | 강조표기유형 (NONE: 선택안함, TEXT: 강조표기형, IMAGE: 이미지형, ITEM_LIST: 아이템리스트형) | 최대 9자 |
| itemHeader | String | - | 아이템리스트형 헤더정보 | 최대 16자 |
| itemHighlightTitle | String | - | 아이템하이라이트 타이틀(썸네일 이미지 사용 시 21자 제한) | 최대 30자 |
| itemHighlightDescription | String | - | 아이템하이라이트 설명(썸네일 이미지 사용 시 13자 제한, 타이틀 설정 시 필수) | 최대 19자 |
| itemList | Array | - | 아이템리스트, 최소 2개, 최대 10개까지 가능 | - |
| itemSummaryTitle | String | - | 아이템 요약 정보 타이틀 | 최대 6자 |
| itemSummaryDescription | String | - | 아이템 요약 정보 설명 | 최대 14자 |
| templateTitle | String | - | 강조표기핵심 정보 | - |
| templateSubtitle | String | - | 강조표기보조 문구 | - |
| securityFlag | Boolean | - | 보안 템플릿 여부 (보안 메시지 일 경우 true) | 최대 5자 |
| buttons | Array | - | 템플릿 버튼 목록 | 최대 5개 |
| templatePreviewMessage | String | - | 템플릿 미리보기 메시지 | 40자 |
| templateTitleFixYn | String | - | 템플릿 강조표기형 사용 시 본문에 등록된 가변영역외 독립적으로 사용할수 있는 구분값 (LG CNS 전용) | 1자 |
2) 응답 (Response)
Section titled “2) 응답 (Response)”Response Body
Section titled “Response Body”| Name | Type | 설명 |
|---|---|---|
| code | String | 결과 코드 |
| message | String | 결과 메시지 |
3) 요청 예시 (Sample)
Section titled “3) 요청 예시 (Sample)”Curl (이미지파일이 없는 경우)
Section titled “Curl (이미지파일이 없는 경우)”curl -X POST "https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/template/update" \ -H "accept: */*" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer {token}" \ -d '{ "kkoChId": "@myservice", "senderType": "S", "templateName": "환영인사 템플릿", "templateContent": "#{이름}님 환영합니다..", "categoryCode": "008002", "templateMessageType": "BA", "templateEmphasizeType": "NONE", "buttons": [ { "name": "사용량 제한 이용안내", "linkType": "WL", "linkMo": "http://m.example.com", "linkPc": "http://www.example.com" } ] }'Curl (이미지파일이 있는 경우)
Section titled “Curl (이미지파일이 있는 경우)”curl -X POST "https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/template/update" \ -H "accept: */*" \ -H "Content-Type: multipart/form-data" \ -H "Authorization: Bearer {token}" -F "reqBody={ "kkoChId": "@myservice", "senderType": "S", "templateName": "환영인사 템플릿", "templateContent": "#{이름}님 환영합니다..", "categoryCode": "008002", "templateMessageType": "BA", "templateEmphasizeType": "NONE", "buttons": [ { "name": "사용량 제한 이용안내", "linkType": "WL", "linkMo": "http://m.example.com", "linkPc": "http://www.example.com" } ] }" -F "image=@300x300.png;type=image/png" (알림톡 이미지 수정 시) -F "itemHighlightImage=@300x300.png;type=image/png" (아이템하이라이트 이미지 수정 시)JSON Response
Section titled “JSON Response”{ "code": "10000", "message": "성공"}21. 템플릿 조회
Section titled “21. 템플릿 조회”등록된 카카오톡 메시지 템플릿을 조회합니다.
📌 주의사항
Section titled “📌 주의사항”- 메시지허브 기준으로 조회됩니다.
- 승인/미승인 템플릿 모두 조회 가능합니다.
1) 요청 (Request)
Section titled “1) 요청 (Request)”POST https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/template/get HTTP/1.1Headers
Section titled “Headers”| Name | Type | 필수 | 설명 |
|---|---|---|---|
| Authorization | String | ● | 사용자 인증 토큰 |
| Content-Type | String | ● | application/json |
Request Body
Section titled “Request Body”| Name | Type | 필수 | 설명 |
|---|---|---|---|
| kkoChId | String | ● | 카카오 채널ID |
| kkoGrpId | String | - | 카카오 그룹ID |
| templateCode | String | ● | 템플릿 코드 (공백x) |
| senderKeyType | String | - | 채널ID 유형, S: 일반ID, G: 그룹ID, Default: S |
2) 응답 (Response)
Section titled “2) 응답 (Response)”Response Body
Section titled “Response Body”| Name | Type | 설명 |
|---|---|---|
| code | String | 결과 코드 |
| message | String | 결과 메시지 |
| data | Object | 결과 데이터 정보 |
| data.templateKey | String | 템플릿키(유일키) |
| data.templateCode | String | 템플릿코드 |
| data.templateName | String | 템플릿명 |
| data.kkoChId | String | 카카오채널 검색용ID |
| data.templateInfo | Object | 템플릿 상세정보 |
| data.templateInfo.senderKey | String | 발신프로필키 |
| data.templateInfo.senderType | String | 발신프로필타입(S:카카오채널, G:그룹) |
| data.templateInfo.templateCode | String | 템플릿코드 |
| data.templateInfo.kkoTemplateCode | String | 카카오 템플릿코드 |
| data.templateInfo.templateName | String | 템플릿명 |
| data.templateInfo.templateContent | String | 템플릿내용 |
| data.templateInfo.categoryCode | String | 카테고리코드 |
| data.templateInfo.templateMessageType | String | 메시지 유형(BA:기본형, EX:부가 정보형, AD:광고 추가형, MI:복합형) |
| data.templateInfo.templateEmphasizeType | String | 메시지 강조표기유형 (NONE: 선택안함, TEXT: 강조표기형, IMAGE: 이미지형, ITEM_LIST: 아이템리스트형) |
| data.templateInfo.templateTitle | String | 강조표기 핵심 정보 |
| data.templateInfo.templateSubtitle | String | 강조표기 보조 문구 |
| data.templateInfo.templateStatusCode | String | 템플릿상태(T:등록완료, R:검수요청완료, Q:카카오 검수중, A:템플릿 승인 완료, S:템플릿 반려) |
| data.templateInfo.block | boolean | 차단여부(true:차단, false:차단해제) |
| data.templateInfo.dormant | boolean | 휴면여부(true:휴면, false:휴면해제) |
| data.templateInfo.createId | String | 생성자 ID |
| data.templateInfo.createDate | String | 생성일자 |
| data.templateInfo.approvalDate | String | 검수일자 |
| data.templateInfo.comments | Array | 댓글리스트 |
| data.templateInfo.comments[].idx | String | 댓글 아이디 |
| data.templateInfo.comments[].createId | String | 작성자 |
| data.templateInfo.comments[].content | String | 내용 |
| data.templateInfo.comments[].createDate | String | 등록일 |
| data.templateInfo.comments[].status | String | 댓글 상태 (INQ:문의, APR:승인, REJ:반려, REP:답변) |
| data.templateInfo.templateKey | String | 템플릿키 |
| data.templateInfo.relay | String | 중계사 정보 |
| data.templateInfo.imageFileName | String | 이미지 파일명 |
| data.templateInfo.itemHighlightImageFileName | String | 아이템 하이라이트 이미지 파일명 |
| data.templateInfo.templateTitleFixYn | String | 템플릿 타이틀 고정 여부 |
| data.templateInfo.item | Object | 아이템 정보 |
| data.templateInfo.item.list | Array | 아이템 목록 |
| data.templateInfo.item.list[].title | String | 아이템리스트 타이틀 |
| data.templateInfo.item.list[].description | String | 아이템리스트 설명 |
| data.templateInfo.item.summary | Object | 아이템 요약정보 |
| data.templateInfo.item.summary.title | String | 아이템 요약정보 타이틀 |
| data.templateInfo.item.summary.description | String | 아이템 요약정보 설명 |
| data.templateInfo.regId | String | 등록자 ID |
| data.templateInfo.templateExtra | String | 부가정보 |
| data.templateInfo.templateAd | String | 광고성메시지 |
| data.templateInfo.templatePreviewMessage | String | 템플릿 미리보기 메시지 |
| data.templateInfo.buttons | Array | 버튼 목록 |
| data.templateInfo.buttons[].name | String | 버튼이름 |
| data.templateInfo.buttons[].linkType | String | 버튼타입 |
| data.templateInfo.buttons[].linkMo | String | mobile 환경에서 버튼 클릭 시 이동할 url |
| data.templateInfo.buttons[].linkPc | String | pc 환경에서 버튼 클릭 시 이동할 url |
| data.templateInfo.buttons[].linkAnd | String | mobile android 환경에서 버튼 클릭 시 실행할 application custom scheme |
| data.templateInfo.buttons[].linkIos | String | mobile ios 환경에서 버튼 클릭 시 실행할 application custom scheme |
| data.templateInfo.buttons[].ordering | Integer | 버튼 노출 순서 |
| data.templateInfo.buttons[].varUrlYn | String | URL 가변 값 포함 여부 |
| data.templateInfo.buttons[].kkoBtnOutbrowserYn | String | 버튼 클릭시 url 이 열리는 브라우저 설정 |
| data.templateInfo.buttons[].chat_extra | String | 봇관련 정보(type:BC,BT) |
| data.templateInfo.buttons[].chat_event | String | 봇관련 이벤트정보(type:BT) |
| data.regDt | String | 등록일시 |
| data.updDt | String | 최종갱신일시 |
3) 요청 예시 (Sample)
Section titled “3) 요청 예시 (Sample)”curl -X POST "https://mnt-api.msghub.uplus.co.kr/kko/v2/channel/template/get" \ -H "accept: */*" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer {token}" \ -d '{ "kkoChId": "@myservice", "templateCode": "ABcD82uK8x", "senderKeyType": "S" }'JSON Response
Section titled “JSON Response”{ "code": "10000", "message": "성공", "data": { "templateKey": "ABcD82uK8x", "templateCode": "ABcD82uK8x", "templateName": "고고모바일 통신사 요금제 개통알림", "kkoChId": "@gogomobile", "templateInfo": { "senderKey": null, "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" }}Appendix
Section titled “Appendix”데이터 모델
Section titled “데이터 모델”| 링크타입 | 설명 |
|---|---|
| WL | 웹링크 |
| AL | 앱링크 |
| DS | 배송조회 |
| BK | 봇키워드 |
| MD | 메시지전달 |
| BC | 상담톡 전환 |
| BT | 봇전환 |
| AC | 채널추가 |
| BF | 비즈니스폼 |