List Template
봇이 리스트 템플릿을 전송할 수 있다.
템플릿의 버튼을 이용하여 메시지에 postback 파라미터를 추가시켜 callback으로 서버에서 수신할 수 있다. 메시지 형식은 메시지 수신을 참고한다.
메시지는 다국어로 전송할 수 있다. 다국어 메시지는 클라이언트의 단말기 언어 설정에 맞게 표시된다.
이미지는 URL 방식과 파일 ID 방식으로 전송할 수 있다. URL 방식은 HTTPS만 허용한다. 파일 ID 방식은 콘텐츠 업로드로 획득한 파일 ID를 사용한다.
리스트 템플릿의 구조는 다음과 같다.
참고
- 파일 ID를 사용하는 경우 메시지를 발송할 때마다 이미지의 크기만큼 수신인의 도메인 공용 용량에서 차감된다.
- 리스트 템플릿의 항목은 최대 4개까지 등록할 수 있다.
- 리스트 템플릿 아래의 버튼은 최대 2행, 2열로 등록할 수 있다.
Request Content {#list-request}
common {#list-request-common}
| 파라미터 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
| type | string | Y | "list_template"으로 고정 |
| coverData | object | N | 커버 데이터에 들어갈 데이터 |
| coverData.backgroundImageUrl | string | N | 커버 데이터의 배경 이미지가 위치한 URL(PNG 형식, HTTPS만 허용) backgroundImageUrl, backgroundFileId 중 하나만 지정해야 하며, 필수는 아니다. 최대 글자수: 1000자 |
| coverData.backgroundFileId | string | N | 커버 데이터의 배경 이미지에 대한 파일 ID. backgroundImageUrl, backgroundFileId 중 하나만 지정해야 하며, 필수는 아니다. 최대 크기: 1MB |
| coverData.title | string | N | 커버 데이터의 제목 최대 글자수: 1000자 |
| coverData.subtitle | string | N | 커버 데이터의 부제목 최대 글자수: 1000자 |
| elements | array<object> | Y | 리스트 템플릿에 추가될 항목 |
| elements[].title | string | Y | 각 항목의 제목 최대 글자수: 1000자 |
| elements[].subtitle | string | N | 각 항목의 부제목 최대 글자수: 1000자 |
| elements[].originalContentUrl | string | N | 각 항목의 이미지가 위치한 URL(PNG 형식, HTTPS만 허용) originalContentUrl, fileId 중 하나만 지정해야 하며, 필수는 아니다. 최대 글자수: 1000자 |
| elements[].fileId | string | N | 각 항목의 이미지에 대한 파일 ID. originalContentUrl, fileId 중 하나만 지정해야 하며, 필수는 아니다. 최대 크기: 1MB |
| elements[].action | array<Action Object> | N | 각 항목에 사용될 버튼 |
| actions[][] | array<array<Action Object>> | N | 아래에 위치할 버튼. 첫 번째 배열은 행, 두 번째 배열은 열을 나타낸다. |
multi language {#list-request-multilang}
| 파라미터 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
| coverData.i18nBackgroundImageUrls[] | array | N | 다국어 커버 데이터의 배경 이미지가 위치한 URL 목록 |
| coverData.i18nBackgroundImageUrls[].language | string | Y | 다국어 언어 코드 • ko_KR • ja_JP • zh_CN • zh_TW • en_US |
| coverData.i18nBackgroundImageUrls[].backgroundImageUrl | string | Y | 다국어 커버 데이터의 배경 이미지가 위치한 URL(PNG 형식, HTTPS만 허용) 최대 글자수: 1000자 |
| coverData.i18nBackgroundFileIds[] | array | N | 다국어 커버 데이터의 배경 이미지에 대한 파일 ID 목록 |
| coverData.i18nBackgroundFileIds[].language | string | Y | 다국어 언어 코드 • ko_KR • ja_JP • zh_CN • zh_TW • en_US |
| coverData.i18nBackgroundFileIds[].backgroundFileId | string | Y | 다국어 커버 데이터의 배경 이미지에 대한 파일 ID. 최대 크기: 1MB |
| coverData.i18nTitles[] | array | N | 다국어 커버 데이터의 제목 목록 |
| coverData.i18nTitles[].language | string | Y | 다국어 언어 코드 • ko_KR • ja_JP • zh_CN • zh_TW • en_US |
| coverData.i18nTitles[].title | string | Y | 다국어 커버 데이터의 제목 최대 글자수: 1000자 |
| coverData.i18nSubtitles[] | array | N | 다국어 커버 데이터의 부제목 목록 |
| coverData.i18nSubtitles[].language | string | Y | 다국어 언어 코드 • ko_KR • ja_JP • zh_CN • zh_TW • en_US |
| coverData.i18nSubtitles[].subtitle | string | Y | 다국어 커버 데이터의 부제목 최대 글자수: 1000자 |
| elements[].i18nTitles[] | array | N | 다국어 각 항목의 제목 목록 |
| elements[].i18nTitles[].language | string | Y | 다국어 언어 코드 • ko_KR • ja_JP • zh_CN • zh_TW • en_US |
| elements[].i18nTitles[].title | string | Y | 다국어 각 항목의 제목 최대 글자수: 1000자 |
| elements[].i18nSubtitles[] | array | N | 다국어 각 항목의 부제목 목록 |
| elements[].i18nSubtitles[].language | string | Y | 다국어 언어 코드 • ko_KR • ja_JP • zh_CN • zh_TW • en_US |
| elements[].i18nSubtitles[].subtitle | string | Y | 다국어 각 항목의 부제목 최대 글자수: 1000자 |
| elements[].i18nOriginalContentUrls[] | array | N | 다국어 각 항목의 이미지가 위치한 URL 목록 |
| elements[].i18nOriginalContentUrls[].language | string | Y | 다국어 언어 코드 • ko_KR • ja_JP • zh_CN • zh_TW • en_US |
| elements[].i18nOriginalContentUrls[].originalContentUrl | string | Y | 다국어 각 항목의 이미지가 위치한 URL(PNG 형식, HTTPS만 허용) 최대 글자수: 1000자 |
| elements[].i18nFileIds[] | array | N | 다국어 각 항목의 이미지에 대한 파일 ID 목록 |
| elements[].i18nFileIds[].language | string | Y | 다국어 언어 코드 • ko_KR • ja_JP • zh_CN • zh_TW • en_US |
| elements[].i18nFileIds[].fileId | string | Y | 다국어 각 항목의 이미지에 대한 파일 ID. 최대 크기: 1MB |
Request Example {#list-request-example}
{ "content": { "type": "list_template", "coverData": { "backgroundImageUrl": "https://example.com/example.png" }, "elements": [{ "title": "Homepage", "subtitle": "Press the button to visit.", "action": { "type": "uri", "label": "Visit", "uri": "https://example.com/example.png" } }, { "title": "FAQ", "subtitle": "Talk with bot.", "originalContentUrl": "https://example.com/example.png", "action": { "type": "message", "label": "Talk", "postback": "ListTemplate_Talk" } }], "actions": [[{ "type": "message", "label": "View more", "postback": "ListTempalte_ViewMore" }]] }}