トーク共通プロパティ
メッセージの送信時に利用可能なプロパティです。
クイック返信
クイック返信 (quick reply) ボタンが含まれているメッセージを受信すると、メンバーのトーク画面下部にクイック返信ボタンが表示されます。
メンバーはボタンの中から 1 つを選んで簡単に返信できます。
クイック返信は全てのメッセージタイプで利用可能です。ボタンは最大 13 個まで設定できます。
クイック返信で使用できる動作は次の通りです。
- postback
- message
- URI
- camera (iOS および Android のみ可)
- camera roll (iOS および Android のみ可)
- location (iOS および Android のみ可)
各クイック返信ボタンにはアイコンを指定できます。
- ボタンのタイプが「camera」「cameraRoll」「location」でアイコンが未指定の場合、既定のアイコンが表示されます。
- ボタンのタイプが「postback」「message」「uri」でアイコンが未指定の場合、アイコンは表示されません。
参照
- クイック返信ボタンは v2.6 以降のアプリケーションのみ表示されます。
図1 クイック返信の構造
Request Content
common
パラメータ | タイプ | 必須 | 説明 |
---|---|---|---|
quickReply | object | N | クイック返信オブジェクト |
quickReply.items | array | Y | クイック返信ボタンオブジェクト 最大13個 |
quickReply.items[].imageUrl | string | N | ボタンの前に表示されるアイコンの URL(PNG 形式、HTTPS のみ)。imageUrl、imageResourceId のいずれか一方のみ。 最大サイズ:1MB 最大文字数:1000 文字 |
quickReply.items[].action | Action Object | Y | ボタンを押した時の動作 |
resourceId, multi language
パラメータ | タイプ | 必須 | 説明 |
---|---|---|---|
quickReply.items[].i18nImageUrl | array | N | 多言語の画像 URL リスト |
quickReply.items[].i18nImageUrl[].language | string | Y | 言語コード ●ja_JP ●ko_KR ●zh_CN ●zh_TW ●en_US |
quickReply.items[].i18nImageUrl[].thumbnailImageUrl | string | Y | 画像 URL(PNG 形式、HTTPSのみ) 最大サイズ:1MB 最大文字数:1000 文字 |
quickReply.items[].imageResourceId | string | N | 画像のリソース ID imageUrl、imageResourceId のいずれか一方のみ。 最大サイズ:1MB |
quickReply.items[].i18nImageResourceIds[] | array | N | 多言語の画像リソース ID リスト |
quickReply.items[].i18nImageResourceIds[].language | string | Y | 言語コード ●ja_JP ●ko_KR ●zh_CN ●zh_TW ●en_US |
quickReply.items[].i18nImageResourceIds[].imageResourceId | string | Y | 画像のリソースID 最大サイズ:1MB |
Request Example
quick reply structure
"quickReply": {
"items": [
{
"imageUrl": "https://www.example.com/a.png",
"action": {
"type": "message",
"label": "Send message",
"text": "send message"
}
},
{
"action": {
"type": "camera",
"label": "Open camera"
}
}
]
}
text with quick reply
{
"accountId": "admin@example.com",
"content": {
"type": "text",
"text": "Please select your favorite food category!",
"quickReply": {
"items": [
{
"imageUrl": "https://www.example.com/a.png",
"action": {
"type": "message",
"label": "Sushi",
"text": "Sushi"
}
},
{
"imageUrl": "https://www.example.com/b.png",
"action": {
"type": "message",
"label": "Italian",
"text": "Italian"
}
},
{
"action": {
"type": "camera",
"label": "Open Camera"
}
}
]
}
}
}
flexible template with quick reply
{
"accountId": "admin@example.com",
"content": {
"type": "flex",
"altText": "This is a flexible template with quick reply",
"contents": {
"type": "bubble",
"size": "mega",
"hero": {
"type": "box",
"layout": "vertical",
"contents": [
{
"type": "text",
"text": "YOU ARE INVITED!",
"size": "xl",
"color": "#ffffff",
"weight": "bold",
"align": "center",
"wrap": true
}
],
"backgroundColor": "#81DBA0",
"paddingAll": "15px"
}
},
"quickReply": {
"items": [
{
"imageUrl": "https://www.example.com/a.png",
"action": {
"type": "message",
"label": "Accept",
"text": "Accept"
}
},
{
"imageUrl": "https://www.example.com/b.png",
"action": {
"type": "message",
"label": "Decline",
"text": "Decline"
}
}
]
}
}
}
メンバーへのメンション
Bot が参加するトークルームの特定のメンバーまたはすべてのメンバーにメンションしてメッセージを送信することができます。
参考
- メンション機能に関する詳細は、ガイドページのメンションをご参照ください。
- 最大50名までメンションできます。
メンバーへのメンションに対応しているメッセージ送信タイプと指定可能なパラメータは次のとおりです。
- Text:textパラメータ
- Link:contentTextパラメータ
- Button template:contentTextパラメータ
- Flexible template
特定のメンバーへのメンション
特定のメンバーにメンションする場合、次のようなフォーマットでメッセージを作成します。
メンションされたメンバーの accountId は、メンバーの名前に変更して送信されます。
Hello, <m accountId="{accountId}">
=> Hello, @{userName}
参考
- Botが参加しているすべてのトークルームで使用できます。
- 多言語のメンションメッセージを送信する時は、すべての多言語メッセージに同じメンバーがメンションされる必要があります。
すべてのメンバーへのメンション
すべてのメンバーにメンションする場合、次のようなフォーマットでメッセージを作成します。
Hi, <m accountId="all">
=> Hi, @All
参考
- Bot 1:1トークルームを除き、Botが参加しているすべてのトークルームで使用できます。
- 多言語のメンションメッセージを送信する時は、すべての多言語メッセージにすべてのメンバーがメンションされる必要があります。
Request Example
Text タイプ
{
"accountId": "admin@example.com",
"content": {
"type": "text",
"text": "Hello, <m accountId=\"admin@example.com\">"
}
}
Link タイプ
{
"accountId": "admin@example.com",
"content": {
"type": "link",
"contentText": "<m accountId=\"admin@example.com\">, please refer to the link.",
"linkText": "link text",
"link": "http://www.worksmobile.com"
}
}
Button template タイプ
{
"accountId": "admin@example.com",
"content": {
"type": "button_template",
"contentText": "<m accountId=\"admin@example.com\">, please refer to the link.",
"actions": [{
"type": "uri",
"label": "WorksMobile Homepage",
"uri": "https://line.worksmobile.com"
}, {
"type": "message",
"label": "FAQ",
"postback": "ButtonTemplate_FAQ"
}]
}
}