메시지베이스 등록
-
브랜드 내에서 사용할 메시지베이스를 등록합니다. 등록된 메시지 베이스는 브랜드 포털 관리자의 승인 후 사용 가능하며, 템플릿 등록시 사용되는messagebaseformId 의 formattedString 을 이용하여 등록해야 합니다.
-
POST /rcsapi/v1/brand/msgbase/create
-
Content-Type: application/json; charset=utf-8
Request
키 | 타입 | 필수 | 설명 |
brandld | String | O | BizCenter 에서 생성한 브랜드 ID |
custTmpltld | String | O | 사용자 지정 템플릿 ID (정규식패턴: ^[0-9A-Za-z]{1,25}$) |
messagebaseformld | String | O | 메시지베이스 폼 ID (정규식패턴: ^[0-9A-Za-z]{1,10}$) |
formattedString | Object | O | 메시지베이스 포맷 |
tmpltName | String | O | 메시지베이스 명 |
Response
키 | - | 타입 | 설명 |
code | String | 결과 코드 | |
message | String | 실패 시 결과 메시지 | |
data | 성공 시 데이터 | ||
messagebaseId | String | 메시지베이스 ID | |
pagination | |||
limit | Integer | 조회 최대 건수 (기본:100, 최대:1000) |
|
offset | Integer | 시작 offset 번호 (기본:0) | |
total | Integer | 총 개수 |
메시지베이스 수정
-
브랜드 내에서 사용할 메시지베이스를 수정합니다.
메시지베이스 수정은 승인상태에 따라 처리 여부가 결정됩니다. 템플릿 수정 시에는 기존에 사용된 messagebaseformId 를 동일한 cardType(cell, description)에 한하여 변경할 수 있습니다. (상태: 저장, 반려)
-
POST /rcsapi/v1/brand/msgbase/update
-
Content-Type: application/json; charset=utf-8
Request
키 | 타입 | 필수 | 설명 |
brandld | String | O | BizCenter 에서 생성한 브랜드 ID |
custTmpltld | String | O | 사용자 지정 템플릿 ID (정규식패턴: ^[0-9A-Za-z]{1,25}$) |
messagebaseld | String | O | 메시지베이스 ID |
messagebaseformld | String | O | 메시지베이스 폼 ID (정규식패턴: ^[0-9A-Za-z]{1,10}$) |
formattedString | String | O | 메시지베이스 포맷 |
tmpltName | String | O | 메시지베이스 명 |
Response
키 | - | 타입 | 설명 |
code | String | 결과 코드 | |
message | String | 실패 시 결과 메시지 | |
data | 성공 시 데이터 | ||
messagebaseId | String | 메시지베이스 ID | |
pagination | |||
limit | Integer | 조회 최대 건수 (기본:100, 최대:1000) |
|
offset | Integer | 시작 offset 번호 (기본:0) | |
total | Integer | 총 개수 |
메시지베이스 등록 v2
-
브랜드 내에서 사용할 메시지베이스을 등록합니다.
모든 메시지베이스 등록이 가능합니다. 템플릿 등록 시 사용되는 messagebaseformId의 params의 각 항목 중 메시지베이스에 표시될 내용을 입력하여 원하는 메시지베이스을 등록할 수 있습니다. 등록된 메시지베이스는 RCS Biz Center 운영자의 승인이 필요합니다.
-
POST /rcsapi/v1/brand/msgbase/v2/create
-
Content-Type: application/json; charset=utf-8
Request
키 | 타입 | 필수 | 설명 |
brandld | String | O | BizCenter 에서 생성한 브랜드 ID |
messagebaseformId | String | O |
메시지베이스 폼 ID (정규식패턴: ^[0-9A-Za-z]{1,10}$) |
custTmpltld | String | O | 사용자 지정 템플릿 ID (정규식패턴: ^[0-9A-Za-z]{1,25}$) |
tmpltName | String | O | 메시지베이스 명 |
body | Array | O | *BODY 참조 |
buttons | Array | X |
메시지베이스에 삽입할 버튼정보 * BUTTONS 참조 |
Response
키 | - | 타입 | 설명 |
code | String | 결과 코드 | |
message | String | 실패 시 결과 메시지 | |
data | 성공 시 데이터 | ||
messagebaseId | String | 메시지베이스 ID |
-
이미 등록된 템플릿의 내용을 수정합니다. messagebase의 ID를 유지하면서 내용을 변경하고자 하는 경우 사용이 가능합니다. 수정 등록된 템플릿은 RCS Biz Center 운영자의 승인이 필요합니다.
-
POST /rcsapi/v1/brand/msgbase/v2/update
-
Content-Type: application/json; charset=utf-8
Request
키 | 타입 | 필수 | 설명 |
brandld | String | O | BizCenter 에서 생성한 브랜드 ID |
messagebaseId | String | O | 메시지베이스 ID |
messagebaseformId | String | O |
메시지베이스 폼 ID (정규식패턴: ^[0-9A-Za-z]{1,10}$) |
tmpltName | String | O | 메시지베이스 명 |
body | Array | O | *BODY 참조 |
buttons | Array | X |
메시지베이스에 삽입할 버튼정보 * BUTTONS 참조 |
Response
키 | - | 타입 | 설명 |
code | String | 결과 코드 | |
message | String | 실패 시 결과 메시지 | |
data | 성공 시 데이터 | ||
messagebaseId | String | 메시지베이스 ID |
BODY
-
messagebaseform JSON의 ROOT.params[n-1] object의 type 이 file, string 인 경우, 각 속성에 맞는 데이터 Object를 사용하여 템플릿을 구성합니다.
-
messageabseform JSON의 ROOT.params[n-1].isMandatory 가 true 이면 템플릿 등록을 위해 필수로 등록해야 하는 요소이므로 반드시 데이터를 설정해야 템플릿 등록이 가능합니다.
-
변수 mTitleMedia, itemMedia 에 사용할 이미지는 브랜드 로고(logo) 등록 후 발급된 fileId를 지정해야 합니다.
키 | 타입 | 필수 | 설명 |
param | String | O |
1. ROOT.params[n-1].type == string messagebaseform JSON의 ROOT.params[n-1].param 과 동일한 값으로 템플릿 구성 Text의 표시 위치에 해당합니다. ex) "description" 2. ROOT.params[n-1].type == string messagebaseform JSON의 ROOT.params[n-1].param 과 동일한 값으로 템플릿 구성 Text의 표시 위치에 해당합니다. ex) "description" |
value | String | O |
1. ROOT.params[n-1].type == string 영역에 지정할 Text 형식에 맞게 입력해야 합니다.
2. ROOT.params[n-1].type == file 템플릿에 지정할 File(이미지) - maapfile://{fileId} 형식으로 입력합니다. |
decoration | Object | X | StringObject에서 사용되는 text서식 *DECORATION 참조 |
lineIndex | Integer | X |
템플릿에 Line을 행별로 표시합니다. 현재는 스타일(Cell) 템플릿에서 Text 행 아래 삽입되며 총 9개까지 지원합니다. lineIndex 값은 템플릿 내의 지정 위치 값을 의미 합니다. 예를 들어 lineIndex 2는 두번째 Text 행 아래 입니다. ex) 2 |
DECORATION
키 | 타입 | 필수 | 설명 |
textSize | String | X | 글자 크기 지정시 사용합니다. 숫자 뒤에 단위 dp를 반드시 붙여서 입력하여야 합니다. ex) 16dp |
textAlignment | String | X |
문장 정렬 지정시 사용합니다. 지원하는 정렬의 종류는 다음과 같습니다.
|
textStyle | String | X | 문장의 글자를 굵게 표현할 때 사용합니다. ex) "bold" |
textColor | String | X | 문장의 글자 색상을 지정한 색상 값으로 설정합니다. - 색상코드 Hex 표현식 ex) "#232323" |
height | String | X | Line의 굵기 지정시 사용합니다. 숫자 뒤에 단위 dp를 반드시 붙여서 입력하여야 합니다. ex) "0.3dp" |
background | String | X |
Line 색상을 지정한 색상 값으로 설정합니다. - 색상코드 Hex 표현식 ex) "#232323" |
BUTTONS
-
템플릿에 버튼을 설정하는 경우 지정합니다. 이통사 발송규격에서 제공되는 buttons와 동일한 사용 방식으로 템플릿에 표시되는 버튼을 지정할수 있습니다.
-
이미지 템플릿 슬라이드형의 경우 buttons 배열 내 object가 각 카드에 해당하며, object 하위 suggestions 배열 내에 messagebaseform의 policyInfo.maxButtonCount 지정 숫자만큼 버튼을 등록할 수 있습니다.
키 | 타입 | 설 |
suggestions | array of 'suggestions' | *SUGGESTIONS 참조 |
SUGGESTIONS
키 | 타입 | 설 |
action | json | *ACTION 참조 |
ACTION
-
action의 displayText, postback을 제외한 action 하위 항목에 다음과 같이 변수부를 지정할 수 있습니다.
키 타입 필수 urlAction Object X openUrl Object O url String O postParameter String X halfView String X clipboardAction Object X copyToClipboard Object O text String O calendarAction Object X createCalendarEvent Object O startTime String O endTime String O title String O description String O fallbackUrl String X dialerAction Object X dialPhoneNumber Object O phoneNumber String O fallbackUrl String X mapAction Object X showLocation Object O location Object O latitude String O longitude String O label String O fallbackUrl String O composeAction Object X composeTextMessage Object O phoneNumber String O text String O displayText Object O postback Object O data String O
※ API 등록 시 각 Action 구분 별 postback.data를 반드시 삽입해서 등록해야 합니다.
ACTION 규격 Examples
Action 구분 | A2P 전송시, Button 데이터 예시 | 비고 |
urlAction | { "action": { "urlAction": { "openUrl": { "url": "https://www.google.com" } }, "displayText": "Open website or deep link", "postback": { "data": "set_by_chatbot_open_url" } } } |
|
mapAction | { "action": { "mapAction": { "showLocation": { "location": { "latitude": 37.4220041, "longitude": -122.0862515, "label": "Googleplex" }, "fallbackUrl": "https://www.google.com/maps/@37.4219162,-122.078063,15z" } }, "displayText": "Show location on a map", "postback": { "data": "set_by_chatbot_show_location" } } } |
좌표 입력 |
{ "action": { "mapAction": { "showLocation": { "location": { "query": "restaurants" }, "fallbackUrl": "https://www.google.com/maps/search/restaurants" } }, "displayText": "Search location(s) on map", "postback": { "data": "set_by_chatbot_search_locations" } } } |
쿼리 입력 | |
{ "action": { "mapAction": { "requestLocationPush": {} }, "displayText": "Request a geo location", "postback": { "data": "set_by_chatbot_request_location_push" } } } |
내 위치 보내기 | |
calendarAction | { "action": { "calendarAction": { "createCalendarEvent": { "startTime": "2017-03-14T00:00:00Z", "endTime": "2017-03-14T23:59:59Z", "title": "Meeting", "description": "GSG review meeting" } }, "displayText": "Schedule Meeting", "postback": { "data": "set_by_chatbot_create_calendar_event" } } } |
|
clipboardAction | { "action": { "clipboardAction": { "copyToClipboard": { "text": "COUPONE-1234-1234" } }, "displayText": "복사하기", "postback": { "data": "set_by_chatbot_copy_to_clipboard" } } } |
|
composeAction | { "action": { "composeAction": { "composeTextMessage": { "phoneNumber": "01098056433", "text": "가나다라마바가나다라마바사 가아아아아아" } }, "displayText": "메시지 보내기", "postback": { "data": "set_by_chatbot_compose_text_message" } } } |
|
dialerAction | { "action": { "dialerAction": { "dialPhoneNumber": { "phoneNumber": "+1650253000" } }, "displayText": "Call a phone number", "postback": { "data": "set_by_chatbot_dial_phone_number" } } } |
메시지베이스 삭제
-
브랜드 내에서 지정된 메시지베이스를 삭제합니다.
메시지베이스 삭제는 승인상태에 따라 처리 여부가 결정됩니다.
한번 삭제된 메시지베이스는 복원이 불가능하며 동일한 ID로 생성할 수 없습니다.
-
POST /rcsapi/v1/brand/msgbase/remove
-
Content-Type: application/json; charset=utf-8
Request
키 | 타입 | 필수 | 설명 |
brandId | String | O | BizCenter 에서 생성한 브랜드 ID |
messagebaseId | String | O | 메시지베이스 ID |
Response
키 | - | 타입 | 설명 |
code | String | 결과 코드 | |
message | String | 실패 시 결과 메시지 | |
data | 성공 시 데이터 | ||
messagebaseId | String | 메시지베이스 ID | |
pagination | |||
limit | Integer | 조회 최대 건수 (기본:100, 최대:1000) |
|
offset | Integer | 시작 offset 번호 (기본:0) | |
total | Integer | 총 개수 |
메시지베이스 목록 조회
-
브랜드에 등록된 메시지베이스 목록을 조회합니다.
-
GET /rcsapi/v1/brand/msgbase/list
-
Query Parameter
Request
키 | 타입 | 필수 | 설명 |
brandld | String | O | BizCenter 에서 생성한 브랜드 ID |
limit | Integer | X | 조회 최대 건수 (기본 : 100, 최대 : 1000) |
offset | Integer | X | 시작 offset 번호 (기본 : 0) |
Response
키 | - | 타입 | 설명 |
code | String | 결과 코드 | |
message | String | 실패 시 결과 메시지 | |
data | 성공 시 데이터 | ||
approvalDate | String | 메시지베이스 승인 일시 | |
approvalReason | String | 승인 사유 | |
approvalResult | String | 승인 상태 | |
brandId | String | 브랜드 ID | |
groupId | String | 그룹 ID | |
messagebaseId | String | 메시지베이스 ID | |
messagebaseformId | String | 메시지베이스 폼 ID | |
registerDate | String | 메시지베이스 등록 일시 | |
registerId | String | 메시지베이스 등록 계정 ID | |
status | String | 메시지베이스 상태 | |
tmpltName | String | 메시지베이스 명 | |
updateDate | String | 메시지베이스 수정 일시 | |
updateId | String | 메시지베이스 수정 계정 ID | |
pagination | |||
limit | Integer | 조회 최대 건수 (기본:100, 최대:1000) |
|
offset | Integer | 시작 offset 번호 (기본:0) | |
total | Integer | 총 개수 |
메시지베이스 상세 조회
-
브랜드에 등록된 지정 메시지베이스의 상세 내역을 조회합니다.
-
GET /rcsapi/v1/brand/msgbase/info
-
Query Parameter
Request
키 | 타입 | 필수 | 설명 |
brandId | String | O | BizCenter 에서 생성한 브랜드 ID |
messagebaseId | String | O | 메시지베이스 ID |
Response
키 | - | 타입 | 설명 |
code | String | 결과 코드 | |
message | String | 실패 시 결과 메시지 | |
data | 성공 시 데이터 | ||
agecyId | String | ||
approvalDate | String | 메시지베이스 승인 일시 | |
approvalReason | String | 승인 사유 | |
approvalResult | String | 승인 상태 | |
attribute | Array | ||
brandId | String | 브랜드 ID | |
cardType | String | 카드 종류 (Cell, Description, Free) | |
formattedString | Object | 메시지베이스 포맷 | |
groupId | String | 그룹 ID | |
guideInfo | Object | ||
inputText | String | ||
messagebaseId | String | 메시지베이스 ID | |
messagebaseformId | String | 메시지베이스 폼 ID | |
params | Array | ||
policyInfo | Object | ||
registerDate | String | 메시지베이스 등록 일시 | |
registerId | String | 메시지베이스 등록 계정 ID | |
spec | String | ||
status | String | 메시지베이스 상태 | |
tmpltName | String | 메시지베이스 명 | |
updateDate | String | 메시지베이스 수정 일시 | |
updateId | String | 메시지베이스 수정 계정 ID | |
pagination | |||
limit | Integer | 조회 최대 건수 (기본:100, 최대:1000) |
|
offset | Integer | 시작 offset 번호 (기본:0) | |
total | Integer | 총 개수 |
메시지베이스 양식 목록 조회
-
오픈리치카드 템플릿 작성이 필요한 경우 조회된 템플릿 양식 ID를 이용하여 messagebaseform 세부정보를 조회합니다.
-
GET /rcsapi/v1/msgbaseform/list
-
Query Parameter
Request
키 | 타입 | 필수 | 설명 |
bizCategory | String | X | 유형 그룹 (Description, Cell 에서만 사용 / 일반, 금용, 교통 등) |
bizCondition | String | X | 대상 업태 (기본: all) |
bizService | String | X | 유형 (승인, 입금, 출금 등) |
cardType | String | X | 카드 종류 (Cell, Description, Free) |
limit | Integer | X | 조회 최대 건수 (기본 : 100, 최대 : 1000) |
offset | Integer | X | 시작 offset 번호 (기본:0) |
Response
키 | - | 타입 | 설명 |
code | String | 결과 코드 | |
message | String | 실패 시 결과 메시지 | |
data | 성공 시 데이터 | ||
bizCategory | String | 유형 그룹 (Description, Cell 에서만 사용 / 일반, 금용, 교통 등) |
|
bizCondition | Array | 대상 업태 (기본: all) | |
bizService | String | 유형 (승인, 입금, 출금 등) | |
cardType | String | 카드 종류 (Cell, Description, Free) | |
formName | String | 폼 명 | |
messagebaseformId | String | 메시지베이스 폼 ID | |
registerDate | String | 등록 일자 | |
updateDate | String | 수정 일자 | |
pagination | |||
limit | Integer | 조회 최대 건수 (기본:100, 최대:1000) |
|
offset | Integer | 시작 offset 번호 (기본:0) | |
total | Integer | 총 개수 |
메시지베이스 유형 상세 조회
-
메시지베이스 유형의 상세 내용을 조회합니다.
formattedString 을 이용하여 원하는 브랜드용 메시지베이스를 작성할 수 있습니다.
-
GET /rcsapi/v1/msgbaseform/info
-
Query Parameter
Request
키 | 타입 | 필수 | 설명 |
messagebaseformId | String | O | 메시지 베이스 ID |
Response
키 | - | 타입 | 설명 |
code | String | 결과 코드 | |
message | String | 실패 시 결과 메시지 | |
data | 성공 시 데이터 | ||
bizCategory | String | 유형 그룹 (Description, Cell 에서만 사용 / 일반, 금용, 교통 등) |
|
bizCondition | Array | 대상 업태 (기본: all) | |
bizService | String | 유형 (승인, 입금, 출금 등) | |
cardType | String | 카드 종류 (Cell, Description, Free) | |
formName | String | 폼 명 | |
formattedString | Object | 메시지베이스 포맷 | |
guideInfo | Object | ||
mediaUrl | Array | ||
messagebaseformId | String | 메시지베이스 폼 ID | |
params | Array | ||
policyInfo | Object | ||
productCode | String | ||
spec | String | ||
registerDate | String | 등록 일자 | |
updateDate | String | 수정 일자 | |
pagination | |||
limit | Integer | 조회 최대 건수 (기본:100, 최대:1000) |
|
offset | Integer | 시작 offset 번호 (기본:0) | |
total | Integer | 총 개수 |
이통사 제공 메시지베이스 목록 조회
-
리치카드 규격의 SMS, LMS, MMS 용 메시지베이스를 조회합니다. (현재 리치카드는 비즈니스 유형 별로 제공되는 항목은 없습니다.)
-
GET /rcsapi/v1/msgbase/common/list
-
Query Parameter
Request
키 | 타입 | 필수 | 설명 |
cardType | String | X | 카드 종류 (standalone, standalone media top, standalone horizontal, carousel medium, carousel small) |
productCode | String | X | 상품 코드 (sms, lms, mms) |
limit | Integer | X | 조회 최대 건수 (기본 : 100, 최대 : 1000) |
offset | Integer | X | 시작 offset 번호 (기본:0) |
Response
키 | - | 타입 | 설명 |
code | String | 결과 코드 | |
message | String | 실패 시 결과 메시지 | |
data | 성공 시 데이터 | ||
approvalDate | String | 메시지베이스 승인 일시 | |
approvalReason | String | 승인 사유 | |
approvalResult | String | 승인 상태 | |
brandId | String | 브랜드 ID | |
groupId | String | 그룹 ID | |
messagebaseId | String | 메시지베이스 ID | |
messagebaseformId | String | 메시지베이스 폼 ID | |
registerDate | String | 메시지베이스 등록 일시 | |
registerId | String | 메시지베이스 등록 계정 ID | |
status | String | 메시지베이스 상태 | |
tmpltName | String | 메시지베이스 명 | |
updateDate | String | 메시지베이스 수정 일시 | |
updateId | String | 메시지베이스 수정 계정 ID | |
pagination | |||
limit | Integer | 조회 최대 건수 (기본:100, 최대:1000) | |
offset | Integer | 시작 offset 번호 (기본:0) | |
total | Integer | 총 개수 |
이통사 제공 메시지베이스 상세 조회
-
이통사가 기본 제공하는 메시지베이스의 상세 내용을 조회합니다.
리치카드 규격의 SMS, LMS, MMS 용 메시지베이스를 조회합니다. 비즈니스 유형에 따라 조회할 수 있습니다.
-
GET /rcsapi/v1/msgbse/common/info
-
Query Parameter
Request
키 | 타입 | 필수 | 설명 |
messagebaseId | String | O | 메시지베이스 ID |
Response
키 | - | 타입 | 설명 |
code | String | 결과 코드 | |
message | String | 실패 시 결과 메시지 | |
data | 성공 시 데이터 | ||
agecyId | String | ||
approvalDate | String | 메시지베이스 승인 일시 | |
approvalReason | String | 승인 사유 | |
approvalResult | String | 승인 상태 | |
attribute | Array | ||
brandId | String | 브랜드 ID | |
cardType | String | 카드 종류 (Cell, Description, Free) | |
formattedString | Object | 메시지베이스 포맷 | |
groupId | String | 그룹 ID | |
guideInfo | Object | ||
inputText | String | ||
messagebaseId | String | 메시지베이스 ID | |
messagebaseformId | String | 메시지베이스 폼 ID | |
params | Array | ||
policyInfo | Object | ||
registerDate | Integer | 메시지베이스 등록 일시 | |
registerId | Integer | 메시지베이스 등록 계정 ID | |
spec | Integer | ||
status | Integer | 메시지베이스 상태 | |
tmpltName | Integer | 메시지베이스 명 | |
updateDate | Integer | 메시지베이스 수정 일시 | |
updateId | Integer | 메시지베이스 수정 계정 ID | |
pagination | |||
limit | Integer | 조회 최대 건수 (기본:100, 최대:1000) | |
offset | Integer | 시작 offset 번호 (기본:0) | |
total | Integer | 총 개수 |
댓글
댓글 0개
이 문서에는 댓글을 달 수 없습니다.