RCS Biz Center

공통포맷 조회

Request

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

get
/messagebase/common

이통사가 기본 제공하는 공통템플릿을 조회합니다. 공통템플릿은 SMS, LMS, MMS와 양방향 대화방용 CHAT 상품으로 구성되어 있습니다.

  • 계정 권한 : 마스터, 매니저, 대행사

Authorizations
AuthorizationstringRequired

인증방식은 JWT인증을 사용합니다. 토큰의 갱신은 없으며 토큰 만료 시 항상 재발급 받아야 합니다.

Query parameters
productCodestring · enumOptional

리치카드 메시지 유형 구분값 입니다.

Possible values:
cardTypestring · enumOptional

MMS에서 제공되는 메시지 카드 형태 구분값 입니다.

Possible values:
bizServicestring · enumOptionalDeprecated

서비스 내 업무 유형별 제공되는 항목으로 초기 텍스트 템플릿 한정 구분자 입니다.

이미지템플릿, LMS템플릿, 공통 포맷은 해당되지 않습니다.

Possible values:
offsetintegerOptional

시작 offset 번호(default: 0) 입니다.

Default: 0
limitinteger · min: 100 · max: 1000Optional

minimum: 100, maximum: 1000 - 조회 최대 건수(default: 100) 입니다.'

Default: 100
Responses
200

페이지 내 Response 섹션 참조

No content
get
/messagebase/common
200

페이지 내 Response 섹션 참조

No content

Response

필드명
타입
길이
필수여부
기본값
설명

result

array<object>

O

Messagebase 기본 정보입니다.

code

string

5

O

20000000

status

integer

3

O

200

desc

string

O

pagination

object

O

전체 건수와 페이징 조건을 제공합니다.

links

object

O

이전/다음 페이지 링크를 제공합니다. offset을 0이 아닌 limit보다 작은 양수값으로 설정한 경우 prev 는 null로 응답됩니다.

result - array<object>

필드명
타입
길이
필수여부
기본값
설명

groupId

string

템플릿이 대량등록된 경우 그룹ID 입니다.

messagebaseId

string

40

템플릿 ID

tmpltName

string

40

템플릿 등록시 입력된 템플릿 명칭입니다.

messagebaseformId

string

40

템플릿의 원형인 템플릿 양식 ID 입니다.

brandId

string

템플릿이 등록되어 있는 브랜드 ID 입니다. 공통으로 사용하는 템플릿인 경우 'common'으로 표시됩니다.

status

string

템플릿의 상태를 표시합니다.

  • ready : 사용

  • pause : 사용중지

approvalResult

string

템플릿의 승인 상태입니다.

  • 저장 : RCS Biz Center 홈페이지에서 템플릿 정보를 입력하고 승인요청 하지 않고 저장해 둔 상태입니다. 저장 상태의 템플릿은 승인요청을 해야 승인대기 상태로 변경됩니다.

  • 승인대기 : 템플릿 등록 직후 검수 이전 상태입니다.

  • 검수시작 : 템플릿 검수가 시작된 상태입니다.

  • 승인 : 검수가 완료되어 이통3사에 정보 등록까지 최종 완료되어 RCS 메시지를 발송할 수 있는 상태입니다.

  • 반려 : 검수 시 승인이 불가하여 반려된 상태입니다. 반려된 템플릿은 수정 후 다시 승인요청 할 수 있습니다.

  • 검수완료 : RCS Biz Center에서 검수 승인 하였으나 이통사 3사 등록이 완료되지 않은 상태로 RCS 메시지를 발송할 수 없습니다.

  • 승인대기(수정) : 승인된 템플릿 변경 승인요청 직후 검수 이전 상태입니다.

  • 검수시작(수정) : 승인된 템플릿 변경으로 승인요청된 템플릿 검수가 시작된 상태입니다.

  • 반려(수정) : 승인된 템플릿 변경 검수 처리 결과 반려된 상태입니다.

  • 검수완료(수정) : 승인된 브랜드 변경 검수 승인은 되었으나 이통3사 정보 등록이 완료되지 않은 상태입니다. 현재 상태에서는 이통사에 따라 단말 브랜드 홈 정보가 다를 수 있습니다

approvalReason

string

승인 사유

registerDate

string

템플릿 등록일시

approvalDate

string

템플릿 승인일시

updateDate

string

템플릿 수정일시

registerId

string

20

템플릿 등록 계정 ID

updateId

string

20

템플릿 수정 계정 ID

pagination - object

필드명
타입
길이
필수여부
기본값
설명

total

integer

O

전체건수

offset

integer

O

0

조회 기준 위치

limit

integer

O

100

페이지 당 조회 건수

links - object

필드명
타입
길이
필수여부
기본값
설명

prev

string

O

이전페이지URL

next

string

O

다음페이지URL

❖ response body sample

error code는 RCS Biz Center - Response body error code 참조

Previous공통포맷Next공통포맷 상세 조회

Last updated

Was this helpful?