콘텐츠로 이동

3.6 문자 메시지 / 통합발송

구분접속 URL
상용https://api.msghub.uplus.co.kr
검수https://api.msghub-qa.uplus.co.kr

사전에 등록한 템플릿 목록을 조회한다.


GET /msg/v1/template/all HTTP/1.1
NameType필수설명
AuthorizationString사용자 인증 토큰
Content-TypeStringapplication/json
NameType필수설명
chString채널
listCntint조회할 템플릿 목록 수
pageIdxint페이지 번호

NameType설명
codeString결과 코드
messageString결과 메시지
dataArray결과 데이터 목록
data[].tmpltIdString템플릿 ID
data[].tmpltNameString템플릿명
data[].senderTypeString발송유형
data[].msgKindString메시지구분
data[].msgTypeString메시지타입
data[].tmpltStatusString템플릿 상태
data[].regDtString등록일자
data[].updDtString수정일자

curl -X GET "https://api.msghub.uplus.co.kr/msg/v1/template/all?ch=mms&listCnt=10&pageIdx=1" \
-H "accept: */*" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {token}"
{
"code": "10000",
"message": "성공",
"data": [
{
"tmpltId": "TPL....g4O",
"tmpltName": "통합발송테스트_02",
"senderType": "통합",
"msgKind": "광고성",
"msgType": "기본",
"tmpltStatus": "완료",
"regDt": "2025-12-17 00:00:00",
"updDt": null
},
{
"tmpltId": "TPL....WN",
"tmpltName": "통합발송테스트_01",
"senderType": "통합",
"msgKind": "정보성",
"msgType": "기본",
"tmpltStatus": "완료",
"regDt": "2025-12-17 00:00:00",
"updDt": null
},
...
]
}

통합발송 템플릿를 상세 조회한다.


GET /msg/v1/template/get HTTP/1.1
NameType필수설명
AuthorizationString사용자 인증 토큰
Content-TypeStringapplication/json
NameType필수설명
tmpltIdString템플릿 ID

NameType설명
codeString결과 코드
messageString결과 메시지
dataArray결과 데이터 목록
data[].tmpltCodeString템플릿 코드
data[].msgKindString메시지구분
data[].msgTypeString메시지타입
data[].tmpltTitleString템플릿 제목
data[].tmpltInfo[]Array템플릿정보
data[].tmpltInfo[].chString템플릿정보
data[].tmpltInfo[].dataString채널별 템플릿정보
data[].tmpltInfo[].chTypeListString템플릿에 포함된 채널리스트

curl -X GET "https://api.msghub.uplus.co.kr/msg/v1/template/get?tmpltId=TPL....4O" \
-H "accept: */*" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {token}"
{
"code": "10000",
"message": "성공",
"data": {
"tmpltCode": "TPL....4O",
"msgKind": "A",
"msgType": "BASE",
"tmpltTitle": "통합발송테스트_01",
"tmpltInfo": [
{
"ch": "RCS",
"data": {
"footer": "01000000001",
"header": "1",
"brandNm": "BR.zv....ot",
"buttons": [
{}
],
"agencyId": "uplus",
"callback": "020000001",
"mergeData": [
{
"description": "통합발송 RCS 테스트입니다."
}
],
"rcsPrdType": "SMS",
"copyAllowed": "false",
"expiryOption": "2",
"messagebaseId": "SS000000"
},
"chTypeList": "RCS,KAKAO"
},
{
"ch": "FRIENDTALK",
"data": {
"msg": "통합발송 친구톡 테스트입니다.",
"image": {},
"adFlag": "Y",
"buttons": [],
"kkoChId": "@카카오채널id",
"callback": "1",
"wideImageYn": "N",
"senderKeyType": ""
},
"chTypeList": "RCS,KAKAO"
}
]
}
}