템플릿 양식 목록 조회

Request

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

get
/messagebase/messagebaseform

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

템플릿 작성이 필요한 경우 조회된 템플릿 양식 ID를 이용하여 템플릿 양식 세부정보를 조회합니다.

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

Authorizations
AuthorizationstringRequired

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

Query parameters
cardTypestring · enumOptionalPossible values:
bizConditionstringOptional

업태

bizCategorystringOptional

업종

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/messagebaseform
200

페이지 내 Response 섹션 참조

No content

Response

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

array<object>

O

MessagebaseForm 기본 정보입니다.

code

string

5

O

20000000

status

integer

3

O

200

desc

string

O

object

O

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

object

O

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

result - array<object>

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

messagebaseformId

array<object>

40

O

템플릿 양식 ID 입니다.

formName

string

40

O

20000000

템플릿 양식명 입니다.

cardType

integer

64

200

카드종류를 구분합니다. 향후 추가될 수 있습니다. [openrichcard]

  • Description

  • Cell

  • Free

bizCondition

array<string>

양식을 사용할 수 있는 대상 업태의 목록입니다.

bizCategory

string

20

Description, Cell의 유형그룹 입니다.

bizService

string

20

Description, Cell의 세부 유형 입니다.

registerDate

string

템플릿 양식 등록일시 입니다.

updateDate

string

템플릿 양식 수정일시 입니다.

pagination - object

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

total

integer

O

전체건수

offset

integer

O

0

조회 기준 위치

limit

integer

O

100

페이지 당 조회 건수

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

prev

string

O

이전페이지URL

next

string

O

다음페이지URL

❖ response body sample

Last updated

Was this helpful?