콘텐츠로 건너뛰기
U+ 메시지 허브
메시지 허브 사용자 가이드

  • 채널 소개
  • 기능
  • 요금제
  • 고객센터
    • FAQ
    • 공지사항
    • 자료실
  • 사용자 가이드
  • CONSOLE
메시지허브 홈
메시지허브 홈
U+ 메시지 허브
메시지 허브 사용자 가이드

Quick Guide

  • 메시지허브 가입부터 문자 발송하기
  • 발신번호 사전등록 한방에 해결하기
  • 통합발송 사용하기

서비스 개요

  • 서비스 개요

계정 안내

  • 가입해지
  • 회원가입
  • 로그인

관리자 콘솔

  • 개요 및 주요기능
  • 대시보드
  • 사용자
  • 프로젝트
  • 발신정보
  • 발신제한
  • 이용 현황
  • 정산(선불요금제)
  • 정산 (후불요금제)
  • 주소록
  • 통계
  • 알람

사용자 콘솔

  • 개요 및 주요 기능
  • 대시보드
  • 발송 > 통합발송
  • 발송 > 문자
  • 발송 > RCS
  • 발송 > 카카오톡
  • 발송 > PUSH
  • 조회
  • 템플릿 > 통합발송
  • 템플릿 > 문자
  • 템플릿 > RCS
  • 템플릿 > 카카오톡
  • 템플릿 > PUSH
  • 통계
  • LAB

API 가이드

  • 공통
    • 개요 및 주요기능
    • 인증
    • 결과 코드
  • 메시지 발송
    • 월별 발송 성공 통계 데이터 조회
    • 스키마 정보
    • 통합메시지
    • RCS
    • 알림톡/친구톡
    • 예약 발송
    • PUSH
    • 문자(SMS/LMS/MMS)
    • 리포트 처리
    • 이미지 사전등록
    • MO
    • 080 수신거부번호
    • 반응형URL & 통계
  • 채널 관리
    • 통합발송 연동관리
    • RCS 연동 관리
    • 카카오 연동 관리

Push 앱개발 가이드

  • iOS 개발가이드
  • Android 개발가이드

Agent 가이드

  • 허브 에이전트란?

서비스 정보

  • 스키마 정보 (구)
  • 서비스 이용약관
    • 이용약관 2025년1월1일 (주요변경)
    • 이용약관 2025년1월1일
  • 메시지허브 홈
  • 사용자 가이드
  • API 가이드
  • 채널 관리
  • RCS 연동 관리

RCS 연동 관리

RBC에 등록되어 있는 브랜드를 연동하기 위해서는 RCS Biz Center 브랜드의 운영관리 탭의 권한관리에서 엘지유플러스 대행사 권한을 추가합니다.

아래와 같이 RCS Biz Center > 내정보 관리 에서 아래와 같이 메시지허브 연동 아이피를 추가해 주어야 합니다.

브랜드 #

브랜드 리스트 조회 #

브랜드 리스트를 조회합니다.

Request

URL

GET /rcs/v1/brand HTTP/1.1
Authorization: Bearer {token}
apiId: {apiId}
apiSecret: {apiSecret}
Host: mnt-api.msghub.uplus.co.kr

Header

NameTypeRequiredDescription
AuthorizationStringtrue사용자 인증 토큰
apiIdStringtrueRCS Biz Center 가입시 등록한 ID
apiSecretStringtrueRCS Biz Center 가입시 발급된 clientSecret

Path Parameter

NameTypeRequiredDescription
offsetStringfalse시작 offset 번호(default: 0)
limitStringfalse조회 최대 건수(default: 100, maximum: 1000)

Response

Sample

Curl

curl -X GET "https://mnt-api.msghub.uplus.co.kr/rcs/v1/brand?offset=0&limit=100"
-H  "accept: */*"
-H  "apiId: myMemberId"
-H  "apiSecret: SK.AbCdEfg1234500"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiYWNjZXNzVXJsIjoi.."

Response

{
 "code": "10000",
 "message": "성공",
 "data": [
   {
     "brandId": "BR.abcdefghij",
     "name": "더미브랜드이름",
     "approvalStatus": "승인대기",
     "chatbotDate": "2021-08-09T10:05:30.000+09",
     "messagebaseDate": "2021-08-09T10:05:30.000+09",
     "regDt": "2021-08-09T10:05:30.000+09",
     "updDt": "2021-08-09T10:05:30.000+09",
     "approvalDt": "2021-08-09T10:05:30.000+09",
     "mediaUrl": [
       {
         "fileId": "LT-BR.abcdefghij",
         "fileName": "file.png",
         "url": "https://",
         "typeName": "profile"
       },
       {
         "fileId": "LT-BR.abcdefghij",
         "fileName": "file.png",
         "url": "https://",
         "typeName": "profile"
       }
     ]
   },
  ...,
 ]
}

참고

결과 코드 참고

브랜드 등록 요청 #

기업관리자 계정을 이용하여 브랜드 등록 승인을 요청합니다.

Request

URL

POST /rcs/v1/brand HTTP/1.1
Authorization: Bearer {token}
apiId: {apiId}
apiSecret: {apiSecret}
Host: mnt-api.msghub.uplus.co.kr

Header

NameTypeRequiredDescription
AuthorizationStringtrue사용자 인증 토큰
apiIdStringtrueRCS Biz Center 가입시 등록한 ID
apiSecretStringtrueRCS Biz Center 가입시 발급된 clientSecret

Request body

NameTypeRequiredDescription
regBrandBrandPostRegfalse브랜드 등록,수정 정보
mainMdnStringfalse브랜드 대표 발신번호(*입력된 번호는 chatbots에 포함되어 있어야함)
profileImgFilePathStringfalse업로드된 브랜드 프로필 이미지경로
bgImgFilePathStringfalse업로드된 브랜드 백그라운드 이미지경로
certiFilePathStringfalse업로드된 통신서비스이용증명원 파일경로
chatbotsList<ChatbotPostReg>false등록할 챗봇(발신번호) 정보(최대 1000개)

BrandPostReg

NameTypeRequiredDescription
nameStringtrue브랜드 이름
descriptionStringtrue브랜드 설명
telStringfalse브랜드 전화번호
menusList<Menus>false랜드 홈에 표시 가능한 버튼 정보
categoryIdStringfalse카테고리ID
subCategoryIdStringfalse하위카테고리ID
categoryOptStringfalse검색용 키워드
zipCodeStringfalse우편번호
roadAddressStringfalse도로명주소
detailAddressStringfalse상세주소
emailStringfalse이메일주소
webSiteUrlStringfalse홈페이지 주소

Menus

NameTypeRequiredDescription
buttonTypeStringtrue챗봇 버튼타입
weblinkStringtruebuttonType call 을 제외한 모든 버튼은 Web URL을 입력해야함 http:// 또는 https:// 로 시작
applinkAppLinkfalseAPP Link의 패키지 Name, Action, URL 정보
applink.packageNameStringfalseApp 실행을 위한 package name
applink.actionStringfalseApp 실행을 위한 Action
applink.uriStringfalseApp 실행을 위한 URI

참고

AppLink와 WebLink가 모두 설정된 경우 단말에 app 이 설치되어 있으면 app을 실행하고 설치되지 않은 경우 weblink로 연결

ChatbotPostReg

NameTypeRequiredDescription
mdnStringtrue등록할 발신번호 *국가번호는 생략, 휴대전화 번호는 등록 불가
rcsReplyStringfalse0=SMS MO 수신, 1=RCS Postback 수신
subTitleStringfalse챗봇(대화방) 이름
serviceStringfalseA2P/CHAT 서비스 유형
displayStringfalse챗봇 전시 설정값. 하단 참고

참고

챗봇 전시 설정값.

  • 설정하지 않을 경우 기본 〈01’로 설정. 현재 〈01〉, 〈00〉 설정만 가능.
  • 11 : 브랜드채널 노출,브랜드검색 허용,브랜드홈 전시
  • 10 : 브랜드채널 노출,브랜드검색 허용,브랜드홈 비전시
  • 01 : 브랜드채널 노출,브랜드검색 불허,브랜드홈 전시
  • 00 : 브랜드채널 노출,브랜드검색 불허,브랜드홈 비전시

Response

NameTypeDescription
codeString결과 코드
messageString결과 코드 설명
dataObject결과 데이터 목록

Sample

Curl

curl -X POST "https://mnt-api.msghub.uplus.co.kr/rcs/v1/brand"
 -H  "accept: */*"
 -H  "apiId: myMemberId"
 -H  "apiSecret: SK.AbCdEfg1234500"
 -H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiYWNjZXNzVXJsIjoi.."
 -H  "Content-Type: application/json"
 -d '
   [
   {
       "regBrand": {
           "name": "더미브랜드이름",
           "description": "더미브랜드설명",
           "tel": "0212341234",
           "menus": [
               {
                   "buttonType": "call",
                   "weblink": "http://"
               }
           ],
           "categoryId": "FIN",
           "subCategoryId": "FIN001",
           "categoryOpt": "검색키워드",
           "zipCode": "12345",
           "roadAddress": "도로명주소",
           "detailAddress": "상세주소",
           "email": "test@test.co.kr",
           "webSiteUrl": "http://"
       },
       "mainMdn": "15441544",
       "profileImgFilePath": "/efs/file/console/1234/12/12/12/img.jpg",
       "bgImgFilePath": "/efs/file/console/1234/12/12/12/img.jpg",
       "certiFilePath": "/efs/file/console/1234/12/12/12/img.jpg",
       "chatbots": [
           {
               "mdn": "15441544",
               "rcsReply": "1",
               "subTitle": "챗봇이름",
               "service": "a2p",
               "display": "01"
           }
       ]
   }
]'

Response

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

참고

결과 코드 참고

브랜드 상세 조회 #

브랜드 상세를 조회합니다.

Request

URL

GET /rcs/v1/brand/{brandId} HTTP/1.1
Authorization: Bearer {token}
apiId: {apiId}
apiSecret: {apiSecret}
Host: mnt-api.msghub.uplus.co.kr

Header

NameTypeRequiredDescription
AuthorizationStringtrue사용자 인증 토큰
apiIdStringtrueRCS Biz Center 가입시 등록한 ID
apiSecretStringtrueRCS Biz Center 가입시 발급된 clientSecret

Path Parameter

NameTypeRequiredDescription
brandIdStringfalse브랜드 정보 접근시 사용되는 브랜드ID

Response

▶ Sample

Curl

curl -X GET "https://mnt-api.msghub.uplus.co.kr/rcs/v1/brand/string"
-H  "accept: */*"
-H  "apiId: myMemberId"
-H  "apiSecret: SK.AbCdEfg1234500"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiYWNjZXNzVXJsIjoi.."

Response

{
  "code": "10000",
  "message": "성공",
  "data": [
      {
      "brandId": "BR.abcdefghij",
      "name": "더미브랜드이름",
      "brandKey": "BK.BraNdKey1234500",
      "status": "승인",
      "chatbotDate": "2021-07-20T16:59:19.000+09",
      "messagebaseDate": "2021-06-09T17:00:07.000+09",
      "registerDate": "2021-06-09T14:01:06.000+09",
      "updateDate": "2021-06-09T14:01:06.000+09",
      "approvalDate": "2021-06-09T17:00:07.000+09",
      "mediaUrl": [
          {
          "fileId": "LT-BR.abcdefghij",
          "fileName": "file.png",
          "url": "https://",
          "typeName": "icon"
          },
          {
          "fileId": "LT-BR.abcdefghij",
          "fileName": "file.png",
          "url": "https://",
          "typeName": "icon"
          }
      ],
      "menus": [
          {
          "buttonType": "call",
          "weblink": "https://"
          }
      ],
      "description": "더미브랜드설명",
      "tel": "0123456789",
      "categoryId": "FOD",
      "categoryName": "식품",
      "subCategoryId": "FOD004",
      "subCategoryName": "주점",
      "categoryOpt": "검색키워드",
      "zipCode": "12345",
      "roadAddress": "도로명주소",
      "detailAddress": "상세주소",
      "email": "user@example.com",
      "webSiteUrl": "https://",
      "approvalReason": "승인완료"
      }
  ]
}

참고

 결과 코드 참고 

브랜드 수정 요청 #

브랜드를 수정합니다.

▶ Request

URL

PUT /rcs/v1/brand/{brandId} HTTP/1.1
Authorization: Bearer {token}
apiId: {apiId}
apiSecret: {apiSecret}
Host: mnt-api.msghub.uplus.co.kr

Header

NameTypeRequiredDescription
AuthorizationStringtrue사용자 인증 토큰
apiIdStringtrueRCS Biz Center 가입시 등록한 ID
apiSecretStringtrueRCS Biz Center 가입시 발급된 clientSecret

Path Parameter

NameTypeRequiredDescription
brandIdStringfalse브랜드 정보 접근시 사용되는 브랜드ID

Request body

NameTypeRequiredDescription
regBrandBrandPostRegfalse브랜드 등록,수정 정보
mainMdnStringfalse브랜드 대표 발신번호(*입력된 번호는 chatbots에 포함되어 있어야함)
profileImgFilePathStringfalse업로드된 브랜드 프로필 이미지경로
bgImgFilePathStringfalse업로드된 브랜드 백그라운드 이미지경로

BrandPostReg

NameTypeRequiredDescription
nameStringtrue브랜드 이름
descriptionStringtrue브랜드 설명
telStringfalse브랜드 전화번호
menusList<Menus>false랜드 홈에 표시 가능한 버튼 정보
categoryIdStringfalse카테고리ID
subCategoryIdStringfalse하위카테고리ID
categoryOptStringfalse검색용 키워드
zipCodeStringfalse우편번호
roadAddressStringfalse도로명주소
detailAddressStringfalse상세주소
emailStringfalse이메일주소
webSiteUrlStringfalse홈페이지 주소

Menus

NameTypeRequiredDescription
buttonTypeStringtrue챗봇 버튼타입
weblinkStringtruebuttonType call 을 제외한 모든 버튼은 Web URL을 입력해야함 http:// 또는 https:// 로 시작
applinkAppLinkfalseAPP Link의 패키지 Name, Action, URL 정보
applink.packageNameStringfalseApp 실행을 위한 package name
applink.actionStringfalseApp 실행을 위한 Action
applink.uriStringfalseApp 실행을 위한 URI

참고

AppLink와 WebLink가 모두 설정된 경우 단말에 app 이 설치되어 있으면 app을 실행하고 설치되지 않은 경우 weblink로 연결

▶ Response

▶ Sample

Curl

curl -X PUT "https://mnt-api.msghub.uplus.co.kr/rcs/v1/brand/string"
-H  "accept: */*"
-H  "apiId: myMemberId"
-H  "apiSecret: SK.AbCdEfg1234500"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiYWNjZXNzVXJsIjoi.."
-H  "Content-Type: application/json"
-d '
{
  "regBrand": {
      "name": "더미브랜드이름",
      "description": "더미브랜드설명",
      "tel": "10006900",
      "menus": [
          {
              "buttonType": "call",
              "weblink": "http://"
          }
      ],
      "categoryId": "FIN",
      "subCategoryId": "FIN001",
      "categoryOpt": "검색키워드",
      "zipCode": "12345",
      "roadAddress": "도로명주소",
      "detailAddress": "detailAddress",
      "email": "test@test.co.kr",
      "webSiteUrl": "http://"
  },
  "mainMdn": "15441544",
  "profileImgFilePath": "이미지경로.jpg",
  "bgImgFilePath": "이미지경로.jpg"
}'

Response

{
  "code": "10000",
  "message": "성공",
  "data": [
  {
    "brandId": "BR.abcdefghij",
    "name": "FAN",
    "brandKey": "BK.BraNdKey1234500",
    "registerDate": "2020-03-12T06:22:55.418+09",
    "approvalDate": "2020-03-12T06:22:55.418+09",
    "updateDate": "2020-03-12T06:22:55.418+09",
    "status": "승인대기",
    "mediaUrl": [
      {
        "fileId": "LT-BR.abcdefghij",
        "url": "https://",
        "typeName": "icon",
        "fileName": "file.png"
      }
    ],
    "chatbotDate": "2020-03-12T06:22:55.418+09",
    "messagebaseDate": "2020-03-12T06:22:55.418+09",
    "description": "설명",
    "tel": "0212341234",
    "menus": [
      {
        "buttonType": "call",
        "applink": {
          "packageName": "com.android.mobile.cs",
          "action": "android.intent.action.VIEW",
          "uri": "abc://gizmos/foo/bar"
        },
        "weblink": "https://"
      }
    ],
    "categoryId": "FIN",
    "categoryName": "금융",
    "subCategoryId": "FIN001",
    "subCategoryName": "은행",
    "categoryOpt": "검색키워드",
    "zipCode": "12345",
    "roadAddress": "도로명주소",
    "detailAddress": "상세주소",
    "email": "user@example.com",
    "webSiteUrl": "https://",
    "approvalReason": "승인완료"
  }
]
}

참고

결과 코드 참고

브랜드 삭제 요청 #

브랜드를 삭제합니다.

승인 후 사용 중인 브랜드의 경우 브랜드에 등록된 발신번호, 템플릿을 먼저 삭제한 후 브랜드를 삭제해야 처리됩니다.

▶ Request

URL

DELETE /rcs/v1/brand/{brandId} HTTP/1.1
Authorization: Bearer {token}
apiId: {apiId}
apiSecret: {apiSecret}
Host: mnt-api.msghub.uplus.co.kr

Header

NameTypeRequiredDescription
AuthorizationStringtrue사용자 인증 토큰
apiIdStringtrueRCS Biz Center 가입시 등록한 ID
apiSecretStringtrueRCS Biz Center 가입시 발급된 clientSecret

Path Parameter

NameTypeRequiredDescription
brandIdStringfalse브랜드 정보 접근시 사용되는 브랜드ID

▶ Response

NameTypeDescription
codeString결과 코드
messageString결과 코드 설명
dataObject결과 데이터

▶ Sample

Curl

curl -X DELETE "https://mnt-api.msghub.uplus.co.kr/rcs/v1/brand/string"
-H  "accept: */*"
-H  "apiId: myMemberId"
-H  "apiSecret: SK.AbCdEfg1234500"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiYWNjZXNzVXJsIjoi.."

Response

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

참고

결과 코드 참고

챗봇 #

챗봇 리스트 조회 #

브랜드 내에 등록된 챗봇 리스트 조회합니다.

▶ Request

URL

GET /rcs/v1/brand/{brandId}/chatbot HTTP/1.1
Authorization: Bearer {token}
apiId: {apiId}
apiSecret: {apiSecret}
brandKey: {brandKey}
Host: mnt-api.msghub.uplus.co.kr

Header

NameTypeRequiredDescription
AuthorizationStringtrue사용자 인증 토큰
apiIdStringtrueRCS Biz Center 가입시 등록한 ID
apiSecretStringtrueRCS Biz Center 가입시 발급된 clientSecret
brandKeyStringtrueRCS Biz Center에서 브랜드 등록 시 자동 생성되는 Key

Path Parameter

NameTypeRequiredDescription
brandIdStringtrue브랜드 정보 접근시 사용되는 브랜드ID
offsetStringfalse시작 offset 번호(default: 0)
limitStringfalse조회 최대 건수(default: 100, maximum: 1000)

▶ Response

NameTypeDescription
codeString결과 코드
messageString결과 코드 설명
dataList결과 데이터 목록
data.chatbotIdString챗봇 ID
data.brandIdString브랜드 ID
data.isMainNumString대표번호 여부를 표시
data.subNumString발신번호, chatbotId와 동일
data.subTitleString챗봇(대화방) 이름
data.serviceStringA2P/CHAT 서비스 유형
data.displayString챗봇 전시 설정값. 하단 참고
data.approvalResultString승인 결과
data.registerDateString등록 일시
data.approvalDateString승인 일시
data.updateDateString수정 일시
data.registerIdString등록 아이디
data.updateIdString수정 아이디

참고

챗봇 전시 설정값.

  • 설정하지 않을 경우 기본 〈01’로 설정. 현재 〈01〉, 〈00〉 설정만 가능.
  • 11 : 브랜드채널 노출,브랜드검색 허용,브랜드홈 전시
  • 10 : 브랜드채널 노출,브랜드검색 허용,브랜드홈 비전시
  • 01 : 브랜드채널 노출,브랜드검색 불허,브랜드홈 전시
  • 00 : 브랜드채널 노출,브랜드검색 불허,브랜드홈 비전시

▶ Sample

Curl

curl -X GET "https://mnt-api.msghub.uplus.co.kr/rcs/v1/brand/string/chatbot?offset=0&limit=100"
-H  "accept: */*"
-H  "apiId: myMemberId"
-H  "apiSecret: SK.AbCdEfg1234500"
-H  "brandKey: BK.BraNdKey1234500"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiYWNjZXNzVXJsIjoi.."

Response

{
  "code": "10000",
  "message": "성공",
  "data": {
      "result": [
      {
          "chatbotId": "0123456789",
          "brandId": "BR.abcdefghij",
          "isMainNum": "false",
          "subNum": "0123456789",
          "subTitle": "챗봇등록 제목",
          "service": "a2p",
          "display": "01",
          "approvalResult": "승인대기",
          "registerDate": "2021-07-20T16:59:19.000+09",
          "approvalDate": "2021-07-20T16:59:19.000+09",
          "updateDate": "2021-07-20T16:59:19.000+09",
          "registerId": "uplus_test",
          "updateId": "uplus_test"
      },
      ...
      ]
  }
  }

참고

 결과 코드 참고 

챗봇 등록 요청 #

지정된 브랜드에 챗봇(발신번호)을 등록합니다. 챗봇 등록시 브랜드포털 관리자의 승인 후 사용이 가능합니다.

▶ Request

URL

POST /rcs/v1/brand/{brandId}/chatbot HTTP/1.1
Authorization: Bearer {token}
Host: mnt-api.msghub.uplus.co.kr

Header

NameTypeRequiredDescription
AuthorizationStringtrue사용자 인증 토큰

Path Parameter

NameTypeRequiredDescription
brandIdStringtrue브랜드 정보 접근시 사용되는 브랜드ID

Request body

NameTypeRequiredDescription
subNumCertificateStringfalse업로드된 통신서비스이용증명원 파일경로
chatbotsList<ChatbotPostReg>false챗봇 정보 목록

ChatbotPostReg

NameTypeRequiredDescription
mdnStringtrue등록할 발신번호 *국가번호는 생략, 휴대전화 번호는 등록 불가
rcsReplyStringtrue0=SMS MO 수신, 1=RCS Postback 수신
subTitleStringtrue챗봇(대화방) 이름
serviceStringtrueA2P/CHAT 서비스 유형
displayStringfalse챗봇 전시 설정값. 하단 참고

참고

챗봇 전시 설정값.

  • 설정하지 않을 경우 기본 〈01’로 설정. 현재 〈01〉, 〈00〉 설정만 가능.
  • 11 : 브랜드채널 노출,브랜드검색 허용,브랜드홈 전시
  • 10 : 브랜드채널 노출,브랜드검색 허용,브랜드홈 비전시
  • 01 : 브랜드채널 노출,브랜드검색 불허,브랜드홈 전시
  • 00 : 브랜드채널 노출,브랜드검색 불허,브랜드홈 비전시

▶ Response

NameTypeDescription
codeString결과 코드
messageString결과 코드 설명
dataList결과 데이터 목록
data.groupIdString그룹ID
data.chatbotIdString챗봇ID
data.brandIdString브랜드ID
data.subNumString발신번호,chatbotId와 동일
data.isMainNumBoolean대표번호 여부
data.subTitleString챗봇(대화방) 이름
data.serviceStringA2P/CHAT 서비스 유형
data.displayString전시 설정값
data.approvalResultString승인 상태
data.registerDateString챗봇 등록일시
data.approvalDateString챗봇 승인일시
data.updateDateString챗봇 수정일시
data.registerIdString챗봇 등록 계정 ID
data.updateIdString챗봇 수정 계정 ID

▶ Sample

Curl

curl -X POST "https://mnt-api.msghub.uplus.co.kr/rcs/v1/brand/string/chatbot"
-H  "accept: */*"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiYWNjZXNzVXJsIjoi.."
-H  "Content-Type: application/json"
-d '
{
  "subNumCertificate": "/efs/file/rcs/2021/08/04//ABCDEFG11.jpg",
  "chatbots": [
      {
          "mdn": "12341234",
          "rcsReply": "1",
          "subTitle": "챗봇이름",
          "service": "a2p",
          "display": "01"
      }
  ]
}'

Response

{
  "code": "10000",
  "message": "성공",
  "data": [
        {
          "groupId": "group_test",
          "chatbotId": "0212341234",
          "brandId": "BR.abcdefghij",
          "subNum": "0256785678",
          "isMainNum": true,
          "subTitle": "11111",
          "service": "a2p",
          "display": "11",
          "approvalResult": "승인대기",
          "registerDate": "2020-03-12T06:22:55.418+09",
          "approvalDate": null,
          "updateDate": "2020-03-12T06:22:55.418+09",
          "registerId": "uplus_test",
          "updateId": "uplus_test"
        }
  ]
}

참고

 결과 코드 참고 

챗봇 다건 등록 요청 #

지정된 브랜드에 챗봇(발신번호)을 다건 등록합니다. 챗봇 등록시 브랜드포털 관리자의 승인 후 사용이 가능합니다.

▶ Request

URL

POST /rcs/v1/brand/{brandId}/chatbots HTTP/1.1
Authorization: Bearer {token}
Host: api.msghub.uplus.co.kr

Header

NameTypeRequiredDescription
AuthorizationStringtrue사용자 인증 토큰

Path Parameter

NameTypeRequiredDescription
brandIdStringtrue브랜드 정보 접근시 사용되는 브랜드ID

Request body

NameTypeRequiredDescription
subNumCertificateStringfalse업로드된 통신서비스이용증명원 파일경로
chatbotsList<ChatbotPostReg>false챗봇 정보 목록

ChatbotPostReg

NameTypeRequiredDescription
mdnStringtrue등록할 발신번호 *국가번호는 생략, 휴대전화 번호는 등록 불가
rcsReplyStringtrue0=SMS MO 수신, 1=RCS Postback 수신
subTitleStringtrue챗봇(대화방) 이름
serviceStringtrueA2P/CHAT 서비스 유형
displayStringfalse챗봇 전시 설정값. 하단 참고
projectIdsListfalse프로젝트 ID

참고

챗봇 전시 설정값.

  • 설정하지 않을 경우 기본 〈01’로 설정. 현재 〈01〉, 〈00〉 설정만 가능.
  • 11 : 브랜드채널 노출,브랜드검색 허용,브랜드홈 전시
  • 10 : 브랜드채널 노출,브랜드검색 허용,브랜드홈 비전시
  • 01 : 브랜드채널 노출,브랜드검색 불허,브랜드홈 전시
  • 00 : 브랜드채널 노출,브랜드검색 불허,브랜드홈 비전시

▶  Response

NameTypeDescription
codeString결과 코드
messageString결과 코드 설명
dataList결과 데이터 목록
data.groupIdString그룹ID
data.chatbotIdString챗봇ID
data.brandIdString브랜드ID
data.subNumString발신번호,chatbotId와 동일
data.isMainNumBoolean대표번호 여부
data.subTitleString챗봇(대화방) 이름
data.serviceStringA2P/CHAT 서비스 유형
data.displayString전시 설정값
data.approvalResultString승인 상태
data.registerDateString챗봇 등록일시
data.approvalDateString챗봇 승인일시
data.updateDateString챗봇 수정일시
data.registerIdString챗봇 등록 계정 ID
data.updateIdString챗봇 수정 계정 ID

▶  Sample

Curl

curl -X POST "https://api.msghub.uplus.co.kr/rcs/v1/brand/string/chatbots"
-H  "accept: */*"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiYWNjZXNzVXJsIjoi.."
-H  "Content-Type: application/json"
-d '
{
  "subNumCertificate": "/efs/file/rcs/2021/08/04//ABCDEFG11.jpg",
  "chatbots": [
      {
          "mdn": "12341234",
          "rcsReply": "1",
          "subTitle": "챗봇이름",
          "service": "a2p",
          "display": "01",
          "projectIds": [
           "PJTyqdKSu8", "PJTTKR9Alb"
           ]
      }
  ]
}'

Response

{
  "code": "10000",
  "message": "성공",
  "data": [
        {
          "groupId": "group_test",
          "chatbotId": "0212341234",
          "brandId": "BR.abcdefghij",
          "subNum": "0256785678",
          "isMainNum": true,
          "subTitle": "11111",
          "service": "a2p",
          "display": "11",
          "approvalResult": "승인대기",
          "registerDate": "2020-03-12T06:22:55.418+09",
          "approvalDate": null,
          "updateDate": "2020-03-12T06:22:55.418+09",
          "registerId": "uplus_test",
          "updateId": "uplus_test"
        }
  ]
}

참고

 결과 코드 참고 

챗봇 상세 조회 #

브랜드 내에 등록된 챗봇 상세 조회합니다.

▶ Request

URL

GET ​/rcs​/v1​/brand​/{brandId}​/chatbot​/{chatbotId} HTTP/1.1
Authorization: Bearer {token}
apiId: {apiId}
apiSecret: {apiSecret}
brandKey: {brandKey}
Host: mnt-api.msghub.uplus.co.kr

Header

NameTypeRequiredDescription
AuthorizationStringtrue사용자 인증 토큰
apiIdStringtrueRCS Biz Center 가입시 등록한 ID
apiSecretStringtrueRCS Biz Center 가입시 발급된 clientSecret
brandKeyStringtrueRCS Biz Center에서 브랜드 등록 시 자동 생성되는 Key

Path Parameter

NameTypeRequiredDescription
brandIdStringtrue브랜드 정보 접근시 사용되는 브랜드ID
chatbotIdStringtrue챗봇 ID

▶ Response

NameTypeDescription
codeString결과 코드
messageString결과 코드 설명
dataList결과 데이터 목록
data.groupIdString그룹 ID
data.chatbotIdString챗봇 ID
data.brandIdString브랜드 ID
data.subNumString발신번호
data.subTitleString챗봇(대화방) 이름
data.serviceStringA2P/CHAT 서비스 유형
data.displayString챗봇 전시 설정값. 하단 참고
data.approvalResultString승인 결과
data.registerDateString등록 일시
data.approvalDateString승인 일시
data.updateDateString수정 일시
data.registerIdString등록 아이디
data.updateIdString수정 아이디
data.approvalReasonString승인 사유
data.statusString챗봇 상태
data.rcsReplyString0=SMS MO 수신, 1=RCS Postback 수신
data.searchWeightString검색 우선 순위, 기본값(512)
data.webhookStringwebhook URLservice가 〈chat〉 인 경우 필수
data.botTcPageString이용약관페이지 URL
data.mediaUrlList<MediaUrl>미디어 URL

참고

챗봇 전시 설정값.

  • 설정하지 않을 경우 기본 〈01’로 설정. 현재 〈01〉, 〈00〉 설정만 가능.
  • 11 : 브랜드채널 노출,브랜드검색 허용,브랜드홈 전시
  • 10 : 브랜드채널 노출,브랜드검색 허용,브랜드홈 비전시
  • 01 : 브랜드채널 노출,브랜드검색 불허,브랜드홈 전시
  • 00 : 브랜드채널 노출,브랜드검색 불허,브랜드홈 비전시

MediaUrl

NameTypeDescription
fileIdString파일 ID
urlString파일 URL
typeNameString이미지의 사용 유형
fileNameString등록한 파일의 이름

참고

이미지 사용 유형

  • icon – 템플릿 양식 아이콘 이미지
  • background – 브랜드 백그라운드 이미지
  • profile – 브랜드 프로필 이미지

▶ Sample

Curl

curl -X GET "https://mnt-api.msghub.uplus.co.kr/rcs/v1/brand/string/chatbot/string"
-H  "accept: */*"
-H  "apiId: myMemberId"
-H  "apiSecret: SK.AbCdEfg1234500"
-H  "brandKey: BK.BraNdKey1234500"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiYWNjZXNzVXJsIjoi.."

Response

{
  "code": "10000",
  "message": "성공",
  "data": [
      {
      "groupId": null,
      "chatbotId": "01012341234",
      "brandId": "BR.abcdefghij",
      "subNum": "01012341234",
      "isMainNum": "true",
      "subTitle": "브랜드 이름",
      "service": "a2p",
      "display": "00",
      "approvalResult": "승인",
      "registerDate": "2021-06-09T14:01:06.000+09",
      "approvalDate": "2021-06-09T17:00:07.000+09",
      "updateDate": "2021-06-09T14:01:06.000+09",
      "registerId": "myMemberId",
      "updateId": null,
      "mediaUrl": [
          {
          "fileId": "LT-BR.abcdefghij",
          "fileName": "file.png",
          "url": "https://",
          "typeName": "profile"
          }
      ],
      "approvalReason": "승인완료",
      "status": "published",
      "rcsReply": "0",
      "searchWeight": "512",
      "webhook": null,
      "botTcPage": "http://"
      }
  ]
}

참고

 결과 코드 참고 

챗봇 수정 요청 #

지정된 챗봇의 정보를 업데이트합니다. 챗봇의 업데이트는 승인상태에 따라 처리여부가 결정됩니다. 저장, 반려 상태에서 업데이트 시 등록과 동일하게 브랜드포털 관리자의 승인이 필요합니다.

- 수정 가능 상태 : 승인

▶ Request

URL

PUT /rcs/v1/brand/{brandId}/chatbot/{chatbotId} HTTP/1.1
Authorization: Bearer {token}
Host: mnt-api.msghub.uplus.co.kr

Header

NameTypeRequiredDescription
AuthorizationStringtrue사용자 인증 토큰

Path Parameter

NameTypeRequiredDescription
brandIdStringtrue브랜드 정보 접근시 사용되는 브랜드ID
chatbotIdStringtrue브랜드 내 챗봇 정보 접근시 사용되는 챗봇ID

Request body

NameTypeRequiredDescription
subNumCertificateStringfalse업로드된 통신서비스이용증명원 파일경로
chatbotChatbotPostRegfalse브랜드 등록,수정 정보

ChatbotPostReg

NameTypeRequiredDescription
mdnStringtrue등록할 발신번호 *국가번호는 생략, 휴대전화 번호는 등록 불가
rcsReplyStringtrue0=SMS MO 수신, 1=RCS Postback 수신
subTitleStringtrue챗봇(대화방) 이름
serviceStringtrueA2P/CHAT 서비스 유형
displayStringfalse챗봇 전시 설정값. 하단 참고

참고

챗봇 전시 설정값.

  • 설정하지 않을 경우 기본 〈01’로 설정. 현재 〈01〉, 〈00〉 설정만 가능.
  • 11 : 브랜드채널 노출,브랜드검색 허용,브랜드홈 전시
  • 10 : 브랜드채널 노출,브랜드검색 허용,브랜드홈 비전시
  • 01 : 브랜드채널 노출,브랜드검색 불허,브랜드홈 전시
  • 00 : 브랜드채널 노출,브랜드검색 불허,브랜드홈 비전시

▶ Response

NameTypeDescription
codeString결과 코드
messageString결과 코드 설명
dataObject결과 데이터
data.groupIdString그룹 ID
data.chatbotIdString챗봇 ID
data.brandIdString브랜드 ID
data.subNumString발신번호,chatbotId와 동일
data.subTitleString챗봇(대화방) 이름
data.serviceStringA2P/CHAT 서비스 유형
data.displayString챗봇 전시 설정값
data.approvalResultString승인 결과
data.registerDateString등록 일시
data.approvalDateString승인 일시
data.updateDateString수정 일시
data.registerIdString등록 아이디
data.updateIdString수정 아이디
data.approvalReasonString승인 사유
data.statusString챗봇 상태
data.rcsReplyString0=SMS MO 수신, 1=RCS Postback 수신
data.searchWeightString검색 우선 순위, 기본값(512)
data.webhookStringwebhook URLservice가 〈chat〉 인 경우 필수
data.botTcPageString이용약관페이지 URL
data.mediaUrlList<MediaUrl>미디어 URL
data.isMainNumBoolean대표번호 여부

MediaUrl

NameTypeDescription
fileIdString파일 ID
urlString파일 URL
typeNameString이미지의 사용 유형
fileNameString등록한 파일의 이름

참고

이미지 사용 유형

  • icon – 템플릿 양식 아이콘 이미지
  • background – 브랜드 백그라운드 이미지
  • profile – 브랜드 프로필 이미지

▶ Sample

Curl

curl -X PUT "https://mnt-api.msghub.uplus.co.kr/rcs/v1/brand/string/chatbot/string"
-H  "accept: */*"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiYWNjZXNzVXJsIjoi.."
-H  "Content-Type: application/json"
-d '
{
  "corpId": "corpId",
  "subNumCertificate": "/efs/file/console/2021/04/23/10/img.jpg",
  "chatbot": {
      "mdn": "12341234",
      "rcsReply": "1",
      "subTitle": "챗봇이름",
      "service": "a2p",
      "display": "01"
  }
}'

Response

{
  "code": "10000",
  "message": "성공",
  "data": [
  {
    "groupId": "group_test",
    "chatbotId": "0212341234",
    "brandId": "BR.abcdefghij",
    "subNum": "0256785678",
    "isMainNum": true,
    "subTitle": "11111",
    "service": "a2p",
    "display": "11",
    "approvalResult": "승인대기",
    "registerDate": "2020-03-12T06:22:55.418+09",
    "approvalDate": "2020-03-12T06:22:55.418+09",
    "updateDate": "2020-03-12T06:22:55.418+09",
    "registerId": "uplus_test",
    "updateId": "uplus_test",
    "mediaUrl": [
      {
        "fileId": "LT-BR.abcdefghij",
        "url": "https://",
        "typeName": "icon",
        "fileName": "file.png"
      }
    ],
    "rcsReply": "1",
    "approvalReason": "승인완료",
    "status": "published",
    "searchWeight": "512",
    "webhook": "https://",
    "botTcPage": "https://"
  }
]
  }

참고

 결과 코드 참고 

챗봇 삭제 요청 #

해당 챗봇을 삭제합니다. 챗봇의 삭제는 승인상태에 따라 처리 여부가 결정됩니다. 한번 삭제된 발신번호는 동일 브랜드에 재등록이 불가능 합니다.

- 삭제 가능 상태 : 승인

▶ Request

URL

DELETE /rcs/v1/brand/{brandId}/chatbot/{chatbotId} HTTP/1.1
Authorization: Bearer {token}
Host: mnt-api.msghub.uplus.co.kr

Header

NameTypeRequiredDescription
AuthorizationStringtrue사용자 인증 토큰

Path Parameter

NameTypeRequiredDescription
brandIdStringfalse브랜드 정보 접근시 사용되는 브랜드ID
chatbotIdStringfalse챗봇 ID

▶ Response

NameTypeDescription
codeString결과 코드
messageString결과 코드 설명
dataObject결과 데이터

▶ Sample

Curl

curl -X DELETE "https://mnt-api.msghub.uplus.co.kr/rcs/v1/brand/string/chatbot/string"
-H  "accept: */*"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiYWNjZXNzVXJsIjoi.."

Response

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

참고

 결과 코드 참고 

템플릿 #

템플릿 리스트 조회 #

브랜드 내에 등록된 템플릿 리스트 조회합니다.
* 프리 템플릿 기본형과 프리 템플릿 강조형(A) 는 브랜드 등록 시, 자동 생성됩니다.
* 공통 템플릿은 별도 승인절차 없이 바로 사용가능한 템플릿입니다.
* 템플릿 양식목록을 조회하여 템플릿을 작성할 수 있으며, 작성된 템플릿을 등록/승인받아 메시지발송 시 사용할 수 있습니다.
* 템플릿 조회는 대행사 권한을 uplus로 지정된 고객만 사용하는 api이며, 대행사는 하위고객 브랜드 수신등록 기능을 사용해야 합니다.

▶ Request

URL

GET /rcs/v1/brand/{brandId}/messagebase HTTP/1.1
Authorization: Bearer {token}
apiId: {apiId}
apiSecret: {apiSecret}
brandKey: {brandKey}
Host: mnt-api.msghub.uplus.co.kr

Header

NameTypeRequiredDescription
AuthorizationStringtrue사용자 인증 토큰
apiIdStringtrueRCS Biz Center 가입시 등록한 ID
apiSecretStringtrueRCS Biz Center 가입시 발급된 clientSecret
brandKeyStringtrueRCS Biz Center에서 브랜드 등록 시 자동 생성되는 Key

Path Parameter

NameTypeRequiredDescription
brandIdStringfalse브랜드 정보 접근시 사용되는 브랜드ID
offsetStringfalse시작 offset 번호(default: 0)
limitStringfalse조회 최대 건수(default: 100, maximum: 1000)

▶ Response

▶ Sample

Curl

curl -X GET "https://mnt-api.msghub.uplus.co.kr/rcs/v1/brand/string/messagebase?offset=0&limit=100"
-H  "accept: */*"
-H  "apiId: myMemberId"
-H  "apiSecret: SK.AbCdEfg1234500"
-H  "brandKey: BK.BraNdKey1234500"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiYWNjZXNzVXJsIjoi.."

Response

{
  "code": "10000",
  "message": "성공",
  "data": {
      "result": [
      {
          "groupId": null,
          "messagebaseId": "GG000F",
          "tmpltName": "썸네일형",
          "messagebaseformId": "GG000F",
          "brandId": "BR.abcdefghij",
          "status": "ready",
          "approvalResult": "승인",
          "approvalReason": "승인완료",
          "registerDate": "2021-06-09T14:01:06.000+09",
          "approvalDate": "2021-06-09T17:00:07.000+09",
          "updateDate": "2021-06-09T14:01:06.000+09",
          "registerId": "uplus_test",
          "updateId": "uplus_test"
      },
      ...,
      ]
  }
}

참고

결과 코드 참고 

공통 템플릿 목록 #

브랜드와 무관하게 공통으로 사용가능한 템플릿 목록은 아래와 같습니다.
공통 템플릿 목록은 추가/변경될 수 있습니다. 상세정보는 RCS BizCenter 홈페이지에서 조회 가능합니다.
메시지베이스 ID템플릿명상품코드
SS000000SMSsms
CMwMhM0200슬라이드형(Medium,2장)mms
CMwMhM0300슬라이드형(Medium,3장)mms
CMwMhM0400슬라이드형(Medium,4장)mms
CMwMhM0500슬라이드형(Medium,5장)mms
CMwMhM0600슬라이드형(Medium,6장)mms
CMwShS0200슬라이드형(Small,2장)mms
CMwShS0300슬라이드형(Small,3장)mms
CMwShS0400슬라이드형(Small,4장)mms
CMwShS0500슬라이드형(Small,5장)mms
CMwShS0600슬라이드형(Small,6장)mms
OMHIMS0001이미지 강조형 (1:1)mms
OMHIMV0001이미지 강조형 (3:4)mms
OMHITS0001이미지 & 타이틀 강조형 (1:1)mms
OMHITV0001이미지 & 타이틀 강조형 (3:4)mms
OMSNSH0001SNS형 (중간버튼)mms
OMSNSS0001SNS형mms
OMTBNH0001썸네일형 (가로)mms
OMTBNV0001썸네일형 (세로)mms
SMwThM00세로형(Medium)mms
SMwThT00세로형(Tall)mms
SL000000LMSlms
CCwMhM0200슬라이드형(Medium,2장)chat
CCwMhM0300슬라이드형(Medium,3장)chat
CCwMhM0400슬라이드형(Medium,4장)chat
CCwMhM0500슬라이드형(Medium,5장)chat
CCwMhM0600슬라이드형(Medium,6장)chat
CCwShS0200슬라이드형(Small,2장)chat
CCwShS0300슬라이드형(Small,3장)chat
CCwShS0400슬라이드형(Small,4장)chat
CCwShS0500슬라이드형(Small,5장)chat
CCwShS0600슬라이드형(Small,6장)chat
SCL00000텍스트 카드chat
SCS00000기본 말풍선chat
SCwThM00세로형(Medium)chat
SCwThT00세로형(Tall)chat

템플릿 등록 요청 #

템플릿를 등록합니다.

▶ Request

URL

POST /rcs/v1.1/brand/{brandId}/messagebase HTTP/1.1
Authorization: Bearer {token}
Host: mnt-api.msghub.uplus.co.kr

Header

NameTypeRequiredDescription
AuthorizationStringtrue사용자 인증 토큰

Path Parameter

NameTypeRequiredDescription
brandIdStringtrue브랜드 정보 접근시 사용되는 브랜드ID

Request body

NameTypeRequiredDescription
messagebaseformIdStringtrue템플릿 양식 ID
custTmpltIdStringtrue사용자 지정 템플릿ID(*영문/숫자 25자 이내만 가능)
tmpltNameStringtrue템플릿명
agencyIdStringfalse대행사 ID

▶ Response

NameTypeDescription
codeString결과 코드
messageString결과 코드 설명
dataList<String>결과 데이터 목록

▶ Sample

Curl

curl -X POST "https://mnt-api.msghub.uplus.co.kr/rcs/v1.1/{brandId}/messagebase"
-H  "accept: */*"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiYWNjZXNzVXJsIjoi.."
-H  "Content-Type: application/json"
-d  '
  [
  {
      "messagebaseformId": "CCabcd1234",
      "custTmpltId": "custTmpltId012345",
      "tmpltName": "썸네일형",
      "brandId": "BR.abcdefghij",
      "agencyId": "uplus_test",
      "formattedString": {...}
  }
]
'

Response

{
  "code": "10000",
  "message": "성공",
  "data": ["string", ...]
}

참고

 결과 코드 참고 

템플릿 상세 조회 #

브랜드 내에 등록된 템플릿 상세 조회합니다.

▶ Request

URL

GET /rcs/v1/brand/{brandId}/messagebase/{messagebaseId} HTTP/1.1
Authorization: Bearer {token}
apiId: {apiId}
apiSecret: {apiSecret}
brandKey: {brandKey}
Host: mnt-api.msghub.uplus.co.kr

Header

NameTypeRequiredDescription
AuthorizationStringtrue사용자 인증 토큰
apiIdStringtrueRCS Biz Center 가입시 등록한 ID
apiSecretStringtrueRCS Biz Center 가입시 발급된 clientSecret
brandKeyStringtrueRCS Biz Center에서 브랜드 등록 시 자동 생성되는 Key

Path Parameter

▶ Response

PolicyInfo

NameTypeDescription
cardCountinteger카드 개수
maxMediaSizeinteger미디어 크기 총합의 최대 크기
maxTitleSizeinteger개별 타이틀 글자 최대 수
maxButtonCountinteger버튼 최대 개수
maxDescriptionSizeintegerDescription들의 글자수 총합
adBodyAllowedboolean광고 문구 허용 여부
buttonsAllowedbooleanbuttons 사용 유무
adHeaderAllowedbooleanheader에 광고 인입 허가 여부

▶ Sample

Curl

curl -X GET "https://mnt-api.msghub.uplus.co.kr/rcs/v1/brand/string/messagebase/string"
-H  "accept: */*"
-H  "apiId: myMemberId"
-H  "apiSecret: SK.AbCdEfg1234500"
-H  "brandKey: BK.BraNdKey1234500"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiYWNjZXNzVXJsIjoi.."

Response

{
  "code": "10000",
  "message": "성공",
  "data": [
      {
      "groupId": null,
      "messagebaseId": "GG000F",
      "tmpltName": "썸네일형",
      "messagebaseformId": "GG000F",
      "brandId": "BR.abcdefghij",
      "status": "ready",
      "approvalResult": "승인",
      "approvalReason": "승인완료",
      "registerDate": "2021-06-09T14:01:06.000+09",
      "approvalDate": "2021-06-09T17:00:07.000+09",
      "updateDate": "2021-06-09T14:01:06.000+09",
      "registerId": "uplus_test",
      "updateId": "uplus_test",
      "productCode": "tmplt",
      "spec": "openrichcard",
      "cardType": "free",
      "agencyId": null,
      "inputText": null,
      "attribute": [...],
      "guideInfo": {...},
      "policyInfo": {
          "cardCount": 1,
          "maxTitleSize": 0,
          "maxButtonCount": 0,
          "maxDescriptionSize": 90,
          "maxMediaSize": 1048576,
          "buttonsAllowed": false,
          "adHeaderAllowed": false,
          "adBodyAllowed": false
        },
      "params": [...],
      "formattedString": {...}
      }
  ]
  }

참고

 결과 코드 참고 

템플릿 수정 요청 #

템플릿을 업데이트 합니다. 템플릿의 업데이트는 승인상태에 따라 처리 여부가 결정됩니다.

- 수정 가능 상태 : 승인

▶ Request

URL

PUT /rcs/v1/brand/{brandId}/messagebase/{messagebaseId} HTTP/1.1
Authorization: Bearer {token}
Host: mnt-api.msghub.uplus.co.kr

Header

NameTypeRequiredDescription
AuthorizationStringtrue사용자 인증 토큰

Path Parameter

Request body

NameTypeRequiredDescription
messagebaseformIdStringtrue템플릿 양식 ID
custTmpltIdStringtrue사용자 지정 템플릿ID(*영문/숫자 25자 이내만 가능)
tmpltNameStringtrue템플릿명
brandIdStringtrue브랜드 ID
agencyIdStringfalse대행사 ID
formattedStringObjectfalse오픈리치카드를 구성하는 Widget 의 속정 정보 객체

▶ Response

NameTypeDescription
codeString결과 코드
messageString결과 코드 설명
dataObject결과 데이터

▶ Sample

Curl

curl -X PUT "https://mnt-api.msghub.uplus.co.kr/rcs/v1/brand/string/messagebase/string"
-H  "accept: */*"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiYWNjZXNzVXJsIjoi.."
-H  "Content-Type: application/json"
-d '
{
  "messagebaseformId": "GG000F",
  "custTmpltId": "custTmpltId012345",
  "tmpltName": "썸네일형",
  "brandId": "BR.abcdefghij",
  "agencyId": "uplus_test",
  "formattedString": {}
}'

Response

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

참고

 결과 코드 참고 

템플릿 삭제 요청 #

브랜드 내 지정된 템플릿을 삭제합니다. 템플릿의 삭제는 승인상태에 따라 처리 여부가 결정됩니다. 한번 삭제된 템플릿은 복원이 불가능하며 동일한 ID로 생성할 수 없습니다.

- 삭제 가능 상태 : 승인

▶ Request

URL

DELETE /rcs/v1/brand/{brandId}/messagebase/{messagebaseId} HTTP/1.1
Authorization: Bearer {token}
Host: mnt-api.msghub.uplus.co.kr

Header

NameTypeRequiredDescription
AuthorizationStringtrue사용자 인증 토큰

Path Parameter

▶ Response

NameTypeDescription
codeString결과 코드
messageString결과 코드 설명
dataObject결과 데이터

▶ Sample

Curl

curl -X DELETE "https://mnt-api.msghub.uplus.co.kr/rcs/v1/brand/string/messagebase/string"
-H  "accept: */*"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiYWNjZXNzVXJsIjoi.."

Response

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

참고

 결과 코드 참고 

템플릿 승인 요청을 취소 #

지정된 템플릿의 승인요청을 취소합니다. 각 상태별 취소 요청 동작은 다음과 같습니다.

- 승인대기 : 저장 상태로 변경
- 승인대기(수정) : 직전 승인 상태 및 데이터로 롤백
- 반려(수정) : 직전 승인 상태 및 데이터로 롤백
- 이외의 경우 에러 리턴

▶ Request

URL

PUT /rcs/v1/brand/{brandId}/messagebase/{messagebaseId}/cancel HTTP/1.1
Authorization: Bearer {token}
Host: mnt-api.msghub.uplus.co.kr

Header

NameTypeRequiredDescription
AuthorizationStringtrue사용자 인증 토큰

Path Parameter

▶ Response

NameTypeDescription
codeString결과 코드
messageString결과 코드 설명
dataObject결과 데이터

▶ Sample

Curl

curl -X PUT "https://mnt-api.msghub.uplus.co.kr/rcs/v1/brand/string/messagebase/string/cancel"
-H  "accept: */*"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiYWNjZXNzVXJsIjoi.."

Response

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

참고

 결과 코드 참고 

정보 조회 #

브랜드 카테고리 조회 #

브랜드 등록 시 사용 가능한 카테고리 목록을 조회한다.

▶ Request

URL

GET /rcs/v1/brand/categories HTTP/1.1
Authorization: Bearer {token}
apiId: {apiId}
apiSecret: {apiSecret}
Host: mnt-api.msghub.uplus.co.kr

Header

NameTypeRequiredDescription
AuthorizationStringtrue사용자 인증 토큰
apiIdStringtrueRCS Biz Center 가입시 등록한 ID
apiSecretStringtrueRCS Biz Center 가입시 발급된 clientSecret

▶ Response

NameTypeDescription
codeString결과 코드
messageString결과 코드 설명
dataList결과 데이터 목록
data.categoryIdString카테고리 ID
data.categoryNameString카테고리 명
data.subCategoriesList서브 카테고리 목록
data.subCategories.subCategoryIdString서브 카테고리 ID
data.subCategories.subCategoryNameString서브 카테고리 명
data.updateDateString수정 일시

▶ Sample

Curl

curl -X GET "https://mnt-api.msghub.uplus.co.kr/rcs/v1/brand/categories"
-H  "accept: */*"
-H  "apiId: myMemberId"
-H  "apiSecret: SK.AbCdEfg1234500"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiYWNjZXNzVXJsIjoi.."

Response

{
"code": "10000",
"message": "성공",
"data": [
  {
    "categoryId": "ITE",
    "categoryName": "IT",
    "subCategories": [
      {
        "subCategoryId": "ITE001",
        "subCategoryName": "인터넷/컴퓨터"
      },
      {
        "subCategoryId": "ITE002",
        "subCategoryName": "정보통신/SW"
      },
      {
        "subCategoryId": "ITE003",
        "subCategoryName": "IT 정보"
      },
      {
        "subCategoryId": "ITE004",
        "subCategoryName": "전자/영상/음향"
      },
      {
        "subCategoryId": "ITE005",
        "subCategoryName": "IT 일반"
      }
    ],
    "updateDate": "2019-11-14T10:28:31.000+09"
  },
  ...
  ]
  }

참고

 결과 코드 참고 

이통사 기본 템플릿 조회 #

이통사가 기본 제공하는 템플릿을 조회합니다.

▶ Request

URL

GET /rcs/v1/messagebase/common HTTP/1.1
Authorization: Bearer {token}
apiId: {apiId}
apiSecret: {apiSecret}
Host: mnt-api.msghub.uplus.co.kr

Header

NameTypeRequiredDescription
AuthorizationStringtrue사용자 인증 토큰
apiIdStringtrueRCS Biz Center 가입시 등록한 ID
apiSecretStringtrueRCS Biz Center 가입시 발급된 clientSecret

Path Parameter

NameTypeRequiredDescription
offsetStringfalse시작 offset 번호(default: 0)
limitStringfalse조회 최대 건수(default: 100, maximum: 1000)

▶ Response

▶ Sample

Curl

curl -X GET "https://mnt-api.msghub.uplus.co.kr/rcs/v1/messagebase/common?offset=0&limit=100"
-H  "accept: */*"
-H  "apiId: myMemberId"
-H  "apiSecret: SK.AbCdEfg1234500"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiYWNjZXNzVXJsIjoi.."

Response

{
"code": "10000",
"message": "성공",
"data": [
   {
      "groupId": null,
      "messagebaseId": "GG000F",
      "tmpltName": "썸네일형",
      "messagebaseformId": "GG000F",
      "brandId": "common",
      "status": "ready",
      "approvalResult": "승인",
      "approvalReason": "승인완료",
      "registerDate": "2019-11-08T19:17:24.000+09",
      "approvalDate": "2020-11-06T13:06:39.000+09",
      "updateDate": "2020-04-08T12:25:26.000+09",
      "registerId": "uplus_test",
      "updateId": "uplus_test"
      },
      ...
  ]
}

참고

 결과 코드 참고 

이통사 기본 템플릿 상세 조회 #

템플릿 이통사가 기본 제공하는 리치카드 별 상세 내용을 조회합니다.

▶ Request

URL

GET /rcs/v1/messagebase/common/{messagebaseId} HTTP/1.1
Authorization: Bearer {token}
apiId: {apiId}
apiSecret: {apiSecret}
Host: mnt-api.msghub.uplus.co.kr

Header

NameTypeRequiredDescription
AuthorizationStringtrue사용자 인증 토큰
apiIdStringtrueRCS Biz Center 가입시 등록한 ID
apiSecretStringtrueRCS Biz Center 가입시 발급된 clientSecret

Path Parameter

NameTypeRequiredDescription
messagebaseIdStringfalse기본 이동사 템플릿ID

▶ Response

▶ Sample

Curl

curl -X GET "https://mnt-api.msghub.uplus.co.kr/rcs/v1/messagebase/common/string"
-H  "accept: */*"
-H  "apiId: myMemberId"
-H  "apiSecret: SK.AbCdEfg1234500"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiYWNjZXNzVXJsIjoi.."

Response

{
"code": "10000",
"message": "성공",
"data": [
  {
    "groupId": null,
    "messagebaseId": "GG000F",
    "tmpltName": "썸네일형",
    "messagebaseformId": "GG000F",
    "brandId": "BR.abcdefghij",
    "status": "ready",
    "approvalResult": "승인대기",
    "approvalReason": "승인완료",
    "registerDate": "2021-07-20T16:59:19.000+09",
    "approvalDate": "2021-07-20T16:59:19.000+09",
    "updateDate": "2021-07-20T16:59:19.000+09",
    "registerId": "uplus_test",
    "updateId": "uplus_test",
    "productCode": "tmplt",
    "spec": "openrichcard",
    "cardType": "free",
    "agencyId": "uplus_test",
    "inputText": null,
    "attribute": [...],
    "guideInfo": {...},
    "policyInfo": {...},
    "params": {...},
    "formattedString": {...}
  }
]
}

참고

 결과 코드 참고 

템플릿 양식 목록 조회 #

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

▶ Request

URL

GET /rcs/v1/messagebase/messagebaseform HTTP/1.1
Authorization: Bearer {token}
apiId: {apiId}
apiSecret: {apiSecret}
Host: mnt-api.msghub.uplus.co.kr

Header

NameTypeRequiredDescription
AuthorizationStringtrue사용자 인증 토큰
apiIdStringtrueRCS Biz Center 가입시 등록한 ID
apiSecretStringtrueRCS Biz Center 가입시 발급된 clientSecret

Path Parameter

NameTypeRequiredDescription
offsetStringfalse시작 offset 번호(default: 0)
limitStringfalse조회 최대 건수(default: 100, maximum: 1000)

▶ Response

▶ Sample

Curl

curl -X GET "https://mnt-api.msghub.uplus.co.kr/rcs/v1/messagebase/messagebaseform?offset=0&limit=100"
-H  "accept: */*"
-H  "apiId: myMemberId"
-H  "apiSecret: SK.AbCdEfg1234500"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiYWNjZXNzVXJsIjoi.."

Response

{
"code": "10000",
"message": "성공",
"data": [
  {
    "messagebaseformId": "GG000F",
    "formName": "Form",
    "cardType": "free",
    "bizCondition": [
      "condition"
    ],
    "bizCategory": "category",
    "bizService": "service",
    "registerDate": "2020-03-12T06:22:55.418+09",
    "updateDate": "2020-03-12T06:22:55.418+09"
  }

참고

 결과 코드 참고 

템플릿 양식 상세조회 #

템플릿 양식의 상세 내용을 조회합니다. formattedString을 이용하여 원하는 브랜드용 템플릿을 작성할 수 있습니다.

▶ Request

URL

GET /rcs/v1/messagebase/messagebaseform/{messagebaseformId} HTTP/1.1
Authorization: Bearer {token}
apiId: {apiId}
apiSecret: {apiSecret}
messagebaseformId: {messagebaseformId}
Host: mnt-api.msghub.uplus.co.kr

Header

NameTypeRequiredDescription
AuthorizationStringtrue사용자 인증 토큰
apiIdStringtrueRCS Biz Center 가입시 등록한 ID
apiSecretStringtrueRCS Biz Center 가입시 발급된 clientSecret
messagebaseformIdStringtrue템플릿 유형ID Path Parameter

▶ Response

▶ Sample

Curl

curl -X GET "https://mnt-api.msghub.uplus.co.kr/rcs/v1/messagebase/messagebaseform/string"
-H  "accept: */*"
-H  "apiId: myMemberId"
-H  "apiSecret: SK.AbCdEfg1234500"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiYWNjZXNzVXJsIjoi.."

Response

{
"code": "10000",
"message": "성공",
"data": [
  {
    "messagebaseformId": "GG000F",
    "formName": "form",
    "cardType": "free",
    "bizCondition": [
      "condition"
    ],
    "bizCategory": "bizCategory",
    "bizService": "bizService",
    "registerDate": "2020-03-12T06:22:55.418+09",
    "updateDate": "2020-03-12T06:22:55.418+09"
  }

참고

결과 코드 참고

고객반응 통계 #

캠페인 메시지 발송/ 읽음 확인 통계 #

발송/ 읽음 확인 통계를 조회합니다. 동일 Group ID에 발송일 기준 3일간 (D+3) 집계됩니다. 단, 이통사별 발송 성공건수 100건 이상인 경우에 한해 집계됩니다. 통계 조회 기간은 데이터 존재 시 최근 1년 6개월 이내 기간 중 최대 31일까지 검색 가능합니다.

▶ Request

URL

POST /rcs/v1/statQuery/message/{brandId} HTTP/1.1
Authorization: Bearer {token}
Host: mnt-api.msghub.uplus.co.kr

Header

NameTypeRequiredDescription
AuthorizationStringtrue사용자 인증 토큰

Path Parameter

NameTypeRequiredDescription
brandIdStringtrue브랜드 내 정보 접근시 사용되는 브랜드ID 

Request body

NameTypeRequiredDescription
brandKeyStringtrueRCS Biz Center에서 브랜드 등록 시 자동 생성되는 Key
startDateStringtrue요청시작일자
endDateStringtrue요청종료일자
campaignIdStringtrue발송 캠페인 구분 ID
chatbotIdStringfalse대화방ID2

▶ Response

▶ Sample

Curl

curl -X GET "https://mnt-api.msghub.uplus.co.kr/rcs/v1/statQuery/message/{brandId}"
-H  "accept: */*"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiYWNjZXNzVXJsIjoi.."

Response

{
"code": "10000",
"message": "성공",
"data":   {
   "status": "200",
    "code": "20000000",
    "error": {
      "code": "string",
      "message": "string"
  },
 "desc": "string",
    "restErrMsg": "string",
    "httpStatus": "100 CONTINUE",
    "result": [
      {
        "statDate": "string",
        "corpId": "string",
        "corpRegNum": "string",
        "brandId": "string",
        "chatbotId": "string",
        "groupId": "string",
        "deliveredCount": 0,
        "displayedCount": 0
      }
    ]
  }
}

참고

캠페인 메시지 버튼 클릭 통계 #

캠페인 메시지 버튼 클릭 통계를 조회합니다. 동일 Group ID에 발송일 기준 3일간 (D+3) 집계됩니다. 단, 이통사별 발송 성공건수 100건 이상인 경우에 한해 집계됩니다. 통계 조회 기간은 데이터 존재 시 최근 1년 6개월 이내 기간 중 최대 31일까지 검색 가능합니다.

▶ Request

URL

POST /rcs/v1/statQuery/messageButton/{brandId} HTTP/1.1
Authorization: Bearer {token}
Host: mnt-api.msghub.uplus.co.kr

Header

NameTypeRequiredDescription
AuthorizationStringtrue사용자 인증 토큰

Path Parameter

NameTypeRequiredDescription
brandIdStringtrue브랜드 내 정보 접근시 사용되는 브랜드ID 

Request body

NameTypeRequiredDescription
brandKeyStringtrueRCS Biz Center에서 브랜드 등록 시 자동 생성되는 Key
startDateStringtrue요청시작일자
endDateStringtrue요청종료일자
campaignIdStringtrue발송 캠페인 구분 ID
chatbotIdStringfalse대화방ID

▶ Response

▶ Sample

Curl

curl -X GET "https://mnt-api.msghub.uplus.co.kr/rcs/v1/statQuery/messageButton/{brandId}"
-H  "accept: */*"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiYWNjZXNzVXJsIjoi.."

Response

{
  "code": "10000",
  "message": "성공",
  "data": {
    "status": "200",
    "code": "20000000",
    "error": {
      "code": "string",
      "message": "string"
    },
    "desc": "string",
    "restErrMsg": "string",
    "httpStatus": "100 CONTINUE",
    "result": [
      {
        "statDate": "string",
        "corpId": "string",
        "corpRegNum": "string",
        "brandId": "string",
        "chatbotId": "string",
        "groupId": "string",
        "buttonList": [
          {
            "actionType": "string",
            "title": "string",
            "clickCount": 0
          }
        ]
      }
    ]
  }
}

참고

대화방 메뉴 클릭 통계 #

대화방 메뉴 클릭 통계를 조회합니다. 대화방별 1건 이상 사용자선택이 일어난 경우에 대해 집계됩니다. 통계 조회 기간은 데이터 존재 시 최근 1년 6개월 이내 기간 중 최대 31일까지 검색 가능합니다.

▶ Request

URL

POST /rcs/v1/statQuery/persistentMenu/{brandId} HTTP/1.1
Authorization: Bearer {token}
Host: mnt-api.msghub.uplus.co.kr

Header

NameTypeRequiredDescription
AuthorizationStringtrue사용자 인증 토큰

Path Parameter

NameTypeRequiredDescription
brandIdStringtrue브랜드 내 정보 접근시 사용되는 브랜드ID 

Request body

NameTypeRequiredDescription
brandKeyStringtrueRCS Biz Center에서 브랜드 등록 시 자동 생성되는 Key
startDateStringtrue요청시작일자
endDateStringtrue요청종료일자
campaignIdStringtrue발송 캠페인 구분 ID
chatbotIdStringfalse대화방ID

▶ Response

▶ Sample

Curl

curl -X GET "https://mnt-api.msghub.uplus.co.kr/rcs/v1/statQuery/persistentMenu/{brandId}"
-H  "accept: */*"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiYWNjZXNzVXJsIjoi.."

Response

{
  "code": "10000",
  "message": "성공",
  "data": {
    "status": "200",
    "code": "20000000",
    "error": {
      "code": "string",
      "message": "string"
    },
    "desc": "string",
    "restErrMsg": "string",
    "httpStatus": "100 CONTINUE",
    "result": [
      {
        "statDate": "string",
        "corpId": "string",
        "corpRegNum": "string",
        "brandId": "string",
        "chatbotId": "string",
        "menuList": [
          {
            "postbackId": "string",
            "menuType": "string",
            "actionType": "string",
            "title": "string",
            "clickCount": 0,
            "subList": [
              {
                "postbackId": "string",
                "menuType": "string",
                "actionType": "string",
                "title": "string",
                "clickCount": 0,
                "subActionList": [
                  {
                    "postbackId": "string",
                    "actionType": "string",
                    "title": "string",
                    "clickCount": 0
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  }
}

참고

대화방ID 등록 가능 여부 조회 #

대화방ID 등록 가능 여부를 조회 합니다. 등록 가능한 경우 200 OK 응답으로 리턴되며, 대화방ID 형식 부적합, 이미 등록된 대화방ID 등 등록이 불가능한 경우 400 Error 리턴됩니다.

▶ Request

URL

GET /rcs/v1/usableQuery/chatbotId/{chatbotId} HTTP/1.1
Authorization: Bearer {token}
Host: mnt-api.msghub.uplus.co.kr

Header

NameTypeRequiredDescription
AuthorizationStringtrue사용자 인증 토큰

Path Parameter

NameTypeRequiredDescription
chatbotId Stringtrue대화방ID

▶ Response

▶ Sample

Curl

curl -X GET "https://mnt-api.msghub.uplus.co.kr/rcs/v1/usableQuery/chatbotId/16104723"
-H  "accept: */*"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiYWNjZXNzVXJsIjoi.."

Response

{
  "code": "10000",
  "message": "성공",
  "data": {
    "status": "200",
    "code": "20000000",
    "error": {
      "code": "string",
      "message": "string"
    },
    "desc": "string",
    "restErrMsg": "string",
    "httpStatus": "100 CONTINUE",
    "result": [
      {
        "statDate": "string",
        "corpId": "string",
        "corpRegNum": "string",
        "brandId": "string",
        "chatbotId": "string",
        "menuList": [
          {
            "postbackId": "string",
            "menuType": "string",
            "actionType": "string",
            "title": "string",
            "clickCount": 0,
            "subList": [
              {
                "postbackId": "string",
                "menuType": "string",
                "actionType": "string",
                "title": "string",
                "clickCount": 0,
                "subActionList": [
                  {
                    "postbackId": "string",
                    "actionType": "string",
                    "title": "string",
                    "clickCount": 0
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  }
}

참고

대행사 #

대행사 하위 브랜드 상세조회 #

대행사에 등록된 하위 브랜드의 상세 정보를 조회합니다.

▶ Request

URL

GET /rcs/v1/agency/{agencyId}/brand/{brandId} HTTP/1.1
Authorization: Bearer {token}
Host: mnt-api.msghub.uplus.co.kr

Header

NameTypeRequiredDescription
AuthorizationStringtrue사용자 인증 토큰

Path Parameter

NameTypeRequiredDescription
agencyIdStringtrueagency ID
brandIdStringtruebrand ID

Request body

NameTypeRequiredDescription
apiIdStringtrueRCS Biz Center에 가입 시 등록된 대행사 ID
apiSecretStringtrueRCS Biz Center에 가입시 발급된 clientSecret

▶ Response

▶ Sample

Curl

curl -X GET "https://mnt-api.msghub.uplus.co.kr/rcs/v1/agency/lguplus/brand/BR.J69g2k694p"
-H  "accept: */*"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiYWNjZXNzVXJsIjoi.."

Response

{
  "code": "10000",
  "message": "성공",
  "data": [
    {
      "brandId": "BR.J69g2k694p",
      "name": "(주)이커머스테크",
      "brandKey": "BK.b9qq5D0h353YjRR",
      "registerDate": "2023-07-27T16:35:19.000+09",
      "approvalDate": "2023-07-31T15:13:19.000+09",
      "updateDate": "2023-07-31T13:10:40.000+09",
      "status": "승인",
      "mediaUrl": [
        {
          "fileId": "LT-BR.J69g2k694p-v8P7",
          "url": "https://file.rcsbizcenter.com/brand/BR.J69g2k694p/LT-BR.J69g2k694p-v8P7_1.png",
          "typeName": "background",
          "fileName": "이커머스2.png"
        },
        {
          "fileId": "LT-BR.J69g2k694p-Um3g",
          "url": "https://file.rcsbizcenter.com/brand/BR.J69g2k694p/LT-BR.J69g2k694p-Um3g_1.png",
          "typeName": "profile",
          "fileName": "ec_logo2_new.png"
        }
      ],
      "chatbotDate": "2023-11-20T14:19:31.000+09",
      "messagebaseDate": "2024-02-22T09:36:18.000+09"
    }
  ]
}

대행사 하위 브랜드 조회 #

대행사와 계약된 브랜드를 기업 단위로 조회합니다.

▶ Request

URL

GET /rcs/v1/agency/{agencyId}/corp/{corpRegNum}/brand HTTP/1.1
Authorization: Bearer {token}
Host: mnt-api.msghub.uplus.co.kr

Header

NameTypeRequiredDescription
AuthorizationStringtrue사용자 인증 토큰

Path Parameter

NameTypeRequiredDescription
agencyIdStringtrueagency ID
corpRegNumStringtrue사업자번호

Request body

NameTypeRequiredDescription
apiIdStringtrueRCS Biz Center에 가입 시 등록된 대행사 ID
apiSecretStringtrueRCS Biz Center에 가입시 발급된 clientSecret
offsetStringtrue조회 시작 번호(default: 0)
limitStringtrue조회 최대 건수(default: 100, maximum: 1000) 

▶ Response

▶ Sample

Curl

curl -X GET "https://mnt-api.msghub.uplus.co.kr/rcs/v1/agency/lguplus/corp/2148673163/brand?offset=0&limit=100"
-H  "accept: */*"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiYWNjZXNzVXJsIjoi.."

Response

{
  "code": "10000",
  "message": "성공",
  "data": [
    {
      "corpId": "CO.z371x5XnQs",
      "corpRegNum": "2148673163",
      "brandId": "BR.J69g2k694p",
      "brandName": "(주)이커머스테크",
      "agencyId": "lguplus",
      "contracts": [
        "a2p,chat"
      ],
      "registerDate": "2023-07-31T16:45:47.000+09",
      "updateDate": "2023-07-31T16:45:48.000+09",
      "brandDate": "2023-07-31T15:13:19.000+09",
      "chatbotDate": "2023-11-20T14:19:31.000+09",
      "messagebaseDate": "2024-02-22T09:36:18.000+09"
    },
    {
      "corpId": "CO.z371x5XnQs",
      "corpRegNum": "2148673163",
      "brandId": "BR.55pX8HyIA3",
      "brandName": "이커머스테크",
      "agencyId": "lguplus",
      "contracts": [
        "a2p,chat"
      ],
      "registerDate": "2021-09-30T14:45:46.000+09",
      "updateDate": "2021-09-30T14:45:47.000+09",
      "brandDate": "2022-10-20T16:00:41.000+09",
      "chatbotDate": "2023-06-15T18:59:12.000+09",
      "messagebaseDate": "2024-02-29T09:53:47.000+09"
    }
  ]
}

대행사 하위 고객사 프로젝트 목록 조회 #

대행사가 계약된 고객사의 프로젝트 목록을 조회합니다

▶ Request

URL

POST /rcs/v1/agency/brand/project HTTP/1.1
Authorization: Bearer {token}
Host: mnt-api.msghub.uplus.co.kr

Header

NameTypeRequiredDescription
AuthorizationStringtrue사용자 인증 토큰

Request body

NameTypeRequiredDescription
apiIdStringtrueRCS Biz Center에 가입 시 등록된 대행사 ID
apiSecretStringtrueRCS Biz Center에 가입시 발급된 clientSecret
agencyIdStringtrueagency ID
regnosarraytrue조회 대상 기업 사업자번호

▶ Response

▶ Sample

Curl

curl -X POST "https://mnt-api.msghub.uplus.co.kr/rcs/v1/agency/brand/project?agencyId=lguplus&regnos=2148673163&regnos=2208742978"
-H  "accept: */*"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiYWNjZXNzVXJsIjoi.."

Response

{
  "code": "10000",
  "message": "조회 성공",
  "data": [
    {
      "projectId": "PJT0JR9",
      "projectName": "박서원 테스트"
    },
    {
      "projectId": "PJT2KGz",
      "projectName": "test123234"
    },
    {
      "projectId": "PJT7RZe",
      "projectName": "전유정 테스트"
    },
    {
      "projectId": "PJT8IXh",
      "projectName": "TEST"
    },
    {
      "projectId": "PJT9c9Vdfa",
      "projectName": "제임스프로젝트1"
    },
    {
      "projectId": "PJTakQNq7P",
      "projectName": "mo test"
    },
    {
      "projectId": "PJTaynizRS",
      "projectName": "연구소"
    },
    {
      "projectId": "PJThDef",
      "projectName": "프로젝트생성테스트"
    },
    {
      "projectId": "PJThWLG",
      "projectName": "TEST2"
    },
    {
      "projectId": "PJTIe3Y2Md",
      "projectName": "선불 프로젝트3"
    },
    {
      "projectId": "PJTIRQL",
      "projectName": "RCS 프로젝트 테스트"
    },
    {
      "projectId": "PJTLI1zuO9",
      "projectName": "선불 프로젝트2"
    },
    {
      "projectId": "PJTLqI5",
      "projectName": "석정민 테스트"
    },
    {
      "projectId": "PJTmeoF",
      "projectName": "test1111"
    },
    {
      "projectId": "PJTnSi1",
      "projectName": "CNS TEST"
    },
    {
      "projectId": "PJTo40CTGn",
      "projectName": "선불 프로젝트"
    },
    {
      "projectId": "PJTO5pZ",
      "projectName": "MO TEST"
    },
    {
      "projectId": "PJTpM27",
      "projectName": "프로젝트생성테스트_김준호"
    },
    {
      "projectId": "PJTRyiVmLK",
      "projectName": "새프로젝트0421"
    },
    {
      "projectId": "PJTrZS2",
      "projectName": "TEST"
    },
    {
      "projectId": "PJTSwK9",
      "projectName": "송은실  선불 테스트 "
    },
    {
      "projectId": "PJTsxF5NOS",
      "projectName": "기술지원팀테스트"
    },
    {
      "projectId": "PJTtpPz",
      "projectName": "정민 테스트"
    },
    {
      "projectId": "PJTVjgy",
      "projectName": "테스트 프로젝트"
    },
    {
      "projectId": "PJTvqv6",
      "projectName": "비트큐브"
    },
    {
      "projectId": "PJTVVCG",
      "projectName": "비트큐브2"
    },
    {
      "projectId": "PJTWfKP3An",
      "projectName": "테스트"
    },
    {
      "projectId": "PJTx9ONTqN",
      "projectName": "test"
    },
    {
      "projectId": "PJTYPqd",
      "projectName": "테스트 프로젝트123"
    },
    {
      "projectId": "PJTYXNIIbC",
      "projectName": "정기반영테스트"
    },
    {
      "projectId": "PJTyZkK",
      "projectName": "테스트"
    }
  ]
}
#
Updated on 2024년 4월 9일
통합발송 연동관리카카오 연동 관리
목차
  • 브랜드
    • 브랜드 리스트 조회
    • 브랜드 등록 요청
    • 브랜드 상세 조회
    • 브랜드 수정 요청
    • 브랜드 삭제 요청
  • 챗봇
    • 챗봇 리스트 조회
    • 챗봇 등록 요청
    • 챗봇 다건 등록 요청
    • 챗봇 상세 조회
    • 챗봇 수정 요청
    • 챗봇 삭제 요청
  • 템플릿
    • 템플릿 리스트 조회
    • 공통 템플릿 목록
    • 템플릿 등록 요청
    • 템플릿 상세 조회
    • 템플릿 수정 요청
    • 템플릿 삭제 요청
    • 템플릿 승인 요청을 취소
  • 정보 조회
    • 브랜드 카테고리 조회
    • 이통사 기본 템플릿 조회
    • 이통사 기본 템플릿 상세 조회
    • 템플릿 양식 목록 조회
    • 템플릿 양식 상세조회
  • 고객반응 통계
    • 캠페인 메시지 발송/ 읽음 확인 통계
    • 캠페인 메시지 버튼 클릭 통계
    • 대화방 메뉴 클릭 통계
  • 대화방ID 등록 가능 여부 조회
  • 대행사
    • 대행사 하위 브랜드 상세조회
    • 대행사 하위 브랜드 조회
    • 대행사 하위 고객사 프로젝트 목록 조회