템플릿 목록 조회
Changed on채널에 등록된 알림톡 템플릿들의 목록을 조회합니다. 검수 상태별 필터링, 검색, 페이징 기능을 지원합니다.
Request
- Base URLhttps://api.sendon.io
- AuthHTTP basic
Path parameters
템플릿 목록을 조회할 채널의 ID입니다.
Query parameters
템플릿 목록의 정렬 기준입니다. CREATED_AT은 생성일 기준, RECENT_USED는 최근 사용일 기준으로 정렬합니다.
조회할 템플릿의 검수 상태를 필터링합니다. 지정하지 않으면 모든 상태의 템플릿을 조회합니다.
페이징을 위한 커서 값입니다. 다음 페이지를 요청할 때 이전 응답에서 받은 cursor 값을 사용하세요.
한 번에 조회할 템플릿의 최대 개수입니다. 기본값은 20개이며, 최대 100개까지 설정할 수 있습니다.
템플릿 이름이나 내용에서 검색할 키워드입니다. 부분 일치로 검색됩니다.
Response
템플릿 목록 조회 요청의 처리 결과입니다. 검색 조건에 맞는 템플릿 목록과 페이징 정보가 포함됩니다.
Example response
{
"code": 200,
"message": "OK",
"data": {
"templates": [
{
"profileId": "profile_12345",
"id": "template_67890",
"templateName": "주문 확인 알림 템플릿",
"status": "APPROVED",
"templateMessageType": "BA",
"templateEmphasizeType": "TEXT",
"templateContent": "안녕하세요 #{고객명}님, 주문이 완료되었습니다.",
"buttons": [
{
"name": "자세히 보기",
"ordering": 1,
"urlMobile": "https://example.com/mobile",
"urlPc": "https://example.com/pc"
}
],
"fallback": {
"groupId": "004a6217-f06c-40f6-8f39-bf35b3f76111"
},
"templateComments": [
{
"commentContent": "템플릿 내용이 명확하지 않아 수정이 필요합니다.",
"commentCreateAt": "2024-01-15T10:30:00Z",
"commentSeqno": 1,
"commentStatus": "ACTIVE",
"commentUserName": "검수담당자",
"regBy": "admin@example.com",
"regDate": "2024-01-15T10:30:00Z",
"updateBy": "admin@example.com",
"updateDate": "2024-01-15T11:00:00Z"
}
],
"templateTitle": "123,456원",
"templateSubtitle": "승인내역",
"templateImageName": "template_banner.png",
"templateImageUrl": "https://example.com/images/template_banner.png",
"templateExtra": "■ 이용안내\n- 운영시간: 평일 09:00~18:00\n- 고객센터: 1588-1234\n- 홈페이지: https://shop.example.com\n\n※ 주말/공휴일 배송불가",
"createdAt": "2024-01-01T09:00:00Z",
"updatedAt": "2024-01-15T10:30:00Z",
"syncedAt": "2024-01-15T11:00:00Z",
"lastUsedAt": "2024-01-15T12:00:00Z"
}
],
"nextCursor": "cursor_template_12345"
}
}Changes
- breaking
the
response's property type changed fromobjectto no type for status - breaking
removed the required property
/from the response with the status - warning
removed the optional property
/from the response with the status - info
api operation id
getTemplatesremoved and replaced withTemplateController_getTemplates - info
the endpoint scheme security
basicwas added to the API - info
added to the
response propertyallOflist for the response status - info
the response property
became required for the status - info
the response property
became required for the status - info
the
response's property default value200was removed for the status - info
the
response's property default value성공was removed for the status
- breaking