# 共通仕様
Messaging APIにおいて、リクエストが成功・失敗した際のレスポンス、レート制限などの共通仕様です。
# レート制限
Messaging APIでは、エンドポイントごとに以下のレート制限が適用されます。レート制限は、ご利用のプランおよびエンドポイントによって異なります。
注意
レート制限を著しく超えて、長時間送信し続けた場合は、リクエストの受け付けを停止することがあります。
※秒単位のレート制限は、大量送信時の目安です。
# ステータスコード
Messaging APIからは以下のステータスコードが返されます。
| ステータスコード | 説明 |
|---|---|
| 200 OK | リクエストが成功しました。 |
| 400 Bad Request | リクエストに問題があります。 |
| 401 Unauthorized | 有効なチャネルアクセストークンが指定されていません。 |
| 403 Forbidden | リソースにアクセスする権限がありません。ご契約中のプランやアカウントに付与されている権限を確認してください。 |
| 429 Too Many Requests |
|
| 500 Internal Server Error | 内部サーバーのエラーです。 |
# レスポンスヘッダー
Messaging APIのレスポンスには以下のHTTPヘッダーが含まれます。
| レスポンスヘッダー | 説明 |
|---|---|
| X-Line-Request-Id | リクエストID。各リクエストに発行されるIDです。 |
| X-Line-Accepted-Request-Id | 同じリトライキーを使ってすでにリクエストが受理されている場合、そのリクエストのx-line-request-idを示します。 |
# エラーレスポンス
エラー発生時は、以下のJSONデータを含むレスポンスボディが返されます。
message
String
エラー情報を含むメッセージ。詳しくは、「エラーメッセージ」を参照してください。
details[].message
String
エラーの詳細。特定の状況では返されません。
details[].property
String
エラーの発生箇所。特定の状況では返されません。
エラーレスポンスの例
# エラーメッセージ
エラーのJSONレスポンスのmessageプロパティに含まれる、主なエラーメッセージは以下のとおりです。
| メッセージ | 説明 |
|---|---|
| The request body has X error(s) | リクエストボディのJSONデータにエラーがありました。Xの部分にエラーの数が表示されます。詳細はdetails[].messageプロパティとdetails[].propertyプロパティに含まれます。 |
| Invalid reply token | 応答メッセージで使用された応答トークンが無効です。 |
| The property, XXX, in the request body is invalid (line: XXX, column: XXX) | リクエストボディに無効なプロパティが指定されていました。XXXの部分に具体的な行と列が表示されます。 |
| The request body could not be parsed as JSON (line: XXX, column: XXX) | リクエストボディのJSONデータを解析できませんでした。XXXの部分に具体的な行と列が表示されます。 |
| The content type, XXX, is not supported | APIでサポートされていないコンテンツタイプがリクエストされました。 |
| Authentication failed due to the following reason: XXX | APIが呼び出されたときに認証に失敗しました。XXXの部分に理由が表示されます。 |
| Access to this API is not available for your account | 実行権限がないAPIを呼び出しました。 |
| Failed to send messages | メッセージの送信に失敗しました。指定したユーザーIDが存在しない場合などにこのエラーが発生します。 |
| You have reached your monthly limit. | 追加メッセージ数の上限目安を超過しました。 |
# Webhook
友だち追加やメッセージの送信のようなイベントが発生すると、LINEプラットフォームからWebhook URL（ボットサーバー）にHTTPS POSTリクエストが送信されます。
Webhook URLはチャネルごとにLINE Developersコンソールで設定します。
イベント処理を非同期化することを推奨します
HTTP POSTリクエストの処理が後続のイベントの処理に遅延を与えないよう、イベント処理を非同期化することを推奨します。
# リクエストヘッダー
X-Line-Signature
署名の検証に使う署名
# リクエストボディ
リクエストボディは、Webhookイベントを受信すべきボットのユーザーIDとWebhookイベントオブジェクトの配列を含むJSONオブジェクトです。
destination
String
Webhookイベントを受信すべきボットのユーザーID。ユーザーIDの値は、U[0-9a-f]{32}の正規表現にマッチする文字列です。
events
Webhookイベントのリスト。LINEプラットフォームから疎通確認のために、空のリストが送信される場合があります。
# レスポンス
LINEプラットフォームから送信されるHTTP POSTリクエストをボットサーバーで受信したときは、ステータスコード200を返してください。
注意
LINEプラットフォームから送信されるHTTP POSTリクエストは、送受信に失敗しても再送されません。
LINEプラットフォームから疎通確認のために、Webhookイベントが含まれないHTTP POSTリクエストが送信されることがあります。 この場合も、ステータスコード
200を返してください。Webhookイベントが含まれないHTTP POSTリクエストの例：
{ "destination": "xxxxxxxxxx", "events": [] }
# 署名を検証する
リクエストがLINEプラットフォームから送られたことを確認するために、ボットサーバーでリクエストヘッダーのX-Line-Signatureに含まれる署名を検証します。
検証の手順は以下のとおりです。
- チャネルシークレットを秘密鍵として、HMAC-SHA256アルゴリズムを使用してリクエストボディのダイジェスト値を取得します。
- ダイジェスト値をBase64エンコードした値と、リクエストヘッダーの
X-Line-Signatureに含まれる署名が一致することを確認します。
署名検証の例
# Webhookイベントオブジェクト
LINEプラットフォームで生成されるイベントを含むJSONオブジェクトです。
これらのイベントオブジェクトのプロパティは、値が存在しない場合があります。値が存在しないプロパティは、生成されるイベントオブジェクトに含まれません。
Messaging APIの機能に追加または変更があったときに、イベントオブジェクトの構造が変更される場合があります。この変更には、プロパティの追加、プロパティの順序の変化、データの要素間の空白や改行の有無が含まれます。将来、従来と異なる構造のイベントオブジェクトを受信しても不具合が発生しないように、サーバーを実装してください。
Webhookイベントオブジェクトの例
# 共通プロパティ
以下のプロパティはすべてのWebhookイベントオブジェクトに含まれます。
type
String
イベントのタイプを表す識別子
mode
String
チャネルの状態。
active：チャネルがアクティブです。このWebhookイベントを受信したボットサーバーから、返信メッセージやプッシュメッセージなど送信できます。standby（実装予定）：チャネルが待機状態です。このWebhookイベントを受信したボットサーバーは、メッセージの送信を控えてください。
timestamp
Number
イベントの発生時刻（ミリ秒）
modeプロパティが変更されるタイミングについて
modeプロパティは、チャネルの管理者が「チャネルの多重化」（実装予定）を行うと、standbyに切り替わります。modeプロパティが自動的にstandbyになることはありません。
現在は、受信チャネルの多重化を行う機能は提供されていません。
# 送信元ユーザー
type
String
user
userId
String
送信元ユーザーのID
送信元ユーザーの例
# 送信元グループ
送信元グループの例
# 送信元トークルーム
送信元トークルームの例
# メッセージイベント
送信されたメッセージを含むWebhookイベントオブジェクトです。
メッセージのタイプに対応するメッセージオブジェクトが、messageプロパティに含まれます。メッセージイベントには応答できます。
# テキスト
送信元から送られたテキストを含むメッセージオブジェクトです。
id
String
メッセージID
type
String
text
text
String
メッセージのテキスト。textにLINE絵文字が含まれる場合は、emojisプロパティにLINE絵文字オブジェクトの配列が格納されます。
emojis
LINE絵文字オブジェクトの配列
1個以上のLINE絵文字。Unicodeで定義された絵文字や古いバージョンのLINE絵文字は正しく取得できないことがあります。
emojis[].index
Number
テキストの先頭を0とした、textプロパティ内の絵文字の開始位置。
emojis[].length
Number
LINE絵文字の文字列の長さ。LINE絵文字(hello)であれば、7が長さになります。
emojis[].productId
String
LINE絵文字の集合を示すプロダクトID。プロダクトIDの例として、「Sendable LINE emoji list」を参照してください。
emojis[].emojiId
String
プロダクトID内のLINE絵文字のID。LINE絵文字のIDの例として、「Sendable LINE emoji list」を参照してください。
テキストメッセージの例
# 画像
送信元から送られた画像を含むメッセージオブジェクトです。
id
String
メッセージID
type
String
image
contentProvider.type
String
画像ファイルの提供元。
line：LINEユーザーが画像ファイルを送信しました。バイナリの画像データはcontentエンドポイントから取得できます。external：LIFFのliff.sendMessages()メソッドで画像ファイルが送信されました。詳しくは、『LIFF APIリファレンス』の「liff.sendMessages()」を参照してください。
contentProvider.originalContentUrl
String
画像ファイルのURL。contentProvider.typeがexternalの場合にのみ含まれます。
contentProvider.previewImageUrl
String
プレビュー画像のURL。contentProvider.typeがexternalの場合にのみ含まれます。
画像メッセージの例
# 動画
送信元から送られた動画を含むメッセージオブジェクトです。トーク画面に表示されている画像はプレビュー画像で、画像をタップすると動画が表示されます。
id
String
メッセージID
type
String
video
duration
Number
動画ファイルの長さ（ミリ秒）
contentProvider.type
String
動画ファイルの提供元。
line：LINEユーザーが動画ファイルを送信しました。バイナリの動画データはcontentエンドポイントから取得できます。external：LIFFのliff.sendMessages()メソッドで動画ファイルが送信されました。詳しくは、『LIFF APIリファレンス』の「liff.sendMessages()」を参照してください。
contentProvider.originalContentUrl
String
動画ファイルのURL。contentProvider.typeがexternalの場合にのみ含まれます。
contentProvider.previewImageUrl
String
プレビュー画像のURL。contentProvider.typeがexternalの場合にのみ含まれます。
動画メッセージの例
# 音声
送信元から送られた音声を含むメッセージオブジェクトです。
id
String
メッセージID
type
String
audio
duration
Number
音声ファイルの長さ（ミリ秒）
contentProvider.type
String
音声ファイルの提供元。
line：LINEユーザーが音声ファイルを送信しました。バイナリの音声データはcontentエンドポイントから取得できます。external：LIFFのliff.sendMessages()メソッドで音声ファイルが送信されました。詳しくは、『LIFF APIリファレンス』の「liff.sendMessages()」を参照してください。
contentProvider.originalContentUrl
String
音声ファイルのURL。contentProvider.typeがexternalの場合にのみ含まれます。
音声メッセージの例
# ファイル
送信元から送られたファイルを含むメッセージオブジェクトです。バイナリデータはcontentエンドポイントから取得できます。
id
String
メッセージID
type
String
file
fileName
String
ファイル名
fileSize
Number
ファイルサイズ（バイト）
ファイルメッセージの例
# 位置情報
送信元から送られた位置情報データを含むメッセージオブジェクトです。
id
String
メッセージID
type
String
location
title
String
タイトル
address
String
住所
latitude
Decimal
緯度
longitude
Decimal
経度
位置情報メッセージの例
# スタンプ
送信元から送られたスタンプデータを含むメッセージオブジェクトです。 LINEの基本的なスタンプとスタンプIDについては、スタンプリストを参照してください。
スタンプ画像
ユーザーが送信したスタンプ画像を取得することはできません。
id
String
メッセージID
type
String
sticker
packageId
String
パッケージID
stickerId
String
スタンプID
stickerResourceType
String
スタンプのリソースタイプ。以下のいずれかの値です。
STATIC：静止画スタンプANIMATION：アニメーションスタンプSOUND：サウンドスタンプANIMATION_SOUND：アニメーション＋サウンドスタンプPOPUP：ポップアップスタンプまたはエフェクトスタンプPOPUP_SOUND：ポップアップ＋サウンドスタンプまたはエフェクト＋サウンドスタンプNAME_TEXT：カスタムスタンプ。スタンプのテキストを取得できるAPIはありません。PER_STICKER_TEXT：メッセージスタンプ。スタンプのテキストを取得できるAPIはありません。
スタンプのリソースタイプについて
今後、新しいリソースタイプが予告なく追加される可能性があります。将来、従来と異なるリソースタイプを受信しても不具合が発生しないように、サーバーを実装してください。
スタンプメッセージの例
# 送信取消イベント
ユーザーがグループまたはトークルームで、メッセージの送信を取り消したことを示すイベントです。
送信取消イベントの例
# フォローイベント
LINE公式アカウントが友だち追加またはブロック解除されたことを示すイベントです。フォローイベントには応答できます。
フォローイベントの例
# フォロー解除イベント
LINE公式アカウントがブロックされたことを示すイベントです。
timestamp、sourceなど
「共通プロパティ」を参照してください。
type
String
unfollow
フォロー解除イベントの例
# 参加イベント
LINE公式アカウントがグループまたはトークルームに参加したことを示すイベントです。参加イベントには応答できます。
参加イベントが送信されるタイミングはグループとトークルームで異なります。
- グループの場合：ユーザーがLINE公式アカウントを招待したときに送信されます。
- トークルームの場合：LINE公式アカウントがトークルームに追加された後で、最初に何らかのイベントが発生したときに送信されます。例えば、ユーザーがメッセージを送ったり、ユーザーがトークルームに追加されたりしたときです。
参加イベントの例
# 退出イベント
ユーザーがグループからLINE公式アカウントを削除したか、LINE公式アカウントがグループまたはトークルームから退出したことを示すイベントです。
timestamp、sourceなど
「共通プロパティ」を参照してください。
type
String
leave
退出イベントの例
# メンバー参加イベント
メンバー参加イベントの例
# メンバー退出イベント
メンバー退出イベントの例
# ポストバックイベント
ユーザーが、ポストバックアクションを実行したことを示すイベントオブジェクトです。ポストバックイベントには応答できます。
timestamp、sourceなど
「共通プロパティ」を参照してください。
type
String
postback
replyToken
String
このイベントへの応答に使用するトークン
postback.data
String
ポストバックデータ
Object
ポストバックイベントの例
# postback.paramsオブジェクト
日時選択アクションを介してユーザーが選択した日時を含むオブジェクトです。full-date、time-hour、およびtime-minuteの形式は、RFC3339プロトコルで定義されています。
| プロパティ | 形式 | 説明 |
|---|---|---|
| date | full-date | ユーザーが選択した日付。dateモードの場合にのみ含まれます。 |
| time | time-hour ":" time-minute | ユーザーが選択した時刻。timeモードの場合にのみ含まれます。 |
| datetime | full-date "T" time-hour ":" time-minute | ユーザーが選択した日付と時刻。datetimeモードの場合にのみ含まれます。 |
postback.paramsオブジェクトの例
# 動画視聴完了イベント
LINE公式アカウントから送信されたtrackingIdが指定された動画の視聴を、ユーザーが少なくとも一回最後まで視聴したことを示すイベントです。
動画の視聴回数について
動画視聴完了イベントは、ユーザーの動画視聴回数を示すものではありません。
トークルーム上で複数回動画を視聴しても、重複してイベントが発生することはありません。ただし、一度トークルームを閉じた後で再度開き動画を視聴すると、再びイベントが発生する場合があります。
type
String
videoPlayComplete
replyToken
String
このイベントへの応答に使用するトークン
videoPlayComplete.trackingId
String
動画を識別するためのID。動画メッセージに付与したtrackingIdと同じ値を返します。
動画視聴完了イベントの例
# ビーコンイベント
ビーコンの電波の受信圏にユーザーが入ったことを示すイベントオブジェクトです。ビーコンイベントには応答できます。
timestamp、sourceなど
「共通プロパティ」を参照してください。
type
String
beacon
replyToken
String
このイベントへの応答に使用するトークン
beacon.hwid
String
検出されたビーコンのハードウェアID
beacon.type
String
ビーコンイベントのタイプ。「ビーコンイベントのタイプ」を参照してください。
beacon.dm
String
検出されたビーコンのデバイスメッセージ。このメッセージは、ボットサーバーへの通知を目的としてビーコンにより生成されるデータです。Device messageプロパティをサポートするデバイスからのWebhookイベントにのみ含まれます。
詳しくは、LINE Simple Beaconの仕様を参照してください。
ビーコンイベントの例
# ビーコンイベントのタイプ
| beacon.type | 説明 |
|---|---|
enter | ユーザーがビーコンの電波の受信圏に入りました。 |
leave | 【2020年末に廃止予定】 |
banner | ユーザーがビーコンバナーをタップしました。 |
stay | ユーザーがビーコンの電波の受信圏に滞在しています。 このイベントは、最短10秒間隔で繰り返し送信されます。 |
bannerおよびstayイベントの利用をご希望の場合は、LINE for Businessウェブサイトからお問い合わせください。
# アカウント連携イベント
ユーザーがLINEアカウントとプロバイダーが提供するサービスのアカウントを連携したことを示すイベントオブジェクトです。アカウント連携イベントには応答できます。
連携トークンの期限が切れている、または使用済みの場合は、Webhookイベント自体が送信されず、ユーザーにエラーが表示されます。
timestamp、sourceなど
「共通プロパティ」を参照してください。
type
String
accountLink
replyToken
String
このイベントへの応答に使用するトークン。連携に失敗した場合はこの値は含まれません。
link
Object
linkオブジェクト。アカウント連携が成功したかどうかと、プロバイダーのサービスのユーザーIDから生成したnonce（number used once）が含まれます。
アカウント連携イベントの例
# linkオブジェクト
result
String
連携が成功したかどうかを示す値。以下のどちらかになります。
ok：連携が成功したことを示します。failed：ユーザーのすり替えなどが原因で、連携が失敗したことを示します。
nonce
String
linkオブジェクトの例
# デバイス連携イベント
ユーザーの操作により、デバイスとLINEが連携されたことを示すイベントです。
timestamp、sourceなど
「共通プロパティ」を参照してください。
type
String
things
replyToken
String
このイベントへの応答に使用するトークン
things.deviceId
String
LINEと連携されたデバイスのデバイスIDです。
things.type
String
link
LINE Things用のREST APIを使うと、Webhookイベントで取得したデバイスIDから、ユーザーが連携または連携解除したデバイスを特定できます。APIについて詳しくは、『LINE Things APIリファレンス』の「デバイスIDを指定して、プロダクトIDとPSDIを取得する」を参照してください。
デバイス連携イベントの例
# デバイス連携解除イベント
ユーザーの操作により、デバイスとLINEの連携が解除されたことを示すイベントです。
timestamp、sourceなど
「共通プロパティ」を参照してください。
type
String
things
replyToken
String
このイベントへの応答に使用するトークン
things.deviceId
String
LINEと連携解除されたデバイスのデバイスIDです。
things.type
String
unlink
LINE Things用のREST APIを使うと、Webhookイベントで取得したデバイスIDから、ユーザーが連携または連携解除したデバイスを特定できます。APIについて詳しくは、『LINE Things APIリファレンス』の「デバイスIDを指定して、プロダクトIDとPSDIを取得する」を参照してください。
デバイス連携解除イベントの例
# LINE Thingsシナリオ実行イベント
自動通信のシナリオが実行されたことを示すイベントです。
シナリオセットごとにまとめて実行結果が返されるのではなく、シナリオごとに実行結果が返されます。
注意
実行結果が返される順序は、シナリオの順序とは無関係です。
timestamp、sourceなど
「共通プロパティ」を参照してください。
type
String
things
replyToken
String
このイベントへの応答に使用するトークン
things.deviceId
String
シナリオを実行したデバイスのデバイスID
things.type
String
scenarioResult
things.result.scenarioId
String
実行されたシナリオID
things.result.revision
Number
実行したシナリオを含むシナリオセットのリビジョン
things.result.startTime
Number
シナリオのアクションの実行が開始された時刻（ミリ秒。LINEアプリの時刻）
things.result.endTime
Number
シナリオの実行が完了した時刻（ミリ秒。LINEアプリの時刻）
things.result.resultCode
String
シナリオの実行完了ステータス
詳しくは、「things.result.resultCodeの定義」を参照してください。
things.result.actionResults
Array
「アクション (Action)」に含まれる、個々のアクションコマンドの実行結果
なお、シナリオに記述した「アクション (Action)」については、以下の性質があります
- シナリオに記述したアクションコマンドは、先頭から順にひとつずつ実行されます。
- 個々のアクションコマンドは、実行されると、何らかの結果が生成されます。
SLEEPのようにデータを生成しないアクションの場合も、void型の実行結果が返されます。 - リストの要素数が0の場合もあります。
したがって、things.result.actionResultsは以下のような性質をもちます
- リストの要素数と、シナリオで定義されたアクション数は同じです。
- シナリオ内で、実行されたアクションの順に、実行結果が格納されます。つまり、GATT_READを3回実行するシナリオの場合、GATT_READした順にデータが格納されます。
- リストの要素数が0の場合は、
things.result.actionResultsの要素数が0になります。
things.result.actionResults[].type
String
void、binary
- 実行されたアクションの
typeに依存します。 things.result.actionResultsが空でない場合は必ず含まれます。
things.result.actionResults[].data
String
Base64形式でエンコードされたバイナリデータ
things.result.actionResults[].typeがbinaryの場合は、必ず含まれます。
things.result.bleNotificationPayload
String
Notificationで受け取ったデータ
Base64形式でエンコードされたバイナリデータです。なお、trigger.type = BLE_NOTIFICATIONのシナリオの場合のみ、必ず含まれます。
things.result.errorReason
String
エラー理由
LINE Thingsシナリオ実行イベントの例
# things.result.resultCodeの定義
| resultCode | 説明 |
|---|---|
| success | 実行が正常に完了したことを示す |
| gatt_error | GATTオペレーションの実行が失敗したことを示す
|
| runtime_error | 予想外のエラーが発生したことを示す
|
# OAuth
アプリからMessaging APIを呼び出す際に必要となるチャネルアクセストークンを発行、取得、取り消しします。
# チャネルアクセストークンv2.1を発行する
チャネルアクセストークンを発行します。このメソッドでは、認証にJWTアサーションを使用できます。
トークンは最大30個まで発行できます。上限に達した場合、追加発行のリクエストは拒否されます。
リクエストの例
# HTTPリクエスト
POST https://api.line.me/oauth2/v2.1/token
# リクエストヘッダー
Content-Type
application/x-www-form-urlencoded
# リクエストボディー
grant_type
String
client_credentials
client_assertion_type
String
urn:ietf:params:oauth:client-assertion-type:jwt-bearer
client_assertion
String
JSON Web Tokenを指定します。JSON Web Tokenはクライアントが作成したうえで、アサーション署名キーを発行する際に作成された秘密鍵で署名しておく必要があります。
JWTの有効期限
JSON Web Tokenの有効期限は、作成されてから30分後です。
JWTの生成について詳しくは、「JWTを生成する」を参照してください。
# レスポンス
ステータスコード200と以下の情報を含むJSONオブジェクトを返します。
access_token
String
チャネルアクセストークン
expires_in
Number
チャネルアクセストークンが発行されてから有効期限が切れるまでの秒数
token_type
String
Bearer
key_id
String
チャネルアクセストークンを識別するための一意のキーID
レスポンスの例
# エラーレスポンス
HTTPステータスコード400と以下の情報を含むJSONオブジェクトを返します。
error
String
エラーの概要
error_description
String
エラーの詳細。特定の状況では返されません。
エラーレスポンスの例
# すべての有効なチャネルアクセストークンv2.1のキーIDを取得する
すべての有効なチャネルアクセストークンのキーIDを取得します。
リクエストの例
# HTTPリクエスト
GET https://api.line.me/oauth2/v2.1/tokens/kid
# リクエストボディ
client_assertion_type
String
urn:ietf:params:oauth:client-assertion-type:jwt-bearer
client_assertion
String
クライアントが作成し、秘密鍵で署名する必要があるJSON Web Token (JWT)です。
# レスポンス
ステータスコード200と以下の情報を含むJSONオブジェクトを返します。
kids
Array of strings
チャネルアクセストークンのキーIDの配列
レスポンスの例
# エラーレスポンス
HTTPステータスコード400と以下の情報を含むJSONオブジェクトを返します。
error
String
エラーの概要
error_description
String
エラーの詳細。特定の状況では返されません。
エラーレスポンスの例
# チャネルアクセストークンv2.1を取り消す
チャネルアクセストークンを取り消します。
リクエストの例
# HTTPリクエスト
POST https://api.line.me/oauth2/v2.1/revoke
# リクエストボディ
client_id
String
チャネルID
client_secret
String
チャネルシークレット
access_token
String
チャネルアクセストークン
# レスポンス
ステータスコード200と空のレスポンスボディを返します。
注意
無効なチャネルアクセストークンを指定した場合も、エラーレスポンスは発生しません。
# エラーレスポンス
HTTPステータスコード400と以下の情報を含むJSONオブジェクトを返します。
error
String
エラーの概要
error_description
String
エラーの詳細。特定の状況では返されません。
エラーレスポンスの例
# チャネルアクセストークンを発行する
30日間有効な短期のチャネルアクセストークンを発行します。
チャネルごとに最大で30件のトークンを発行できます。上限を超過した場合は、最も古いチャネルアクセストークンが取り消されます。
ヒント
- Messaging APIのチャネルの場合は、長期のチャネルアクセストークンや任意の有効期間を指定できるチャネルアクセストークンv2.1を発行できます。
詳しくは、『Messaging APIドキュメント』の「チャネルアクセストークン」を参照してください。 - LINEログインのチャネルのチャネルアクセストークンも、このAPIで発行できます。
LINEログインのチャネルのチャネルアクセストークンは、LIFF v1のサーバーAPIで利用します。
リクエストの例
# HTTPリクエスト
# リクエストヘッダー
Content-Type
application/x-www-form-urlencoded
# リクエストボディ
grant_type
String
必須
client_credentials
client_id
String
必須
チャネルID。LINE Developersコンソールで確認できます。
client_secret
String
必須
チャネルシークレット。LINE Developersコンソールで確認できます。
# レスポンス
HTTPステータスコード200と以下の情報を含むJSONオブジェクトを返します。
access_token
String
短期のチャネルアクセストークン。有効期間は30日です。
注意
チャネルアクセストークンは更新できません。
expires_in
Number
チャネルアクセストークンが発行されてから有効期限が切れるまでの秒数
token_type
String
Bearer
レスポンスの例
# エラーレスポンス
HTTPステータスコード400と以下の情報を含むJSONオブジェクトを返します。
error
String
エラーの概要
error_description
String
エラーの内容。特定の状況では返されません。
エラーレスポンスの例
# チャネルアクセストークンを取り消す
チャネルアクセストークンを取り消すAPIです。
リクエストの例
# HTTPリクエスト
# リクエストヘッダー
Content-Type
application/x-www-form-urlencoded
# リクエストボディ
access_token
String
必須
チャネルアクセストークン
# レスポンス
ステータスコード200と空のレスポンスボディを返します。無効なチャネルアクセストークンを指定した場合はエラーが返りません。
# エラーレスポンス
HTTPステータスコード400と以下の情報を含むJSONオブジェクトを返します。
error
String
エラーの概要
error_description
String
エラーの内容。特定の状況では返されません。
エラーレスポンスの例
# メッセージ
メッセージを送ったり、送信済みメッセージについての情報を取得したりできます。
# 応答メッセージを送る
ユーザー、グループ、またはトークルームからのイベントに対して応答メッセージを送信するAPIです。
応答メッセージを送るには、Webhookイベントオブジェクトに含まれる応答トークンが必要です。
イベントが発生するとWebhookを使って通知されます。応答できるイベントには応答トークンが発行されます。
応答トークンは一定の期間が経過すると無効になるため、メッセージを受信したらすぐに応答を返す必要があります。応答トークンは1回のみ使用できます。
リクエストの例
# HTTPリクエスト
POST https://api.line.me/v2/bot/message/reply
# リクエストヘッダー
Content-Type
application/json
Authorization
Bearer {channel access token}
# リクエストボディ
replyToken
String
必須
Webhookで受信する応答トークン
messages
メッセージオブジェクトの配列
必須
送信するメッセージ
最大件数：5
notificationDisabled
Boolean
任意
true：メッセージ送信時に、ユーザーに通知されない。false：メッセージ送信時に、ユーザーに通知される。ただし、LINEで通知をオフにしている場合は通知されません。
デフォルト値はfalseです。
# レスポンス
ステータスコード200と空のJSONオブジェクトを返します。
レスポンスの例
# プッシュメッセージを送る
ユーザー、グループ、またはトークルームに、任意のタイミングでプッシュメッセージを送信するAPIです。
リクエストの例
# HTTPリクエスト
POST https://api.line.me/v2/bot/message/push
# リクエストヘッダー
Content-Type
application/json
Authorization
Bearer {channel access token}
# リクエストボディ
to
String
必須
送信先のID。Webhookイベントオブジェクトで返される、userId、groupId、またはroomIdの値を使用します。LINEに表示されるLINE IDは使用しないでください。
messages
メッセージオブジェクトの配列
必須
送信するメッセージ
最大件数：5
notificationDisabled
Boolean
任意
true：メッセージ送信時に、ユーザーに通知されない。false：メッセージ送信時に、ユーザーに通知される。ただし、LINEで通知をオフにしている場合は通知されません。
デフォルト値はfalseです。
# レスポンス
ステータスコード200と空のJSONオブジェクトを返します。
レスポンスの例
# マルチキャストメッセージを送る
複数のユーザーに、任意のタイミングでプッシュメッセージを送信するAPIです。グループまたはトークルームにメッセージを送ることはできません。
リクエストの例
# HTTPリクエスト
POST https://api.line.me/v2/bot/message/multicast
# リクエストヘッダー
Content-Type
application/json
Authorization
Bearer {channel access token}
# リクエストボディ
to
文字列の配列
必須
ユーザーIDの配列。Webhookイベントオブジェクトで返されるuserIdの値を使用します。LINEに表示されるLINE IDは使用しないでください。
最大ユーザーID数：500
messages
メッセージオブジェクトの配列
必須
送信するメッセージ
最大件数：5
notificationDisabled
Boolean
任意
true：メッセージ送信時に、ユーザーに通知されない。false：メッセージ送信時に、ユーザーに通知される。ただし、LINEで通知をオフにしている場合は通知されません。
デフォルト値はfalseです。
# レスポンス
ステータスコード200と空のJSONオブジェクトを返します。
レスポンスの例
# ナローキャストメッセージを送る
インプレッションリターゲティング用のオーディエンスの一部が無効化されました
2020年3月30日 00:00～2020年4月22日 21:30に配信されたメッセージをもとに作成したインプレッションリターゲティング用のオーディエンスはすべて無効化されました。詳しくは、「「オーディエンス」と「分析」の一部APIの集計不具合のお知らせ」を参照してください。
複数のユーザーに、任意のタイミングでプッシュメッセージを送信します。送信対象は、属性情報（性別や年齢、OSの種類、地域など）やリターゲティング（オーディエンス）を利用して指定できます。グループまたはトークルームにメッセージを送ることはできません。
ナローキャストメッセージの使用制限について
送信対象のユーザーの属性を推測できないようにするために、送信対象が一定数よりも少ない場合はナローキャストメッセージを送信できません。
以下の点に注意してください。
- 属性情報を利用するには、100人以上のターゲットリーチが必要です。
- 送信対象が50人以上になるように、オーディエンスと属性情報を組み合わせてください。この基準が満たされない場合は、ナローキャストメッセージを送信できません。ただし、以下の場合は、送信対象が50人未満でも送信できます。
- 属性情報を利用せずにユーザーIDアップロード用のオーディエンスを使った場合
- チャットタグオーディエンスを使った場合
- ナローキャストメッセージを送信するときは、オーディエンス（レシピエントオブジェクト）は、合計10件まで指定できます。
配信可能なメッセージの上限数について
ナローキャストメッセージを送信するときは、recipientプロパティおよびfilter.demographicプロパティの設定にかかわらず、一時的にすべての友だちにメッセージを配信する前提で、配信予定メッセージ数が計算されます。配信予定メッセージ数が、当月分の上限目安を超えた場合は、ナローキャストメッセージを送信できません。
ただし、limit.maxプロパティで設定した最大送信数が、当月分の上限目安を超えなければ、ナローキャストメッセージを送信できます。
またlimit.upToRemainingQuotaプロパティをtrueにしておくことで、配信予定メッセージ数が、配信可能なメッセージの上限数を超えていてもエラーにはならず、上限数の範囲内で配信されます。
当月分の上限目安は、「追加メッセージ数の上限目安を取得する」エンドポイントで確認できます。
上限目安を設定する方法については、「Messaging APIの料金」を参照してください。
# HTTPリクエスト
POST https://api.line.me/v2/bot/message/narrowcast
# リクエストヘッダー
Authorization
Bearer {channel access token}
Content-Type
application/json
# リクエストボディ
messages
メッセージオブジェクトの配列
必須
送信するメッセージ
最大件数：5
recipient
Object
任意
レシピエントオブジェクト。合計10件までのオーディエンスや、過去に配信したナローキャストメッセージのリクエストIDを使用して、送信対象を指定します。
省略すると、LINE公式アカウントを友だち追加したすべてのユーザーが送信対象になります。
filter.demographic
Object
任意
デモグラフィックフィルターオブジェクト。友だちの属性情報を使用して、送信対象をフィルタリングできます。
省略すると、属性が「不明」になっているユーザーを含めた全員に配信されます。
limit.max
Number
任意
ナローキャストメッセージの最大送信数。このナローキャストメッセージによる送信数を制限する場合に指定します。なお送信対象は、無作為に抽出されます。
limit.upToRemainingQuota
Boolean
任意
trueを指定すると、配信可能な上限数の範囲内でメッセージを送信します。
デフォルト値はfalseです。
なお送信対象は、無作為に抽出されます。
notificationDisabled
Boolean
任意
true：メッセージ送信時に、ユーザーに通知されない。false：メッセージ送信時に、ユーザーに通知される。ただし、LINEで通知をオフにしている場合は通知されません。
デフォルト値はfalseです。
リクエストの例
# レシピエントオブジェクト
レシピエントオブジェクトは、オーディエンスオブジェクトまたは再配信オブジェクトを表すオブジェクトです。演算子オブジェクトを利用すると、条件を組み合わせて送信対象を指定できます。1回のリクエストごとに、レシピエントオブジェクトは、合計10件まで指定できます。
オーディエンスオブジェクト
type
String
必須audienceaudienceGroupId
Number
必須オーディエンスID。オーディエンスを作成するには、「オーディエンス管理」のAPIを使用します。
再配信オブジェクト
type
String
必須redeliveryrequestId
String
必須過去に配信したナローキャストメッセージのリクエストID。リクエストIDは、Messaging APIのリクエストごとに発行されるIDです。レスポンスヘッダーに含まれます。
指定できるリクエストIDにはいくつかの条件があります以下の条件をすべて満たすリクエストIDを、
requestIdプロパティで指定してください。- ナローキャストメッセージの配信によって発行されたリクエストIDであること
- 過去7日間以内の配信であること
- 送信処理が完了していること（「ナローキャストメッセージの進行状況を取得する」で、レスポンスの
phaseプロパティの値がsucceededであること）
演算子オブジェクト
積集合（AND）、和集合（OR）、差集合（NOT）を使用して、複数のレシピエントオブジェクトから、新たなレシピエントオブジェクトを作成できます。
type
String
必須operatorand
レシピエントオブジェクトの配列
※配列で指定したレシピエントオブジェクトの積集合（AND）を、新たなレシピエントオブジェクトとします。
or
レシピエントオブジェクトの配列
※配列で指定したレシピエントオブジェクトの和集合（OR）を、新たなレシピエントオブジェクトとします。
not
レシピエントオブジェクト
※指定したレシピエントオブジェクトを配信対象外にした、新たなレシピエントオブジェクトとします。
※
andプロパティ、orプロパティ、notプロパティのいずれか1つだけ、必ず指定してください。また、空配列は指定できません。
レシピエントオブジェクトの例
# デモグラフィックフィルターオブジェクト
デモグラフィックフィルターオブジェクトは、送信対象をフィルタリングする条件（性別、年齢、OSの種類、地域、友だち期間）を表すオブジェクトです。演算子オブジェクトを利用すると、条件を組み合わせて送信対象をフィルタリングできます。
属性情報の利用について
- 属性情報は3日前の属性情報を元に絞込みます。
- 属性を指定しない場合は、属性が「不明」になっているユーザーを含めた全員に配信されます。
- 属性情報を利用するには、100人以上のターゲットリーチが必要です。
性別
type
String
必須genderoneOf
Stringの配列
必須指定した性別を送信対象とします。以下のいずれかの値を指定します。
malefemale
年齢
年齢の範囲を指定してフィルタリングします。
type
String
必須agegte
String
※指定した年齢以上を送信対象とします。
以下のいずれかの値を指定します。age_15age_20age_25age_30age_35age_40age_45age_50
lt
String
※指定した年齢未満を送信対象とします。
gteプロパティと同じ値を指定できます。※
gteプロパティまたはltプロパティの両方またはいずれか一方を、必ず指定してください。OSの種類
type
String
必須appTypeoneOf
Stringの配列
必須指定したOSを送信対象とします。以下のいずれかの値を指定します。
iosandroid
地域
type
String
必須areaoneOf
Stringの配列
必須指定した地域を送信対象とします。以下のいずれかの値を指定します。
日本 // JP (country code=392)jp_01：北海道 // Hokkaidojp_02：青森県 // Aomorijp_03：岩手県 // Iwatejp_04：宮城県 // Miyagijp_05：秋田県 // Akitajp_06：山形県 // Yamagatajp_07：福島県 // Fukushimajp_08：茨城県 // Ibarakijp_09：栃木県 // Tochigijp_10：群馬県 // Gunmajp_11：埼玉県 // Saitamajp_12：千葉県 // Chibajp_13：東京都 // Tokyojp_14：神奈川県 // Kanagawajp_15：新潟県 // Niigatajp_16：富山県 // Toyamajp_17：石川県 // Ishikawajp_18：福井県 // Fukuijp_19：山梨県 // Yamanashijp_20：長野県 // Naganojp_21：岐阜県 // Gifujp_22：静岡県 // Shizuokajp_23：愛知県 // Aichijp_24：三重県 // Miejp_25：滋賀県 // Shigajp_26：京都府 // Kyotojp_27：大阪府 // Osakajp_28：兵庫県 // Hyougojp_29：奈良県 // Narajp_30：和歌山県 // Wakayamajp_31：鳥取県 // Tottorijp_32：島根県 // Shimanejp_33：岡山県 // Okayamajp_34：広島県 // Hiroshimajp_35：山口県 // Yamaguchijp_36：徳島県 // Tokushimajp_37：香川県 // Kagawajp_38：愛媛県 // Ehimejp_39：高知県 // Kouchijp_40：福岡県 // Fukuokajp_41：佐賀県 // Sagajp_42：長崎県 // Nagasakijp_43：熊本県 // Kumamotojp_44：大分県 // Oitajp_45：宮崎県 // Miyazakijp_46：鹿児島県 // Kagoshimajp_47：沖縄県 // Okinawa
台湾 // TW (country code=158)
tw_01：台北市 // Taipei Citytw_02：新北市 // New Taipei Citytw_03：桃園市 // Taoyuan Citytw_04：台中市 // Taichung Citytw_05：台南市 // Tainan Citytw_06：高雄市 // Kaohsiung Citytw_07：基隆市 // Keelung Citytw_08：新竹市 // Hsinchu Citytw_09：嘉義市 // Chiayi Citytw_10：新竹県 // Hsinchu Countytw_11：苗栗県 // Miaoli Countytw_12：彰化県 // Changhua Countytw_13：南投県 // Nantou Countytw_14：雲林県 // Yunlin Countytw_15：嘉義県 // Chiayi Countytw_16：屏東県 // Pingtung Countytw_17：宜蘭県 // Yilan Countytw_18：花蓮県 // Hualien Countytw_19：台東県 // Taitung Countytw_20：澎湖県 // Penghu Countytw_21：金門県 // Kinmen Countytw_22：連江県 // Lienchiang County
タイ // TH (country code=764)
th_01：バンコク // Bangkokth_02：パタヤ // Pattayath_03：北部 // Northernth_04：中央部 // Centralth_05：南部 // Southernth_06：東部 // Easternth_07：東北部 // NorthEasternth_08：西部 // Western
インドネシア // ID (country code=360)
id_01：バリ // Baliid_02：バンドン // Bandungid_03：バンジャルマシン // Banjarmasinid_04：ジャボデタベック（ジャカルタ首都圏） // Jabodetabekid_06：マカッサル // Makassarid_07：メダン // Medanid_08：パレンバン // Palembangid_09：サマリンダ // Samarindaid_10：スマラン // Semarangid_11：スラバヤ // Surabayaid_12：ジョグジャカルタ // Yogyakartaid_05：その他のエリア // Lainnya
友だち期間
友だち期間の範囲を指定してフィルタリングします。
type
String
必須subscriptionPeriodgte
String
※指定した日数以上を送信対象とします。
以下のいずれかの値を指定します。day_7day_30day_90day_180day_365
lt
String
※指定した日数未満を送信対象とします。
gteプロパティと同じ値を指定できます。※
gteプロパティまたはltプロパティの両方またはいずれか一方を、必ず指定してください。演算子オブジェクト
積集合（AND）、和集合（OR）、差集合（NOT）を使用して、複数のデモグラフィックフィルターオブジェクトから、新たなデモグラフィックフィルターオブジェクトを作成できます。1回のリクエストごとに、デモグラフィックフィルターオブジェクトは、合計10件まで指定できます。
type
String
必須operatorand
デモグラフィックフィルターオブジェクトの配列
※配列で指定したデモグラフィックフィルターオブジェクトの積集合（AND）を、新たなデモグラフィックフィルターオブジェクトとします。
or
デモグラフィックフィルターオブジェクトの配列
※配列で指定したデモグラフィックフィルターオブジェクトの和集合（OR）を、新たなデモグラフィックフィルターオブジェクトとします。
not
デモグラフィックフィルターオブジェクト
※指定したデモグラフィックフィルターオブジェクトを配信対象外にした、新たなデモグラフィックフィルターオブジェクトとします。
※
andプロパティ、orプロパティ、notプロパティのいずれか1つだけ、必ず指定してください。また、空配列は指定できません。
性別を使用してフィルタリングするデモグラフィックフィルターオブジェクトの例
# レスポンス
HTTPステータスコード202を返します。
ナローキャストメッセージの送信は非同期に行われます
ナローキャストメッセージの送信状況を確認する方法について詳しくは、「ナローキャストメッセージの進行状況を取得する」を参照してください。
# ナローキャストメッセージの進行状況を取得する
ナローキャストメッセージの進行状況を取得します。
送信対象が一定数よりも少ない場合は送信できません
送信対象のユーザーの属性を推測できないようにするために、送信対象が一定数よりも少ない場合はナローキャストメッセージを送信できません。 詳しくは「ナローキャストメッセージを送る」の「ナローキャストメッセージの使用制限について」を参照してください。
進行状況を取得できる期間
ナローキャストメッセージの送信をリクエストしてから7日以上経過すると、進行状況は取得できません。
リクエストの例
# HTTPリクエスト
GET https://api.line.me/v2/bot/message/progress/narrowcast
# リクエストヘッダー
Authorization
Bearer {channel access token}
# クエリパラメータ
requestId
必須
ナローキャストメッセージのリクエストID。リクエストIDは、Messaging APIのリクエストごとに発行されるIDです。レスポンスヘッダーに含まれます。
# レスポンス
HTTPステータスコード200と以下の情報を含むJSONオブジェクトを返します。
phase
String
進行状況。以下のいずれかの値です。
waiting：送信準備ができていません。フィルタリングなどを行っています。sending：送信中です。succeeded：送信処理が完了しました。これは、ユーザーがメッセージを正常に受信したことを示していません。failed：送信が失敗しました。failedDescriptionプロパティで失敗した理由を確認できます。
successCount
Number
メッセージの受信に成功したユーザー数（※）
failureCount
Number
メッセージの受信に失敗したユーザー数（※）。
phaseがsucceededの場合でも、failureCountが0でない限りは、ナローキャストメッセージを受信できていないユーザーがいます。たとえば、ナローキャストメッセージを送信中に、ユーザーがLINE公式アカウントをブロックした場合はfailureCountに加算されます。
targetCount
Number
メッセージが配信される予定のユーザー数（※）
failedDescription
String
送信が失敗した理由。phaseプロパティがfailedの場合にのみ含まれます。
errorCode
Number
エラーの概要。以下のいずれかの値です。
1：内部エラーが発生しました。2：送信対象が少なすぎたためエラーになりました。3：すでに受理されたリクエストを再試行したため、競合エラーが発生しました。
※phaseプロパティがwaitingの場合は取得できません。
# エラーレスポンス
ナローキャストメッセージ以外のリクエストIDを指定した場合や、無効なリクエストIDを指定した場合は、HTTPステータスコード404を返します。
# ブロードキャストメッセージを送る
LINE公式アカウントと友だちになっているすべてのユーザーに、任意のタイミングでプッシュメッセージを送信します。
リクエストの例
# HTTPリクエスト
POST https://api.line.me/v2/bot/message/broadcast
# リクエストヘッダー
Content-Type
application/json
Authorization
Bearer {channel access token}
# リクエストボディ
messages
メッセージオブジェクトの配列
必須
送信するメッセージ
最大件数：5
notificationDisabled
Boolean
任意
true：メッセージ送信時に、ユーザーに通知されない。false：メッセージ送信時に、ユーザーに通知される。ただし、LINEで通知をオフにしている場合は通知されません。
デフォルト値はfalseです。
# レスポンス
ステータスコード200と空のJSONオブジェクトを返します。
レスポンスの例
# コンテンツを取得する
ユーザーが送信した画像、動画、音声、およびファイルを取得するAPIです。
テキストは取得できません
ユーザーが送信したテキストを取得するAPIはありません。
リクエストの例
# HTTPリクエスト
GET https://api-data.line.me/v2/bot/message/{messageId}/content
# リクエストヘッダー
Authorization
Bearer {channel access token}
# パスパラメータ
messageId
メッセージID
# レスポンス
ステータスコード200とコンテンツのバイナリデータを返します。
メッセージが送信されてから一定期間後に、コンテンツは自動的に削除されます。コンテンツの保存期間は保証されません。
# 追加メッセージ数の上限目安を取得する
当月分の上限目安を取得します。
この操作により取得されるメッセージ数には、LINE Official Account Managerから送信するメッセージの数も含まれます。
上限目安は、LINE Official Account Managerで設定します。手順については、LINE Official Account Managerのマニュアルを参照してください。
リクエストの例
# HTTPリクエスト
# リクエストヘッダー
Authorization
Bearer {channel access token}
# レスポンス
ステータスコード200と以下の情報を含むJSONオブジェクトを返します。
type
String
上限目安が設定されているかどうかを示す値。以下のどちらかになります。
none。上限目安が未設定であることを示します。limited。上限目安が設定されていることを示します。
value
Number
当月分の追加メッセージの上限目安。typeプロパティがlimitedの場合にのみ返されます。
レスポンスの例
# 当月のメッセージ利用状況を取得する
当月に送信されたメッセージの数を取得します。
この操作により取得されるメッセージ数には、LINE Official Account Managerから送信するメッセージの数も含まれます。
この操作により取得されるメッセージ数は概算です。正確なメッセージ送信数を取得するには、LINE Official Account Managerを使用するか、送信済みのメッセージ数を取得するAPI操作を実行してください。
リクエストの例
# HTTPリクエスト
# リクエストヘッダー
Authorization
Bearer {channel access token}
# レスポンス
ステータスコード200と以下の情報を含むJSONオブジェクトを返します。
totalUsage
Number
当月に送信されたメッセージの数
レスポンスの例
# 送信済みの応答メッセージの数を取得する
/bot/message/replyエンドポイントを使って送信されたメッセージの数を取得します。
この操作により取得されるメッセージ数に、LINE Official Account Managerから送信されたメッセージの数は含まれません。
リクエストの例
# HTTPリクエスト
# リクエストヘッダー
Authorization
Bearer {channel access token}
# クエリパラメータ
date
必須
メッセージが送信された日付
- フォーマット：
yyyyMMdd（例：20191231） - タイムゾーン：UTC+9
# レスポンス
ステータスコード200と以下の情報を含むJSONオブジェクトを返します。
status
String
集計処理の状態。以下のいずれかの値です。
ready：メッセージ数を取得できます。unready：dateに指定した日付のメッセージ数の集計がまだ完了していません。しばらくしてからリクエストを再実行してください。通常、集計処理は翌日中に完了します。out_of_service：dateに指定した日付が、集計システムの稼働開始日（2018年03月31日）より前です。
success
Number
dateに指定した日付に、Messaging APIを使って送信されたメッセージの数。statusの値がreadyの場合にのみ、レスポンスに含まれます。
レスポンスの例
# 送信済みのプッシュメッセージの数を取得する
/bot/message/pushエンドポイントを使って送信されたメッセージの数を取得します。
この操作により取得されるメッセージ数に、LINE Official Account Managerから送信されたメッセージの数は含まれません。
リクエストの例
# HTTPリクエスト
# リクエストヘッダー
Authorization
Bearer {channel access token}
# クエリパラメータ
date
必須
メッセージが送信された日付
- フォーマット：
yyyyMMdd（例：20191231） - タイムゾーン：UTC+9
# レスポンス
ステータスコード200と以下の情報を含むJSONオブジェクトを返します。
status
String
集計処理の状態。以下のいずれかの値です。
ready：メッセージ数を取得できます。unready：dateに指定した日付のメッセージ数の集計がまだ完了していません。しばらくしてからリクエストを再実行してください。通常、集計処理は翌日中に完了します。out_of_service：dateに指定した日付が、集計システムの稼働開始日（2018年03月31日）より前です。
success
Number
dateに指定した日付に、Messaging APIを使って送信されたメッセージの数。statusの値がreadyの場合にのみ、レスポンスに含まれます。
レスポンスの例
# 送信済みのマルチキャストメッセージの数を取得する
/bot/message/multicastエンドポイントを使って送信されたメッセージの数を取得します。
この操作により取得されるメッセージ数に、LINE Official Account Managerから送信されたメッセージの数は含まれません。
リクエストの例
# HTTPリクエスト
# リクエストヘッダー
Authorization
Bearer {channel access token}
# クエリパラメータ
date
必須
メッセージが送信された日付
- フォーマット：
yyyyMMdd（例：20191231） - タイムゾーン：UTC+9
# レスポンス
ステータスコード200と以下の情報を含むJSONオブジェクトを返します。
status
String
集計処理の状態。以下のいずれかの値です。
ready：メッセージ数を取得できます。unready：dateに指定した日付のメッセージ数の集計がまだ完了していません。しばらくしてからリクエストを再実行してください。通常、集計処理は翌日中に完了します。out_of_service：dateに指定した日付が、集計システムの稼働開始日（2018年03月31日）より前です。
success
Number
dateに指定した日付に、Messaging APIを使って送信されたメッセージの数。statusの値がreadyの場合にのみ、レスポンスに含まれます。
レスポンスの例
# 送信済みのブロードキャストメッセージの数を取得する
/bot/message/broadcastエンドポイントを使って送信されたメッセージの数を取得します。
この操作により取得されるメッセージ数に、LINE Official Account Managerから送信されたメッセージの数は含まれません。
リクエストの例
# HTTPリクエスト
GET https://api.line.me/v2/bot/message/delivery/broadcast
# リクエストヘッダー
Authorization
Bearer {channel access token}
# クエリパラメータ
date
必須
メッセージが送信された日付
- フォーマット：
yyyyMMdd（例：20191231） - タイムゾーン：UTC+9
# レスポンス
ステータスコード200と以下の情報を含むJSONオブジェクトを返します。
status
String
集計処理の状態。以下のいずれかの値です。
ready：メッセージ数を取得できます。unready：dateに指定した日付のメッセージ数の集計がまだ完了していません。しばらくしてからリクエストを再実行してください。通常、集計処理は翌日中に完了します。out_of_service：dateに指定した日付が、集計システムの稼働開始日（2018年03月31日）より前です。
success
Number
dateに指定した日付に、Messaging APIを使って送信されたメッセージの数。statusの値がreadyの場合にのみ、レスポンスに含まれます。
レスポンスの例
# APIリクエストを再試行する
プッシュメッセージ、マルチキャストメッセージ、ナローキャストメッセージ、ブロードキャストメッセージに、リトライキー（X-Line-Retry-Key）をHTTPヘッダーに含めることで、同じAPIリクエストを重複して処理しないように再試行できます。
リトライキーを使ったAPIリクエストの再試行
- リトライキーを使うと、同じリクエストが重複して処理されることを防ぎながら、リクエストを再試行できます。詳しくは、「失敗したAPIリクエストを再試行する」を参照してください。
- リトライキーの有効期間は、最初にリクエストを試行してから24時間です。
リクエストの例
# リクエストヘッダー
X-Line-Retry-Key
任意の方法で生成した16進表記のUUID（例：123e4567-e89b-12d3-a456-426614174000）
# レスポンス
受理されたリクエストがある場合は、ステータスコード409と、受理されたリクエストのリクエストIDを示すレスポンスヘッダーと以下の情報を含むJSONオブジェクトを返します。
message
String
すでにリクエストが受理されていることを知らせるメッセージ
レスポンスの例
# オーディエンス管理
オーディエンスを作成、更新、削除できます。オーディエンスは、ナローキャストメッセージを配信する際に指定します。
なお、オーディエンスは、LINE Official Account Managerでも作成できます。詳しくは、LINE for Businessの「オーディエンス」を参照してください。
| オーディエンス | 作成方法 |
|---|---|
| ユーザーIDアップロード用のオーディエンス | |
| クリックリターゲティング用のオーディエンス | |
| インプレッションリターゲティング用のオーディエンス | |
| チャットタグオーディエンス | |
| 追加経路オーディエンス |
注意
- 日本（JP）、タイ（TH）、台湾（TW）のユーザーが作成したLINE公式アカウントの場合のみ、オーディエンスを利用できます。
- チャットタグオーディエンスおよび追加経路オーディエンスは、Messaging APIでは作成できません。
# ユーザーIDアップロード用のオーディエンスを作成する（JSON指定）
ユーザーIDアップロード用のオーディエンスを作成します。
このエンドポイントでは、送信対象アカウントをJSONで指定します。 送信対象アカウントをテキストファイルで指定するエンドポイントも利用できます。
送信対象アカウントをIFA（Identifier For Advertisers）で指定するには手続きが必要です
送信対象アカウントをIFAで指定することもできますが、この機能は、所定の申請等を行った法人ユーザーのみがご利用いただけます。 自社のLINE公式アカウントでご利用になりたいお客様は、担当営業までご連絡いただくか、弊社パートナーにお問い合わせください。
ユーザーIDの取得方法
ユーザーIDは、以下の方法で取得できます。
- Webhookイベントオブジェクトの
sourceオブジェクト - グループメンバーのユーザーIDを取得する
- トークルームメンバーのユーザーIDを取得する
ユーザーIDアップロード用のオーディエンスの仕様
オーディエンスの仕様は以下のとおりです。
| 項目 | 条件 |
|---|---|
| チャネルあたりのオーディエンス数 | 最大1,000件 |
| オーディエンスの保存期間 | 最大180日間 |
| オーディエンスに、1リクエストでアップロードできるユーザーIDまたはIFAの数 | JSONを使用する場合：最大10,000件 ファイルを使用する場合：最大1,500,000件 |
| オーディエンスあたりのユーザー数 | ユーザーIDアップロード用のオーディエンス：制限なし |
ナローキャストメッセージの使用制限については、「ナローキャストメッセージの使用制限について」を参照してください。
有効なユーザーIDの確認方法
JSONのaudiencesプロパティで無効なユーザーIDが指定されていた場合、エラーレスポンス（details: UPLOAD_AUDIENCE_GROUP_INVALID_AUDIENCE_ID_FORMAT）が返り、オーディエンスの作成に失敗します。このエンドポイントを実行する前に、audiencesプロパティに含まれるすべてのユーザーIDが有効であることを確認してください。
ユーザーIDが有効か確認するには、プロフィール情報を取得するエンドポイントを使用してください。ユーザーIDが有効な場合は、HTTPステータスコード200が返ります。200以外が返ってきた場合、そのユーザーIDは無効のため、audiencesプロパティには含めないようにしてください。
リクエストの例
# HTTPリクエスト
POST https://api.line.me/v2/bot/audienceGroup/upload
# リクエストヘッダー
Authorization
Bearer {channel access token}
Content-Type
application/json
# リクエストボディ
description
String
必須
オーディエンスの名前。他のオーディエンスと同じ名前は設定できません。なお、大文字と小文字は区別されないため、AUDIENCEとaudienceは同じ名前と判定されます。
最大文字数：120
isIfaAudience
Boolean
任意
- 送信対象アカウントをIFAで指定する場合は、
trueを指定します。 - 送信対象アカウントをユーザーIDで指定する場合は、
falseを指定するか、isIfaAudienceプロパティを省略します。
uploadDescription
String
任意
ジョブ（jobs[].description）に登録する説明
audiences
Array
任意
ユーザーIDまたはIFAの配列
最大件数：10,000
audiences[].id
String
任意
ユーザーIDまたはIFA。空配列も指定できます。
# レスポンス
HTTPステータスコード202とオーディエンスを返します。
オーディエンスの作成は非同期に行われます
オーディエンスを利用する前に、オーディエンスが配信に利用できることを確認してください。
audienceGroupId
Number
オーディエンスID
type
String
UPLOAD
description
String
オーディエンスの名前
created
Number
オーディエンスが作成された時刻のUNIXタイム
レスポンスの例
# エラーレスポンス
HTTPステータスコード400と以下の情報を含むJSONオブジェクトを返します。
message
String
エラーの概要
details
String
エラーの内容。以下のいずれかの値です。
AUDIENCE_GROUP_COUNT_MAX_OVER：作成できるオーディエンス数の上限（合計1,000件）に達しています。AUDIENCE_GROUP_NAME_SIZE_OVER：オーディエンスの名前が長すぎます。AUDIENCE_GROUP_NAME_DUPLICATE：既存のオーディエンスと同じ名前を指定しました。AUDIENCE_GROUP_NAME_WRONG：オーディエンスの名前に、無効な文字（例：\nなどの制御コード）を指定しました。UPLOAD_AUDIENCE_GROUP_INVALID_AUDIENCE_ID_FORMAT：audiences[].idプロパティに無効なユーザーIDまたはIFAが指定されています。UPLOAD_AUDIENCE_GROUP_TOO_MANY_AUDIENCE_IDS：ユーザーIDまたはIFAの登録上限に達しています。
audiencesプロパティに無効なユーザーIDが含まれている場合
UPLOAD_AUDIENCE_GROUP_INVALID_AUDIENCE_ID_FORMATが返る場合は、プロフィール情報を取得するエンドポイントを使って、JSONに指定しているすべてのユーザーIDのプロフィール情報を取得してください。ステータスコード200以外を返すユーザーIDをJSONから除外したうえで、失敗したエンドポイントを再実行してください。
# ユーザーIDアップロード用のオーディエンスを作成する（ファイル指定）
ユーザーIDアップロード用のオーディエンスを作成します。
このエンドポイントでは、送信対象アカウントをテキストファイルで指定します。 送信対象アカウントをJSONで指定するエンドポイントも利用できます。
送信対象アカウントをIFA（Identifier For Advertisers）で指定するには手続きが必要です
送信対象アカウントをIFAで指定することもできますが、この機能は、所定の申請等を行った法人ユーザーのみがご利用いただけます。 自社のLINE公式アカウントでご利用になりたいお客様は、担当営業までご連絡いただくか、弊社パートナーにお問い合わせください。
ユーザーIDの取得方法
ユーザーIDは、以下の方法で取得できます。
- Webhookイベントオブジェクトの
sourceオブジェクト - グループメンバーのユーザーIDを取得する
- トークルームメンバーのユーザーIDを取得する
ユーザーIDアップロード用のオーディエンスの仕様
オーディエンスの仕様は以下のとおりです。
| 項目 | 条件 |
|---|---|
| チャネルあたりのオーディエンス数 | 最大1,000件 |
| オーディエンスの保存期間 | 最大180日間 |
| オーディエンスに、1リクエストでアップロードできるユーザーIDまたはIFAの数 | JSONを使用する場合：最大10,000件 ファイルを使用する場合：最大1,500,000件 |
| オーディエンスあたりのユーザー数 | ユーザーIDアップロード用のオーディエンス：制限なし |
ナローキャストメッセージの使用制限については、「ナローキャストメッセージの使用制限について」を参照してください。
リクエストの例
テキストファイルの例
# HTTPリクエスト
POST https://api-data.line.me/v2/bot/audienceGroup/upload/byFile
# リクエストヘッダー
Authorization
Bearer {channel access token}
Content-Type
multipart/form-data
# リクエストボディ
description
String
必須
オーディエンスの名前。他のオーディエンスと同じ名前は設定できません。なお、大文字と小文字は区別されないため、AUDIENCEとaudienceは同じ名前と判定されます。
最大文字数：120
isIfaAudience
Boolean
任意
- 送信対象アカウントをIFAで指定する場合は、
trueを指定します。 - 送信対象アカウントをユーザーIDで指定する場合は、
falseを指定するか、isIfaAudienceプロパティを省略します。
uploadDescription
String
任意
ジョブ（jobs[].description）に登録する説明
file
File
必須
ユーザーIDまたはIFAを、1行に1件入力したテキストファイル。Content-Typeは、text/plainを指定してください。
最大ファイル数：1
最大行数：1,500,000
# レスポンス
HTTPステータスコード202とオーディエンスを返します。
オーディエンスの作成は非同期に行われます
オーディエンスを利用する前に、オーディエンスが配信に利用できることを確認してください。
audienceGroupId
Number
オーディエンスID
type
String
UPLOAD
description
String
オーディエンスの名前
created
Number
オーディエンスが作成された時刻のUNIXタイム
レスポンスの例
# エラーレスポンス
HTTPステータスコード400と以下の情報を含むJSONオブジェクトを返します。
message
String
エラーの概要
details
String
エラーの内容。以下のいずれかの値です。
UPLOAD_AUDIENCE_GROUP_INVALID_AUDIENCE_ID_FORMAT：fileプロパティに指定したファイルに、無効なユーザーIDまたはIFAが入力されています。UPLOAD_AUDIENCE_GROUP_TOO_MANY_AUDIENCE_IDS：ユーザーIDまたはIFAの登録上限に達しています。UPLOAD_AUDIENCE_GROUP_NO_VALID_AUDIENCE_IDS：fileプロパティに指定したファイルに、有効なユーザーIDまたはIFAが入力されていません。AUDIENCE_GROUP_COUNT_MAX_OVER：作成できるオーディエンス数の上限（合計1,000件）に達しています。AUDIENCE_GROUP_NAME_SIZE_OVER：オーディエンスの名前が長すぎます。AUDIENCE_GROUP_NAME_DUPLICATE：既存のオーディエンスと同じ名前を指定しました。AUDIENCE_GROUP_NAME_WRONG：オーディエンスの名前に、無効な文字（例：\nなどの制御コード）を指定しました。
# ユーザーIDアップロード用のオーディエンスにユーザーIDまたはIFAを追加する（JSON指定）
ユーザーIDアップロード用のオーディエンスに、ユーザーIDまたはIFAを追加します。
このエンドポイントでは、送信対象アカウントをJSONで指定します。 送信対象アカウントをテキストファイルで指定するエンドポイントも利用できます。
リクエストタイムアウト値について
リクエストタイムアウトを30秒以上に設定することを強く推奨します。
有効なユーザーIDの確認方法
JSONのaudiencesプロパティで無効なユーザーIDが指定されていた場合、エラーレスポンス（details: UPLOAD_AUDIENCE_GROUP_INVALID_AUDIENCE_ID_FORMAT）が返り、ユーザーIDの追加に失敗します。このエンドポイントを実行する前に、audiencesプロパティに含まれるすべてのユーザーIDが有効であることを確認してください。
ユーザーIDが有効か確認するには、プロフィール情報を取得するエンドポイントを使用してください。ユーザーIDが有効な場合は、HTTPステータスコード200が返ります。200以外が返ってきた場合、そのユーザーIDは無効のため、audiencesプロパティには含めないようにしてください。
ユーザーIDまたはIFAの種類は変更できません
ユーザーIDアップロード用のオーディエンスを作成したときと同じ種類（ユーザーIDまたはIFA）のデータを追加してください。たとえば、初めにIFAを指定して作成したオーディエンスに、ユーザーIDを指定することはできません。
オーディエンスを作成したときに指定した送信対象アカウントの種類（ユーザーIDまたはIFA）は、オーディエンスのisIfaAudienceプロパティで確認できます。詳しくは、「オーディエンスの情報を取得する」を参照してください。
ユーザーIDまたはIFAは削除できません
一度追加したユーザーIDまたはIFAを削除することはできません。
リクエストの例
# HTTPリクエスト
PUT https://api.line.me/v2/bot/audienceGroup/upload
# リクエストヘッダー
Authorization
Bearer {channel access token}
Content-Type
application/json
# リクエストボディ
audienceGroupId
Number
必須
オーディエンスID
uploadDescription
String
任意
ジョブ（jobs[].description）に登録する説明
audiences
Array
必須
ユーザーIDまたはIFAの配列
最大件数：10,000
audiences[].id
String
必須
ユーザーIDまたはIFA
# レスポンス
HTTPステータスコード202と空のJSONオブジェクトを返します。
オーディエンスの作成は非同期に行われます
オーディエンスを利用する前に、オーディエンスが配信に利用できることを確認してください。
レスポンスの例
# エラーレスポンス
HTTPステータスコード400と以下の情報を含むJSONオブジェクトを返します。
message
String
エラーの概要
details
String
エラーの内容。以下のいずれかの値です。
AUDIENCE_GROUP_NAME_SIZE_OVER：オーディエンスの名前が長すぎます。AUDIENCE_GROUP_NAME_DUPLICATE：既存のオーディエンスと同じ名前を指定しました。AUDIENCE_GROUP_NAME_WRONG：オーディエンスの名前に、無効な文字（例：\nなどの制御コード）を指定しました。UPLOAD_AUDIENCE_GROUP_INVALID_AUDIENCE_ID_FORMAT：audiences[].idプロパティに無効なユーザーIDまたはIFAが指定されています。UPLOAD_AUDIENCE_GROUP_TOO_MANY_AUDIENCE_IDS：ユーザーIDまたはIFAの登録上限に達しています。UPLOAD_AUDIENCE_GROUP_NO_VALID_AUDIENCE_IDS：有効なユーザーIDまたはIFAが指定されていません。AUDIENCE_GROUP_CAN_NOT_UPLOAD_STATUS_EXPIRED：オーディエンス作成後、180日以上が経過しました。このオーディエンスは使用できません。
audiencesプロパティに無効なユーザーIDが含まれている場合
UPLOAD_AUDIENCE_GROUP_INVALID_AUDIENCE_ID_FORMATが返る場合は、プロフィール情報を取得するエンドポイントを使って、JSONに指定しているすべてのユーザーIDのプロフィール情報を取得してください。ステータスコード200以外を返すユーザーIDをJSONから除外したうえで、失敗したエンドポイントを再実行してください。
# ユーザーIDアップロード用のオーディエンスにユーザーIDまたはIFAを追加する（ファイル指定）
ユーザーIDアップロード用のオーディエンスに、ユーザーIDまたはIFAを追加します。
このエンドポイントでは、送信対象アカウントをテキストファイルで指定します。 送信対象アカウントをJSONで指定するエンドポイントも利用できます。
リクエストタイムアウト値について
リクエストタイムアウトを30秒以上に設定することを強く推奨します。
ユーザーIDまたはIFAの種類は変更できません
ユーザーIDアップロード用のオーディエンスを作成したときと同じ種類（ユーザーIDまたはIFA）のデータを追加してください。たとえば、初めにIFAを指定して作成したオーディエンスに、ユーザーIDを指定することはできません。
オーディエンスを作成したときに指定した送信対象アカウントの種類（ユーザーIDまたはIFA）は、オーディエンスのisIfaAudienceプロパティで確認できます。詳しくは、「オーディエンスの情報を取得する」を参照してください。
ユーザーIDまたはIFAは削除できません
一度追加したユーザーIDまたはIFAを削除することはできません。
リクエストの例
テキストファイルの例
# HTTPリクエスト
PUT https://api-data.line.me/v2/bot/audienceGroup/upload/byFile
# リクエストヘッダー
Authorization
Bearer {channel access token}
Content-Type
multipart/form-data
# リクエストボディ
audienceGroupId
Number
必須
オーディエンスID
uploadDescription
String
任意
ジョブ（jobs[].description）に登録する説明
file
File
必須
ユーザーIDまたはIFAを、1行に1件入力したテキストファイル。Content-Typeは、text/plainを指定してください。
最大ファイル数：1
最大行数：1,500,000
# レスポンス
HTTPステータスコード202と空のJSONオブジェクトを返します。
オーディエンスの作成は非同期に行われます
オーディエンスを利用する前に、オーディエンスが配信に利用できることを確認してください。
レスポンスの例
# エラーレスポンス
HTTPステータスコード400と以下の情報を含むJSONオブジェクトを返します。
message
String
エラーの概要
details
String
エラーの内容。以下のいずれかの値です。
UPLOAD_AUDIENCE_GROUP_INVALID_AUDIENCE_ID_FORMAT：fileプロパティに指定したファイルに、無効なユーザーIDまたはIFAが入力されています。UPLOAD_AUDIENCE_GROUP_TOO_MANY_AUDIENCE_IDS：ユーザーIDまたはIFAの登録上限に達しています。UPLOAD_AUDIENCE_GROUP_NO_VALID_AUDIENCE_IDS：fileプロパティに指定したファイルに、有効なユーザーIDまたはIFAが入力されていません。AUDIENCE_GROUP_CAN_NOT_UPLOAD_STATUS_EXPIRED：オーディエンス作成後、180日以上が経過しました。このオーディエンスは使用できません。
# クリックリターゲティング用のオーディエンスを作成する
クリックリターゲティング用のオーディエンスを作成します。
クリックリターゲティング用のオーディエンスは、ブロードキャストメッセージまたはナローキャストメッセージに記載されたURLをクリックしたユーザーを集めたオーディエンスです。 少なくとも1つのリンクをクリックしたユーザーが送信対象になります。
対象のメッセージは、リクエストIDで指定します。
クリックリターゲティング用のオーディエンスの仕様
オーディエンスの仕様は以下のとおりです。
| 項目 | 条件 |
|---|---|
| チャネルあたりのオーディエンス数 | 最大1,000件 |
| オーディエンスの保存期間 | 最大180日間 |
| オーディエンスあたりのユーザー数 | クリックリターゲティング用のオーディエンス：最小100件 |
| メッセージを配信してからリターゲティング用オーディエンス（※）を作成できる期間 | 最大60日間 |
※クリックリターゲティング用のオーディエンスおよびインプレッションリターゲティング用のオーディエンスを指します。
ナローキャストメッセージの使用制限については、「ナローキャストメッセージの使用制限について」を参照してください。
リクエストの例
# HTTPリクエスト
POST https://api.line.me/v2/bot/audienceGroup/click
# リクエストヘッダー
Authorization
Bearer {channel access token}
Content-Type
application/json
# リクエストボディ
description
String
必須
オーディエンスの名前。他のオーディエンスと同じ名前は設定できません。なお、大文字と小文字は区別されないため、AUDIENCEとaudienceは同じ名前と判定されます。
最大文字数：120
requestId
String
必須
配信から60日以内のブロードキャストメッセージまたはナローキャストメッセージのリクエストID。リクエストIDは、Messaging APIのリクエストごとに発行されるIDです。レスポンスヘッダーに含まれます。
注意
応答メッセージ、プッシュメッセージ、およびマルチキャストメッセージのリクエストIDは、利用できません。
clickUrl
String
任意
ユーザーがクリックしたURL。省略した場合は、メッセージ内の任意のURLをクリックしたユーザーが送信対象になります。
最大文字数：2,000
# レスポンス
HTTPステータスコード202とオーディエンスを返します。
オーディエンスの作成は非同期に行われます
オーディエンスを利用する前に、オーディエンスが配信に利用できることを確認してください。
audienceGroupId
Number
オーディエンスID
type
String
CLICK
description
String
オーディエンスの名前
created
Number
オーディエンスが作成された時刻のUNIXタイム
requestId
String
オーディエンスを作成したときに指定したリクエストID
clickUrl
String
オーディエンスを作成したときに指定したURL
レスポンスの例
# エラーレスポンス
HTTPステータスコード400と以下の情報を含むJSONオブジェクトを返します。
message
String
エラーの概要
details
String
エラーの内容。以下のいずれかの値です。
AUDIENCE_GROUP_COUNT_MAX_OVER：作成できるオーディエンス数の上限（合計1,000件）に達しています。AUDIENCE_GROUP_NAME_SIZE_OVER：オーディエンスの名前が長すぎます。AUDIENCE_GROUP_NAME_DUPLICATE：既存のオーディエンスと同じ名前を指定しました。AUDIENCE_GROUP_NAME_WRONG：オーディエンスの名前に、無効な文字（例：\nなどの制御コード）を指定しました。AUDIENCE_GROUP_REQUESTID_DUPLICATE：既存のオーディエンスに指定したリクエストIDと同じ値を指定しました。WRONG_BOT_ID：指定したリクエストIDに含まれるボットIDが、アクセストークンを発行したチャネルに関連付けられたボットと異なります。TOO_OLD_MESSAGES：メッセージを配信してから60日を超えた場合、そのメッセージ（リクエストID）に対するオーディエンスは作成できません。REQUEST_NOT_FOUND：指定したリクエストIDが誤っているか、指定したリクエストIDでオーディエンスを作成する準備ができていません。
# インプレッションリターゲティング用のオーディエンスを作成する
注意
LINEの一部のバージョンでインプレッションと開封の測定に問題があるため、対象とする配信済みメッセージの配信日時によって、オーディエンスの作成を制限しています。
| 対象とする配信済みメッセージの配信日時 （日本標準時） | インプレッションリターゲティング用のオーディエンスの作成に関する制限 |
|---|---|
| ～2020年3月29日 23:59:59 | 制限はありません。作成できます。 |
| 2020年3月30日 00:00:00～2020年4月29日 23:59:59 | 作成できません。 |
| 2020年4月30日 00:00:00～ | 作成できます。ただし、配信済みの当該メッセージを、問題があるバージョンのLINEで表示したユーザーには、作成したオーディエンスを使用した新しいメッセージは送信されません。 |
インプレッションリターゲティング用のオーディエンスを作成します。
インプレッションリターゲティング用のオーディエンスは、ブロードキャストメッセージまたはナローキャストメッセージを表示したユーザーを集めたオーディエンスです。 少なくとも1つの吹き出しを表示したユーザーが送信対象になります。
対象のメッセージは、リクエストIDで指定します。
インプレッションリターゲティング用のオーディエンスの仕様
オーディエンスの仕様は以下のとおりです。
| 項目 | 条件 |
|---|---|
| チャネルあたりのオーディエンス数 | 最大1,000件 |
| オーディエンスの保存期間 | 最大180日間 |
| オーディエンスあたりのユーザー数 | インプレッションリターゲティング用のオーディエンス：最小100件 |
| メッセージを配信してからリターゲティング用オーディエンス（※）を作成できる期間 | 最大60日間 |
※クリックリターゲティング用のオーディエンスおよびインプレッションリターゲティング用のオーディエンスを指します。
ナローキャストメッセージの使用制限については、「ナローキャストメッセージの使用制限について」を参照してください。
リクエストの例
# HTTPリクエスト
POST https://api.line.me/v2/bot/audienceGroup/imp
# リクエストヘッダー
Authorization
Bearer {channel access token}
Content-Type
application/json
# リクエストボディ
description
String
必須
オーディエンスの名前。他のオーディエンスと同じ名前は設定できません。なお、大文字と小文字は区別されないため、AUDIENCEとaudienceは同じ名前と判定されます。
最大文字数：120
requestId
String
必須
配信から60日以内のブロードキャストメッセージまたはナローキャストメッセージのリクエストID。リクエストIDは、Messaging APIのリクエストごとに発行されるIDです。レスポンスヘッダーに含まれます。
# レスポンス
HTTPステータスコード202とオーディエンスを返します。
オーディエンスの作成は非同期に行われます
オーディエンスを利用する前に、オーディエンスが配信に利用できることを確認してください。
audienceGroupId
Number
オーディエンスID
type
String
IMP
description
String
オーディエンスの名前
created
Number
オーディエンスが作成された時刻のUNIXタイム
requestId
String
オーディエンスを作成したときに指定したリクエストID
レスポンスの例
# エラーレスポンス
HTTPステータスコード400と以下の情報を含むJSONオブジェクトを返します。
message
String
エラーの概要
details
String
エラーの内容。以下のいずれかの値です。
AUDIENCE_GROUP_COUNT_MAX_OVER：作成できるオーディエンス数の上限（合計1,000件）に達しています。AUDIENCE_GROUP_NAME_SIZE_OVER：オーディエンスの名前が長すぎます。AUDIENCE_GROUP_NAME_DUPLICATE：既存のオーディエンスと同じ名前を指定しました。AUDIENCE_GROUP_NAME_WRONG：オーディエンスの名前に、無効な文字（例：\nなどの制御コード）を指定しました。AUDIENCE_GROUP_REQUESTID_DUPLICATE：既存のオーディエンスに指定したリクエストIDと同じ値を指定しました。WRONG_BOT_ID：指定したリクエストIDに含まれるボットIDが、アクセストークンを発行したチャネルに関連付けられたボットと異なります。TOO_OLD_MESSAGES：メッセージを配信してから60日を超えた場合、そのメッセージ（リクエストID）に対するオーディエンスは作成できません。REQUEST_NOT_FOUND：指定したリクエストIDが誤っているか、指定したリクエストIDでオーディエンスを作成する準備ができていません。
# オーディエンスの名前を更新する
既存のオーディエンスの名前を変更します。
リクエストの例
# HTTPリクエスト
PUT https://api.line.me/v2/bot/audienceGroup/{audienceGroupId}/updateDescription
# リクエストヘッダー
Authorization
Bearer {channel access token}
Content-Type
application/json
# パスパラメータ
audienceGroupId
オーディエンスID
# リクエストボディ
description
String
必須
オーディエンスの名前。他のオーディエンスと同じ名前は設定できません。なお、大文字と小文字は区別されないため、AUDIENCEとaudienceは同じ名前と判定されます。
最大文字数：120
# レスポンス
HTTPステータスコード200を返します。
# エラーレスポンス
HTTPステータスコード400と以下の情報を含むJSONオブジェクトを返します。
message
String
エラーの概要
details
String
エラーの内容。以下のいずれかの値です。
AUDIENCE_GROUP_NAME_SIZE_OVER：オーディエンスの名前が長すぎます。AUDIENCE_GROUP_NAME_DUPLICATE：既存のオーディエンスと同じ名前を指定しました。AUDIENCE_GROUP_NAME_WRONG：オーディエンスの名前に、無効な文字（例：\nなどの制御コード）を指定しました。
# オーディエンスを削除する
オーディエンスを削除します。
削除したオーディエンスは元に戻せません
削除する前に、オーディエンスが使用されていないことを確認してください。
リクエストの例
# HTTPリクエスト
DELETE https://api.line.me/v2/bot/audienceGroup/{audienceGroupId}
# リクエストヘッダー
Authorization
Bearer {channel access token}
# パスパラメータ
audienceGroupId
オーディエンスID
# レスポンス
HTTPステータスコード202を返します。
# エラーレスポンス
HTTPステータスコード400と以下の情報を含むJSONオブジェクトを返します。
message
String
エラーの概要
details
String
エラーの内容。以下のいずれかの値です。
AUDIENCE_GROUP_NOT_FOUND：オーディエンスが見つかりません。
# オーディエンスの情報を取得する
オーディエンスの情報を取得します。
リクエストの例
# HTTPリクエスト
GET https://api.line.me/v2/bot/audienceGroup/{audienceGroupId}
# リクエストヘッダー
Authorization
Bearer {channel access token}
# パスパラメータ
audienceGroupId
オーディエンスID
# レスポンス
HTTPステータスコード200と以下の情報を含むJSONオブジェクトを返します。
audienceGroupId
Number
オーディエンスID
type
String
オーディエンスのタイプ。以下のいずれかの値です。
UPLOAD：ユーザーIDアップロード用のオーディエンスCLICK：クリックリターゲティング用のオーディエンスIMP：インプレッションリターゲティング用のオーディエンスCHAT_TAG：チャットタグオーディエンスFRIEND_PATH：追加経路オーディエンス
詳しくは、LINE for Businessの「オーディエンス」を参照してください。
description
String
オーディエンスの名前
status
String
オーディエンスのステータス。以下のいずれかの値です。
IN_PROGRESS：準備中。READYになるまで数時間かかる場合があります。READY：配信に利用可能FAILED：作成時にエラーが発生EXPIRED：有効期限切れ。有効期限切れ後、1か月後に自動で削除されます。
failedType
String
失敗した原因。statusがFAILEDの場合にのみ含まれます。以下のいずれかの値です。
AUDIENCE_GROUP_AUDIENCE_INSUFFICIENT：オーディエンスに含まれる送信対象アカウントの数（最低100件）が不足しています。INTERNAL_ERROR：内部サーバーのエラーです。
audienceCount
Number
有効な送信対象アカウントの数
created
Number
オーディエンスが作成された時刻のUNIXタイム
requestId
String
オーディエンスを作成したときに指定したリクエストID。typeがCLICKまたはIMPの場合にのみ含まれます。
clickUrl
String
オーディエンスを作成したときに指定したURL。typeがCLICKの場合にのみ含まれます。
isIfaAudience
Boolean
ユーザーIDアップロード用のオーディエンスを作成したときに指定した、送信対象アカウントの種類を示す値。以下のいずれかの値です。
true：IFAで指定するfalse：ユーザーIDで指定する（デフォルト）
permission
String
オーディエンスの更新パーミッション。同じチャネルに関連付けられたオーディエンスは、READ_WRITEになります。
READ：利用のみ可能READ_WRITE：利用と更新が可能
createRoute
String
オーディエンスの作成方法。省略した場合は、すべてのオーディエンスを取得します。
OA_MANAGER：LINE Official Account Managerで作成したオーディエンスMESSAGING_API：Messaging APIで作成したオーディエンス
jobs
Array
ジョブの配列。ユーザーIDアップロード用のオーディエンスに、ユーザーIDまたはIFAを追加した履歴を管理する配列です。それ以外のオーディエンスの場合はnullが返ります。
jobs[].audienceGroupJobId
Number
ジョブID
jobs[].audienceGroupId
Number
オーディエンスID
jobs[].description
String
ジョブの説明
jobs[].type
String
ジョブの種類。以下のいずれかの値です。
DIFF_ADD：Messaging APIでユーザーIDまたはIFAを追加したことを示します。
jobs[].jobStatus
String
ジョブのステータス。以下のいずれかの値です。
QUEUED：待機中WORKING：実行中FINISHED：成功FAILED：失敗
jobs[].failedType
String
失敗した原因。jobs[].jobStatusがFAILEDの場合にのみ含まれます。以下のいずれかの値です。
AUDIENCE_GROUP_AUDIENCE_INSUFFICIENT：オーディエンスに含まれる送信対象アカウントの数（最低100件）が不足しています。INTERNAL_ERROR：内部サーバーのエラーです。
jobs[].audienceCount
Number
追加または削除された送信対象アカウントの数
jobs[].created
Number
ジョブが作成された時刻のUNIXタイム
# エラーレスポンス
HTTPステータスコード400と以下の情報を含むJSONオブジェクトを返します。
message
String
エラーの概要
details
String
エラーの内容。以下のいずれかの値です。
AUDIENCE_GROUP_NOT_FOUND：オーディエンスが見つかりません。
# 複数のオーディエンスの情報を取得する
複数のオーディエンスの情報を取得します。
リクエストの例
# HTTPリクエスト
GET https://api.line.me/v2/bot/audienceGroup/list
# リクエストヘッダー
Authorization
Bearer {channel access token}
# クエリパラメータ
page
必須
取得するページ番号。1以上を指定してください。
description
任意
取得するオーディエンスの名前。部分一致で検索できます。なお、大文字と小文字は区別されないため、AUDIENCEとaudienceは同じ名前と判定されます。
status
任意
取得するオーディエンスのステータス。以下のいずれかの値です。
IN_PROGRESS：準備中。READYになるまで数時間かかる場合があります。READY：配信に利用可能FAILED：作成時にエラーが発生EXPIRED：有効期限切れ。有効期限切れ後、1か月後に自動で削除されます。
size
任意
1ページごとのオーディエンス数。デフォルト値は20です。
最大値：40
includesExternalPublicGroups
任意
true：同じボットに関連付けられた、すべてのチャネルで作成された公開オーディエンスを取得false：同じチャネルに作成されたオーディエンスのみを取得
createRoute
任意
オーディエンスの作成方法。省略した場合は、すべてのオーディエンスを取得します。
OA_MANAGER：LINE Official Account Managerで作成したオーディエンスのみを取得MESSAGING_API：Messaging APIで作成したオーディエンスのみを取得
# レスポンス
HTTPステータスコード200と以下の情報を含むJSONオブジェクトを返します。
audienceGroups
Array
オーディエンスの情報の配列
audienceGroups[].audienceGroupId
Number
オーディエンスID
audienceGroups[].type
String
オーディエンスのタイプ。以下のいずれかの値です。
UPLOAD：ユーザーIDアップロード用のオーディエンスCLICK：クリックリターゲティング用のオーディエンスIMP：インプレッションリターゲティング用のオーディエンスCHAT_TAG：チャットタグオーディエンスFRIEND_PATH：追加経路オーディエンス
詳しくは、LINE for Businessの「オーディエンス」を参照してください。
audienceGroups[].description
String
オーディエンスの名前
audienceGroups[].status
String
オーディエンスのステータス。以下のいずれかの値です。
IN_PROGRESS：準備中。READYになるまで数時間かかる場合があります。READY：配信に利用可能FAILED：作成時にエラーが発生EXPIRED：有効期限切れ。有効期限切れ後、1か月後に自動で削除されます。
audienceGroups[].failedType
String
失敗した原因。audienceGroups[].statusがFAILEDまたはEXPIREDの場合にのみ含まれます。以下のいずれかの値です。
AUDIENCE_GROUP_AUDIENCE_INSUFFICIENT：オーディエンスに含まれる送信対象アカウントの数（最低100件）が不足しています。INTERNAL_ERROR：内部サーバーのエラーです。
audienceGroups[].audienceCount
Number
有効な送信対象アカウントの数
audienceGroups[].created
Number
オーディエンスが作成された時刻のUNIXタイム
audienceGroups[].requestId
String
オーディエンスを作成したときに指定したリクエストID。audienceGroups[].typeがCLICKまたはIMPの場合にのみ含まれます。
audienceGroups[].clickUrl
String
オーディエンスを作成したときに指定したURL。audienceGroups[].typeがCLICKの場合にのみ含まれます。
audienceGroups[].isIfaAudience
Boolean
ユーザーIDアップロード用のオーディエンスを作成したときに指定した、送信対象アカウントの種類を示す値。以下のいずれかの値です。
true：IFAで指定するfalse：ユーザーIDで指定する（デフォルト）
audienceGroups[].permission
String
オーディエンスの更新パーミッション。同じチャネルに関連付けられたオーディエンスは、READ_WRITEになります。
READ：利用のみ可能READ_WRITE：利用と更新が可能
audienceGroups[].createRoute
String
オーディエンスの作成方法。省略した場合は、すべてのオーディエンスを含める。
OA_MANAGER：LINE Official Account Managerで作成したオーディエンスMESSAGING_API：Messaging APIで作成したオーディエンス
hasNextPage
Boolean
次のページが存在する場合は、true
totalCount
Int
指定した条件で取得できるオーディエンスの総数
readWriteAudienceGroupTotalCount
Int
指定した条件で取得できるオーディエンスのうち、更新パーミッションがREAD_WRITEに設定されているオーディエンスの数
page
Int
現在のページ番号
size
Int
現在のページに含まれるオーディエンス数
# オーディエンスの権限レベルを取得する
オーディエンスの権限レベルを取得します。
注意
権限レベルはチャネルごとに設定されます。オーディエンスごとに異なる権限レベルを設定することはできません。
リクエストの例
# HTTPリクエスト
GET https://api.line.me/v2/bot/audienceGroup/authorityLevel
# リクエストヘッダー
Authorization
Bearer {channel access token}
# レスポンス
HTTPステータスコード200と以下の情報を含むJSONオブジェクトを返します。
authorityLevel
String
チャネルに関連付けられた、すべてのオーディエンスの権限レベル
PUBLIC：デフォルトの権限レベルです。この権限レベルのオーディエンスは、オーディエンスを作成したチャネル以外でも使用できます。たとえば、LINE Official Account Manager、LINE Ad Manager、同じボットに関連付けられているすべてのチャネルで利用できます。PRIVATE：この権限レベルのオーディエンスは、オーディエンスを作成したチャネルでのみ使用できます。
# オーディエンスの権限レベルを変更する
同じチャネルで作成された、すべてのオーディエンスの権限レベルを変更します。
PUBLICに設定したオーディエンスは、オーディエンスを作成したチャネル以外でも使用できます。たとえば、LINE Official Account Manager、LINE Ad Manager、同じボットに関連付けられているすべてのチャネルで利用できます。PRIVATEに設定したオーディエンスは、オーディエンスを作成したチャネルでのみ使用できます。
注意
権限レベルはチャネルごとに設定されます。オーディエンスごとに異なる権限レベルを設定することはできません。
リクエストの例
# HTTPリクエスト
PUT https://api.line.me/v2/bot/audienceGroup/authorityLevel
# リクエストヘッダー
Authorization
Bearer {channel access token}
Content-Type
application/json
# リクエストボディ
authorityLevel
String
必須
チャネルに関連付けられた、すべてのオーディエンスの権限レベル
PUBLIC：デフォルトの権限レベルです。この権限レベルのオーディエンスは、オーディエンスを作成したチャネル以外でも使用できます。たとえば、LINE Official Account Manager、LINE Ad Manager、同じボットに関連付けられているすべてのチャネルで利用できます。PRIVATE：この権限レベルのオーディエンスは、オーディエンスを作成したチャネルでのみ使用できます。
# レスポンス
HTTPステータスコード200を返します。
# 分析
LINE公式アカウントから送信したメッセージの数や友だち数、統計情報などを取得できます。
# メッセージの送信数を取得する
LINE公式アカウントから送信したメッセージの数を確認できます。
リクエストの例
# HTTPリクエスト
GET https://api.line.me/v2/bot/insight/message/delivery?date={date}
# リクエストヘッダー
Authorization
Bearer {channel access token}
# クエリパラメータ
date
必須
メッセージの送信数を確認する日付
- フォーマット：
yyyyMMdd（例：20191231） - タイムゾーン：UTC+9
# レスポンス
ステータスコード200と以下の情報を含むJSONオブジェクトを返します。
status
String
集計処理の状態。以下のいずれかの値です。
ready：メッセージ数を取得できます。unready：dateに指定した日付のメッセージ数の集計がまだ完了していません。しばらくしてからリクエストを再実行してください。通常、集計処理は翌日中に完了します。out_of_service：dateに指定した日付が、集計システムの稼働開始日（2017年03月01日）より前です。
broadcast
Number
LINE公式アカウントと友だちになっているすべてのユーザーに送信されたプッシュメッセージ（ブロードキャストメッセージ）の数。
targeting
Number
LINE公式アカウントと友だちになっているユーザーの中から属性で絞り込んで送信されたプッシュメッセージ（ターゲティングメッセージ、セグメントメッセージ）の数。
autoResponse
Number
送信された応答メッセージの数。
welcomeResponse
Number
送信されたあいさつメッセージの数。
chat
Number
LINE Official Account Managerの「チャット基本画面」から送信されたメッセージの数。
apiBroadcast
Number
「ブロードキャストメッセージを送る」で送信されたメッセージの数。
apiPush
Number
「プッシュメッセージを送る」で送信されたメッセージの数。
apiMulticast
Number
「マルチキャストメッセージを送る」で送信されたメッセージの数。
apiNarrowcast
Number
「ナローキャストメッセージを送る」で送信されたメッセージの数。
apiReply
Number
「応答メッセージを送る」で送信されたメッセージの数。
broadcast以降のプロパティは、dateに指定した日付に送信されたメッセージの数です。なお、statusの値がreadyの場合にのみレスポンスに含まれます。
レスポンスの例
# 友だち数を取得する
LINE公式アカウントの友だち数を確認できます。
リクエストの例
# HTTPリクエスト
GET https://api.line.me/v2/bot/insight/followers?date={date}
# リクエストヘッダー
Authorization
Bearer {channel access token}
# クエリパラメータ
date
必須
友だち数を確認する日付
- フォーマット：
yyyyMMdd（例：20191231） - タイムゾーン：UTC+9
# レスポンス
ステータスコード200と以下の情報を含むJSONオブジェクトを返します。
status
String
集計処理の状態。以下のいずれかの値です。
ready：数値を取得できます。unready：dateに指定した日付の友だち数の集計がまだ完了していません。しばらくしてからリクエストを再実行してください。通常、集計処理は翌日中に完了します。out_of_service：dateに指定した日付が、集計システムの稼働開始日（2016年11月01日）より前です。
followers
Number
dateに指定した日付までに、アカウントが友だち追加された回数。アカウントがブロックされたり、あなたを友だち追加したユーザーがLINEアカウントを削除したりしても、この値は減少しません。
targetedReaches
Number
dateに指定した日付時点の、性別や年齢、地域で絞り込んだターゲティングメッセージの配信先となりうる友だちの総数。LINEおよびその他のLINEサービスの利用頻度が高く、属性の高精度な推定が可能な友だちが含まれます。
blocks
Number
dateに指定した日付時点で、アカウントをブロックしているユーザーの数。ブロックが解除されると、この値は減少します。
followers以降のプロパティは、statusの値がreadyの場合にのみレスポンスに含まれます。
レスポンスの例
# 友だちの属性情報に基づく統計情報を取得する
LINE公式アカウントの友だちの属性情報に基づく統計情報を確認できます。なお、日本（JP）、タイ（TH）、台湾（TW）、インドネシア（ID）のユーザーが作成したLINE公式アカウントの場合のみ、統計情報を確認できます。
リアルタイムデータではありません
友だちの統計情報が反映されるまで最大3日ほどかかります。 そのため、取得できる情報は3日前の数値です。また、統計情報を表示するには20人以上のターゲットリーチが必要です。
リクエストの例
# HTTPリクエスト
GET https://api.line.me/v2/bot/insight/demographic
# リクエストヘッダー
Authorization
Bearer {channel access token}
# レスポンス
ステータスコード200と以下の情報を含むJSONオブジェクトを返します。
available
Boolean
友だちの属性情報に基づく統計情報が利用できる場合は、true
genders
Array
性別ごとの割合
genders[].gender
String
ユーザーの性別に基づいて、以下の値が返されます。
malefemaleunknown
genders[].percentage
Number
割合
ages
Array
年齢ごとの割合
ages[].age
String
ユーザーの年齢に基づいて、以下の値が返されます。
from0to14from15to19from20to24from25to29from30to34from35to39from40to44from45to49from50unknown
ages[].percentage
Number
割合
areas
Array
地域ごとの割合
areas[].area
String
ユーザーの国や地域に基づいて、以下の値が返されます。
JP
北海道青森岩手宮城秋田山形福島茨城栃木群馬埼玉千葉東京神奈川新潟富山石川福井山梨長野岐阜静岡愛知三重滋賀京都大阪兵庫奈良和歌山鳥取島根岡山広島山口徳島香川愛媛高知福岡佐賀長崎熊本大分宮崎鹿児島沖縄unknown
TW
台北市新北市桃園市台中市台南市高雄市基隆市新竹市嘉義市新竹縣苗栗縣彰化縣南投縣雲林縣嘉義縣屏東縣宜蘭縣花蓮縣台東縣澎湖縣金門縣連江縣unknown
TH
BangkokPattayaNorthernCentralSouthernEasternNorthEasternWesternunknown
ID
BaliBandungBanjarmasinJabodetabekMakassarMedanPalembangSamarindaSemarangSurabayaYogyakartaLainnyaunknown
areas[].percentage
Number
割合
appTypes
Array
OSごとの割合
appTypes[].appType
String
ユーザーが使用するOSに基づいて、以下の値が返されます。
iosandroidothers
appTypes[].percentage
Number
割合
subscriptionPeriods
Array
友だち期間ごとの割合
subscriptionPeriods[].subscriptionPeriod
String
ユーザーとの友だち期間に基づいて、以下の値が返されます。
within7dayswithin30dayswithin90dayswithin180dayswithin365daysover365daysunknown
subscriptionPeriods[].percentage
Number
割合
各Arrayの要素は、availableの値がtrueの場合にのみレスポンスに含まれます。
レスポンスの例
# ユーザーの操作に基づく統計情報を取得する
注意
LINEの一部のバージョンでインプレッションと開封の測定に問題があるため、対象となるメッセージの統計情報において以下の数値を返します。
| メッセージの配信日時 （日本標準時） | APIが返す統計情報 |
|---|---|
| ～2020年3月29日 23:59:59 | 正常値が返されます。 |
| 2020年3月30日 00:00:00～2020年4月29日 23:59:59 | overview.uniqueImpressionとmessages[].impressionは、参考値が返されます。 |
| 2020年4月30日 00:00:00～ | 正常値が返されます。ただし、配信済みの当該メッセージを、問題があるバージョンのLINEで表示した回数は含まれません。 |
LINE公式アカウントから送信したナローキャストメッセージまたはブロードキャストメッセージに対して、ユーザーがどのように操作したかを示す統計情報を確認できます。
1メッセージ（message）単位、および１吹き出し（bubble）単位で統計情報を取得できます。
記録される統計情報について
統計情報は、メッセージを送信した日から14日分のみ記録されます。送信した日から15日以上が経過しても、統計情報は更新されません。
リクエストの例
# HTTPリクエスト
GET https://api.line.me/v2/bot/insight/message/event?requestId={requestId}
# リクエストヘッダー
Authorization
Bearer {channel access token}
# クエリパラメータ
requestId
必須
ナローキャストメッセージまたはブロードキャストメッセージのリクエストID。リクエストIDは、Messaging APIのリクエストごとに発行されるIDです。レスポンスヘッダーに含まれます。
# レスポンス
ステータスコード200と以下の情報を含むJSONオブジェクトを返します。
注意
プライバシーを保護するために、個人の操作に関するプロパティの値はnullまたは-1になる場合があります。
null：overview.uniqueImpressionが20未満-1：overview.uniqueImpressionが20以上だが、当該プロパティの値が20未満
overview
Object
メッセージに関する統計情報。
overview.requestId
String
リクエストID。
overview.timestamp
Number
メッセージが配信された時刻のUNIXタイム。
overview.delivered
Number
メッセージの送信数。この値は、20未満の数値も表示されます。ただし、メッセージの送信がすべて完了していない場合はnullになります。
overview.uniqueImpression
Number
メッセージを開封した人数。少なくとも1つの吹き出しを表示した人数です。
overview.uniqueClick
Number
メッセージ内のいずれかのURLをタップした人数。
overview.uniqueMediaPlayed
Number
メッセージ内のいずれかの動画または音声の再生を開始した人数。
overview.uniqueMediaPlayed100Percent
Number
メッセージ内のいずれかの動画または音声を最後まで視聴した人数。
messages
Array
吹き出しに関する情報を表す配列。
messages[].seq
Number
吹き出しの通し番号。
messages[].impression
Number
吹き出しが表示された回数。
messages[].mediaPlayed
Number
吹き出し内の動画または音声が再生開始された回数。
messages[].mediaPlayed25Percent
Number
吹き出し内の動画または音声が再生開始され、25%再生された回数。
messages[].mediaPlayed50Percent
Number
吹き出し内の動画または音声が再生開始され、50%再生された回数。
messages[].mediaPlayed75Percent
Number
吹き出し内の動画または音声が再生開始され、75%再生された回数。
messages[].mediaPlayed100Percent
Number
吹き出し内の動画または音声が再生開始され、100%再生された回数。
messages[].uniqueMediaPlayed
Number
吹き出し内の動画または音声を再生開始した人数。
messages[].uniqueMediaPlayed25Percent
Number
吹き出し内の動画または音声を再生開始し、25%再生した人数。
messages[].uniqueMediaPlayed50Percent
Number
吹き出し内の動画または音声を再生開始し、50%再生した人数。
messages[].uniqueMediaPlayed75Percent
Number
吹き出し内の動画または音声を再生開始し、75%再生した人数。
messages[].uniqueMediaPlayed100Percent
Number
吹き出し内の動画または音声を再生開始し、100%再生した人数。
clicks
Array
タップしたURLに関する情報を表す配列。
clicks[].seq
Number
URLが含まれていた吹き出しの通し番号。
clicks[].url
String
URL。
clicks[].click
Number
吹き出し内のURLをタップした回数。
clicks[].uniqueClick
Number
吹き出し内のURLをタップした人数。
clicks[].uniqueClickOfRequest
Number
メッセージ内のURLのうちurlと同じURLをタップした人数。ほかの吹き出しに同じURLが設定されている場合に、1人のユーザーが各URLをタップした場合でも、1回だけカウントされます。
レスポンスの例
# ユーザー
LINE公式アカウントを友だち追加したユーザーの情報を取得できます。
# プロフィール情報を取得する
LINE公式アカウントを友だち追加したユーザーのプロフィール情報を取得します。
グループメンバーやトークルームメンバーのプロフィール情報
グループメンバーやトークルームメンバーのプロフィール情報を取得するには、以下のAPIを使用してください。 これらのAPIでは、LINE公式アカウントを友だちとして追加していないユーザーや、LINE公式アカウントをブロックしているユーザーのプロフィール情報も取得できます。
リクエストの例
# HTTPリクエスト
# リクエストヘッダー
Authorization
Bearer {channel access token}
# パスパラメータ
userId
Webhookイベントオブジェクトで返されるユーザーID。LINEに表示されるLINE IDは使用しないでください。
# レスポンス
ユーザーIDが有効な場合、ステータスコード200と以下の情報を含むJSONオブジェクトを返します。
displayName
String
ユーザーの表示名
userId
String
ユーザーID
language
String
ユーザーの言語。BCP 47言語タグに従った文字列が返されます。
例：en（英語）。
languageプロパティは、以下のいずれかの場合にのみ返されます。
- 日本で作成されたLINEアカウントを使用しているユーザーが、LINEバージョン8.0.0以降で、プライバシーポリシーに同意している場合
- 台湾、タイ、またはインドネシアで作成されたLINEアカウントを使用しているユーザーが、LINEバージョン8.9.0以降で、プライバシーポリシーに同意している場合
pictureUrl
String
プロフィール画像のURL。スキームはhttpsです。ユーザーがプロフィール画像を設定していない場合はレスポンスに含まれません。
statusMessage
String
ユーザーのステータスメッセージ。ユーザーがステータスメッセージを設定していない場合はレスポンスに含まれません。
レスポンスの例
# LINE公式アカウントを友だち追加したユーザー全員のユーザーIDを取得する
注意
この機能は認証済みアカウントまたはプレミアムアカウントのみでご利用いただけます。 アカウント種別について詳しくは、LINE for Businessの「LINE公式アカウント アカウント種別」を参照してください。
LINE公式アカウントを友だち追加したユーザー全員のユーザーIDを取得します。
リクエストの例
# HTTPリクエスト
GET https://api.line.me/v2/bot/followers/ids
# リクエストヘッダー
Content-Type
application/json
Authorization
Bearer {channel access token}
# クエリパラメータ
start
任意
継続トークンの値。レスポンスで返されるJSONオブジェクトのnextプロパティに含まれます。1回のリクエストでユーザーIDをすべて取得できない場合は、このパラメータを指定して残りの配列を取得します。
# レスポンス
ステータスコード200と以下のプロパティを含むJSONオブジェクトを返します。
userIds
文字列の配列
LINE公式アカウントを友だち追加したユーザーのユーザーIDのリスト。iOS版LINEまたはAndroid版LINEを使用しているユーザーのみuserIdsに含まれます。詳しくは、「ユーザーの同意」を参照してください。
最大ユーザー数：300
next
String
継続トークン。ユーザーIDの、次の配列を取得するために使用します。このプロパティは、前回までのレスポンスのuserIdsで取得しきれなかったユーザーIDがある場合にのみ返されます。userIdsに含まれるユーザーIDの数は、nextプロパティが返される場合でも必ず300件になるとは限りません。
レスポンスの例
# グループ
LINE公式アカウントが参加しているグループや、グループメンバーの情報を取得できます。
# グループの概要を取得する
LINE公式アカウントが参加しているグループのグループID、グループ名、アイコンのURLを取得します。
リクエストの例
# HTTPリクエスト
GET https://api.line.me/v2/bot/group/{groupId}/summary
# リクエストヘッダー
Authorization
Bearer {channel access token}
# パスパラメータ
groupId
必須
グループID。Webhookイベントオブジェクトのsourceオブジェクトで確認できます。
# レスポンス
ステータスコード200と以下の情報を含むJSONオブジェクトを返します。
groupId
String
グループID
groupName
String
グループ名
pictureUrl
String
グループのアイコンのURL
レスポンスの例
# グループに参加しているユーザーの人数を取得する
グループに参加しているユーザーの人数を取得します。参加しているユーザーが、LINE公式アカウントを友だち追加していない場合や、LINE公式アカウントをブロックしている場合でも、人数に含まれます。
人数に、LINE公式アカウントは含まれません。
リクエストの例
# HTTPリクエスト
GET https://api.line.me/v2/bot/group/{groupId}/members/count
# リクエストヘッダー
Authorization
Bearer {channel access token}
# パスパラメータ
groupId
必須
グループID。Webhookイベントオブジェクトのsourceオブジェクトで確認できます。
# レスポンス
ステータスコード200と以下の情報を含むJSONオブジェクトを返します。
count
Number
グループに参加しているユーザーの人数。人数に、LINE公式アカウントは含まれません。
レスポンスの例
# グループメンバーのユーザーIDを取得する
注意
この機能は認証済みアカウントまたはプレミアムアカウントのみでご利用いただけます。 アカウント種別について詳しくは、LINE for Businessの「LINE公式アカウント アカウント種別」を参照してください。
LINE公式アカウントが参加しているグループのメンバーの、ユーザーIDを取得するAPIです。LINE公式アカウントを友だちとして追加していないユーザーや、LINE公式アカウントをブロックしているユーザーのユーザーIDも取得します。
リクエストの例
# HTTPリクエスト
GET https://api.line.me/v2/bot/group/{groupId}/members/ids
# リクエストヘッダー
Authorization
Bearer {channel access token}
# パスパラメータ
groupId
必須
グループID。Webhookイベントオブジェクトのsourceオブジェクトで返されます。
# クエリパラメータ
start
任意
継続トークンの値。レスポンスで返されるJSONオブジェクトのnextプロパティに含まれます。1回のリクエストでユーザーIDをすべて取得できない場合は、このパラメータを指定して残りの配列を取得します。
# レスポンス
ステータスコード200と以下のプロパティを含むJSONオブジェクトを返します。
memberIds
文字列の配列
グループメンバーのユーザーIDのリスト。iOS版LINEまたはAndroid版LINEを使用しているユーザーのみmemberIdsに含まれます。詳しくは、「ユーザーの同意」を参照してください。
最大ユーザー数：100
next
String
継続トークン。グループメンバーのユーザーIDの、次の配列を取得するために使用します。このプロパティは、前回までのレスポンスのmemberIdsで取得しきれなかったユーザーIDがある場合にのみ返されます。
レスポンスの例
# グループメンバーのプロフィール情報を取得する
LINE公式アカウントが参加しているグループのメンバーのユーザーIDが既知である場合に、そのメンバーのプロフィール情報を取得するAPIです。LINE公式アカウントを友だちとして追加していないユーザーや、LINE公式アカウントをブロックしているユーザーのプロフィール情報も取得します。
リクエストの例
# HTTPリクエスト
GET https://api.line.me/v2/bot/group/{groupId}/member/{userId}
# リクエストヘッダー
Authorization
Bearer {channel access token}
# パスパラメータ
groupId
グループID。Webhookイベントオブジェクトのsourceオブジェクトで返されます。
userId
ユーザーID。Webhookイベントオブジェクトのsourceオブジェクトで返されます。LINEに表示されるLINE IDは使用しないでください。
# レスポンス
ステータスコード200と以下の情報を含むJSONオブジェクトを返します。
displayName
String
表示名
userId
String
ユーザーID
pictureUrl
String
プロフィール画像のURL
レスポンスの例
# グループから退出する
グループから退出するAPIです。
リクエストの例
# HTTPリクエスト
POST https://api.line.me/v2/bot/group/{groupId}/leave
# リクエストヘッダー
Authorization
Bearer {channel access token}
# パスパラメータ
groupId
グループID。Webhookイベントオブジェクトのsourceオブジェクトで返されます。
# レスポンス
ステータスコード200と空のJSONオブジェクトを返します。
レスポンスの例
# トークルーム
LINE公式アカウントが参加しているトークルームや、トークルームメンバーの情報を取得できます。
# トークルームに参加しているユーザーの人数を取得する
トークルームに参加しているユーザーの人数を取得します。参加しているユーザーが、LINE公式アカウントを友だち追加していない場合や、LINE公式アカウントをブロックしている場合でも、人数に含まれます。
人数に、LINE公式アカウントは含まれません。
リクエストの例
# HTTPリクエスト
GET https://api.line.me/v2/bot/room/{roomId}/members/count
# リクエストヘッダー
Authorization
Bearer {channel access token}
# Path parameters
roomId
必須
トークルームID。Webhookイベントオブジェクトのsourceオブジェクトで確認できます。
# レスポンス
ステータスコード200と以下の情報を含むJSONオブジェクトを返します。
count
Number
トークルームに参加しているユーザーの人数。人数に、LINE公式アカウントは含まれません。
レスポンスの例
# トークルームメンバーのユーザーIDを取得する
注意
この機能は認証済みアカウントまたはプレミアムアカウントのみでご利用いただけます。 アカウント種別について詳しくは、LINE for Businessの「LINE公式アカウント アカウント種別」を参照してください。
LINE公式アカウントが参加しているトークルームのメンバーの、ユーザーIDを取得するAPIです。LINE公式アカウントを友だちとして追加していないユーザーや、LINE公式アカウントをブロックしているユーザーのユーザーIDも取得します。
リクエストの例
# HTTPリクエスト
GET https://api.line.me/v2/bot/room/{roomId}/members/ids
# リクエストヘッダー
Authorization
Bearer {channel access token}
# パスパラメータ
roomId
必須
トークルームID。Webhookイベントオブジェクトのsourceオブジェクトで返されます。
# クエリパラメータ
start
任意
継続トークンの値。レスポンスで返されるJSONオブジェクトのnextプロパティに含まれます。1回のリクエストでユーザーIDをすべて取得できない場合は、このパラメータを指定して残りの配列を取得します。
# レスポンス
ステータスコード200と以下のプロパティを含むJSONオブジェクトを返します。
memberIds
文字列の配列
トークルームメンバーのユーザーIDのリスト。iOS版LINEまたはAndroid版LINEを使用しているユーザーのみmemberIdsに含まれます。詳しくは、「ユーザーの同意」を参照してください。
最大ユーザー数：100
next
String
継続トークン。トークルームメンバーのユーザーIDの、次の配列を取得するために使用します。このプロパティは、前回までのレスポンスのmemberIdsで取得しきれなかったユーザーIDがある場合にのみ返されます。
レスポンスの例
# トークルームメンバーのプロフィール情報を取得する
LINE公式アカウントが参加しているトークルームのメンバーのユーザーIDが既知である場合に、そのメンバーのプロフィール情報を取得するAPIです。LINE公式アカウントを友だちとして追加していないユーザーや、LINE公式アカウントをブロックしているユーザーのプロフィール情報も取得します。
リクエストの例
# HTTPリクエスト
GET https://api.line.me/v2/bot/room/{roomId}/member/{userId}
# リクエストヘッダー
Authorization
Bearer {channel access token}
# パスパラメータ
roomId
トークルームID。Webhookイベントオブジェクトのsourceオブジェクトで返されます。
userId
ユーザーID。Webhookイベントオブジェクトのsourceオブジェクトで返されます。LINEに表示されるLINE IDは使用しないでください。
# レスポンス
ステータスコード200と以下の情報を含むJSONオブジェクトを返します。
displayName
String
表示名
userId
String
ユーザーID
pictureUrl
String
プロフィール画像のURL
レスポンスの例
# トークルームから退出する
トークルームから退出するAPIです。
リクエストの例
# HTTPリクエスト
POST https://api.line.me/v2/bot/room/{roomId}/leave
# リクエストヘッダー
Authorization
Bearer {channel access token}
# パスパラメータ
roomId
トークルームID。Webhookイベントオブジェクトのsourceオブジェクトで返されます。
# レスポンス
ステータスコード200と空のJSONオブジェクトを返します。
レスポンスの例
# リッチメニュー
LINE公式アカウントのトーク画面に表示される、カスタマイズ可能なメニューです。詳しくは、「リッチメニューを使う」を参照してください。
# リッチメニューを作成する
リッチメニューを作成するAPIです。
リッチメニューを表示するには、リッチメニューの画像をアップロードし、さらにデフォルトのリッチメニューを設定するかリッチメニューをユーザーとリンクする必要があります。1つのLINE公式アカウントに対して、Messaging APIを使って最大で1000件のリッチメニューを作成できます。
リクエストの例
# HTTPリクエスト
POST https://api.line.me/v2/bot/richmenu
# リクエストヘッダー
Authorization
Bearer {channel access token}
Content-Type
application/json
# リクエストボディ
リッチメニューオブジェクトとして表されるリッチメニューを指定します。
# レスポンス
ステータスコード200とリッチメニューIDを表すJSONオブジェクトを返します。
レスポンスの例
# リッチメニューの画像をアップロードする
画像をアップロードしてリッチメニューに付加するAPIです。
リッチメニューの画像は以下の要件を満たす必要があります。
- 画像フォーマット：JPEGまたはPNG
- 画像の幅サイズ（ピクセル）：800以上、2500以下
- 画像の高さサイズ（ピクセル）：250以上
- 画像のアスペクト比（幅/高さ）：1.45以上
- 最大ファイルサイズ：1MB
注意
リッチメニューに付加された画像を置き換えることはできません。リッチメニューの画像を更新するには、新しいリッチメニューオブジェクトを作成して、新しい画像をアップロードします。
リクエストの例
# HTTPリクエスト
POST https://api-data.line.me/v2/bot/richmenu/{richMenuId}/content
# リクエストヘッダー
Authorization
Bearer {channel access token}
Content-Type
image/jpegまたはimage/png
Content-Length
リクエストボディのオクテット（8ビットバイト）での長さ。正の値である必要があります。
# パスパラメータ
richMenuId
必須
画像を付加するリッチメニューのID
# レスポンス
ステータスコード200と空のJSONオブジェクトを返します。
レスポンスの例
# リッチメニューの画像をダウンロードする
リッチメニューの画像をダウンロードするAPIです。
リクエストの例
# HTTPリクエスト
GET https://api-data.line.me/v2/bot/richmenu/{richMenuId}/content
# リクエストヘッダー
Authorization
Bearer {channel access token}
# パスパラメータ
richMenuId
必須
画像をダウンロードするリッチメニューのID
# レスポンス
ステータスコード200とリッチメニュー画像のバイナリデータを返します。リクエストの例に示すように、画像をダウンロードできます。
# リッチメニューの配列を取得する
「リッチメニューを作成する」で作成したすべてのリッチメニューのリッチメニューレスポンスオブジェクトを取得します。
注意
LINE Official Account Managerで作成したリッチメニューは取得できません。
リクエストの例
# HTTPリクエスト
GET https://api.line.me/v2/bot/richmenu/list
# リクエストヘッダー
Authorization
Bearer {channel access token}
# レスポンス
ステータスコード200とリッチメニューレスポンスオブジェクトの配列を返します。
richmenus
Array
レスポンスの例
# リッチメニューを取得する
IDを指定してリッチメニューを取得するAPIです。
リクエストの例
# HTTPリクエスト
GET https://api.line.me/v2/bot/richmenu/{richMenuId}
# リクエストヘッダー
Authorization
Bearer {channel access token}
# パスパラメータ
richMenuId
必須
リッチメニューのID
# レスポンス
ステータスコード200と、リッチメニューレスポンスオブジェクトを含むJSONレスポンスが返されます。
レスポンスの例
# リッチメニューを削除する
リッチメニューを削除します。
リッチメニュー数の上限について
Messaging APIで作成できるリッチメニューの数の上限は、LINE公式アカウントあたり1,000件です。この上限を超過した場合は、新しいリッチメニューを作成する前に既存のリッチメニューを削除する必要があります。
リクエストの例
# HTTPリクエスト
DELETE https://api.line.me/v2/bot/richmenu/{richMenuId}
# リクエストヘッダー
Authorization
Bearer {channel access token}
# パスパラメータ
richMenuId
必須
リッチメニューのID
# レスポンス
ステータスコード200と空のJSONオブジェクトを返します。
レスポンスの例
# デフォルトのリッチメニューを設定する
デフォルトのリッチメニューを設定するAPIです。デフォルトのリッチメニューは、LINE公式アカウントと友だちになっているユーザーのうち、個別にリッチメニューをリンクされていないすべてのユーザーに表示されます。すでにデフォルトのリッチメニューが設定されていた場合は、新しく指定したリッチメニューに置き換えられます。
リッチメニューの表示優先順位は高い順に以下のとおりです。
- Messaging APIで設定するユーザー単位のリッチメニュー
- Messaging APIで設定するデフォルトのリッチメニュー
- LINE Official Account Managerで設定するデフォルトのリッチメニュー
リクエストの例
# HTTPリクエスト
POST https://api.line.me/v2/bot/user/all/richmenu/{richMenuId}
# リクエストヘッダー
Authorization
Bearer {channel access token}
# パスパラメータ
richMenuId
必須
リッチメニューのID
# レスポンス
ステータスコード200と空のJSONオブジェクトを返します。
レスポンスの例
# デフォルトのリッチメニューのIDを取得する
Messaging APIで設定したデフォルトのリッチメニューのIDを取得するAPIです。
リクエストの例
# HTTPリクエスト
GET https://api.line.me/v2/bot/user/all/richmenu
# リクエストヘッダー
Authorization
Bearer {channel access token}
# レスポンス
ステータスコード200とリッチメニューIDを表すJSONオブジェクトを返します。
レスポンスの例
# デフォルトのリッチメニューを解除する
Messaging APIで設定したデフォルトのリッチメニューを解除するAPIです。
リクエストの例
# HTTPリクエスト
DELETE https://api.line.me/v2/bot/user/all/richmenu
# リクエストヘッダー
Authorization
Bearer {channel access token}
# レスポンス
ステータスコード200と空のJSONオブジェクトを返します。
レスポンスの例
# リッチメニューとユーザーをリンクする
リッチメニューとユーザーをリンクするAPIです。複数のリッチメニューを1人のユーザーに同時にリンクすることはできません。ユーザーにすでにリッチメニューがリンクされていた場合は、新しく指定したリッチメニューに置き換えられます。
リッチメニューの表示優先順位は高い順に以下のとおりです。
- Messaging APIで設定するユーザー単位のリッチメニュー
- Messaging APIで設定するデフォルトのリッチメニュー
- LINE Official Account Managerで設定するデフォルトのリッチメニュー
リクエストの例
# HTTPリクエスト
POST https://api.line.me/v2/bot/user/{userId}/richmenu/{richMenuId}
# リクエストヘッダー
Authorization
Bearer {channel access token}
# パスパラメータ
richMenuId
必須
リッチメニューのID
userId
必須
ユーザーID。Webhookイベントオブジェクトのsourceオブジェクトで返されます。LINEに表示されるLINE IDは使用しないでください。
# レスポンス
ステータスコード200と空のJSONオブジェクトを返します。
レスポンスの例
# リッチメニューと複数のユーザーをリンクする
リッチメニューと複数のユーザーをリンクします。
リッチメニューの表示優先順位は高い順に以下のとおりです。
- Messaging APIで設定するユーザー単位のリッチメニュー
- Messaging APIで設定するデフォルトのリッチメニュー
- LINE Official Accountで設定するデフォルトのリッチメニュー
リクエストの例
# HTTPリクエスト
POST https://api.line.me/v2/bot/richmenu/bulk/link
# リクエストヘッダー
Content-Type
application/json
Authorization
Bearer {channel access token}
# リクエストボディ
richMenuId
String
必須
リッチメニューのID
userIds
Stringの配列
必須
ユーザーIDの配列。Webhookイベントオブジェクトのsourceオブジェクトで返されます。LINEに表示されるLINE IDは使用しないでください。
最大ユーザーID数：500
# レスポンス
ステータスコード202と空のJSONオブジェクトを返します。
リッチメニューと1人のユーザーをリンクする場合と異なり、このリクエストはバックグラウンドで非同期に処理されます。通常、処理は数秒で完了します。
リクエストの処理が成功したかどうかを検証するには、ユーザーのリッチメニューのIDを取得して、リッチメニューがユーザーにリンクされていることを確認します。
レスポンスの例
# ユーザーのリッチメニューのIDを取得する
ユーザーにリンクされたリッチメニューのIDを取得するAPIです。
リクエストの例
# HTTPリクエスト
GET https://api.line.me/v2/bot/user/{userId}/richmenu
# リクエストヘッダー
Authorization
Bearer {channel access token}
# パスパラメータ
userId
必須
ユーザーID。Webhookイベントオブジェクトのsourceオブジェクトで返されます。LINEに表示されるLINE IDは使用しないでください。
# レスポンス
ステータスコード200とリッチメニューIDを表すJSONオブジェクトを返します。
レスポンスの例
# リッチメニューとユーザーのリンクを解除する
リッチメニューとユーザーのリンクを解除するAPIです。
リクエストの例
# HTTPリクエスト
DELETE https://api.line.me/v2/bot/user/{userId}/richmenu
# リクエストヘッダー
Authorization
Bearer {channel access token}
# パスパラメータ
userId
必須
ユーザーID。Webhookイベントオブジェクトのsourceオブジェクトで返されます。LINEに表示されるLINE IDは使用しないでください。
# レスポンス
ステータスコード200と空のJSONオブジェクトを返します。
レスポンスの例
# 複数のユーザーのリッチメニューのリンクを解除する
複数のユーザーのリッチメニューのリンクを解除します。
リクエストの例
# HTTPリクエスト
POST https://api.line.me/v2/bot/richmenu/bulk/unlink
# リクエストヘッダー
Content-Type
application/json
Authorization
Bearer {channel access token}
# リクエストボディ
userIds
Stringの配列
必須
ユーザーIDの配列。Webhookイベントオブジェクトのsourceオブジェクトで返されます。LINEに表示されるLINE IDは使用しないでください。
最大ユーザーID数：500
# レスポンス
ステータスコード202と空のJSONオブジェクトを返します。
リッチメニューと1人のユーザーのリンクを解除する場合と異なり、このリクエストはバックグラウンドで非同期に処理されます。通常、処理は数秒で完了します。
リクエストの処理が成功したかどうかを検証するには、ユーザーのリッチメニューのIDを取得して、リンクを解除したはずのリッチメニューがユーザーにリンクされていないことを確認します。
レスポンスの例
# アカウント連携
プロバイダー（企業や開発者）が提供するサービスのアカウントと、LINEユーザーのアカウントを連携できます。
# 連携トークンを発行する
アカウント連携で使用する連携トークンを発行するAPIです。
リクエストの例
# HTTPリクエスト
POST https://api.line.me/v2/bot/user/{userId}/linkToken
# リクエストヘッダー
Authorization
Bearer {channel access token}
# パスパラメータ
userId
必須
連携対象のLINEアカウントのユーザーID。アカウント連携イベントオブジェクトのsourceオブジェクトで返されます。LINEに表示されるLINE IDは使用しないでください。
# レスポンス
ステータスコード200と連携トークンを返します。連携トークンの有効期間は10分で、1回のみ使用できます。
注意
有効期間は予告なく変わる可能性があります。
レスポンスの例
# メッセージオブジェクト
送信するメッセージの内容を表すJSONオブジェクトです。
# メッセージ共通プロパティ
以下のプロパティはすべてのメッセージオブジェクトに指定できます。
# クイックリプライ
クイックリプライ機能で使用するプロパティです。Android版とiOS版のLINE 8.11.0以降でサポートされます。詳しくは、「クイックリプライを使う」を参照してください。
quickReply
Object
任意
複数のメッセージオブジェクトを受信したユーザーには、最後のメッセージオブジェクトのquickReplyプロパティが表示されます。
# itemsオブジェクト
クイックリプライボタンのコンテナです。
items
Objectの配列
必須
クイックリプライボタンオブジェクト。最大オブジェクト数：13
itemsオブジェクトの例
# クイックリプライボタンオブジェクト
ボタン形式で表示される、クイックリプライの選択肢です。
type
String
必須
action
imageUrl
String
任意
ボタンの先頭に表示するアイコンのURL
- 最大文字数：1000
- URLスキーム：https
- 画像フォーマット：PNG
- アスペクト比：1：1
- 最大データサイズ：1MB
画像サイズに制限はありません。
actionプロパティに指定するアクションがカメラアクション、カメラロールアクション、または位置情報アクションで、imageUrlプロパティが未指定の場合、デフォルトのアイコンが表示されます。
action
Object
必須
タップされたときのアクション。アクションオブジェクトを指定します。指定できるアクションの種類は以下のとおりです。
クイックリプライボタンが設定されたメッセージを未対応のLINEで受信すると、メッセージ本体のみが表示されます。
# アイコンおよび表示名の変更
LINE公式アカウントからメッセージを送る際に、メッセージオブジェクトに、sender.nameプロパティとsender.iconUrlプロパティを指定できます。
sender.name
String
任意
表示名。LINEなど弊社のサービスと誤認される可能性があるワードは使用できません。
最大文字数：20
sender.iconUrl
String
任意
メッセージ送信時にアイコンとして表示する画像のURL
- 最大文字数：1000
- URLスキーム：https
アイコンおよび表示名を変更するテキストメッセージの例
# テキストメッセージ
文字数および絵文字の位置について
プロパティに指定するテキストの文字数、および絵文字の位置は、UTF-16でエンコーディングしたときの符号単位の数および位置です。 たとえば、サロゲートペアを使用する文字や、UTF-16で表現できる絵文字など、文字によっては、1文字ではなく複数文字としてカウントする必要があります。
type
String
必須
text
text
String
必須
メッセージのテキスト。以下の絵文字を含めることができます。
- Unicodeで定義された絵文字
- LINE絵文字。
$をプレースホルダとして使用します。詳細は、emojisプロパティで指定してください。 - （非推奨）LINEが独自に定義した絵文字。LINE独自の絵文字のUnicodeコードポイント表を参照してください。
最大文字数：5000
emojis
LINE絵文字オブジェクトの配列
1個以上のLINE絵文字
最大個数：20
emojis.index
Number
テキストの先頭を0とした、textプロパティ内の$（LINE絵文字のプレースホルダ）の位置。
詳しくは、「テキストメッセージの例」を参照してください。
注意
ここで指定した位置と、$の位置が一致しない場合は、400 Bad requestが返されます。
emojis.productId
String
LINE絵文字の集合を示すプロダクトID。参照：Sendable LINE emoji list
emojis.emojiId
String
プロダクトID内のLINE絵文字のID。参照：Sendable LINE emoji list
テキストメッセージの例
# スタンプメッセージ
スタンプメッセージの例
# 画像メッセージ
type
String
必須
image
originalContentUrl
String
必須
画像のURL（最大文字数：1000）
HTTPS（TLS 1.2以降）
JPG、JPEG、PNG
最大ファイルサイズ：10MB
previewImageUrl
String
必須
プレビュー画像のURL（最大文字数：1000）
HTTPS（TLS 1.2以降）
JPG、JPEG、PNG
最大ファイルサイズ：1MB
画像メッセージの例
# 動画メッセージ
type
String
必須
video
originalContentUrl
String
必須
動画ファイルのURL（最大文字数：1000）
HTTPS（TLS 1.2以降）
mp4
最大ファイルサイズ：200MB
注意
一定以上に縦長・横長の動画を送信した場合、一部の環境では動画の一部が欠けて表示される場合があります。
previewImageUrl
String
必須
プレビュー画像のURL（最大文字数：1000）
HTTPS（TLS 1.2以降）
JPEGまたはPNG
最大ファイルサイズ：1MB
trackingId
String
任意
動画視聴完了イベントが発生したときに、動画を識別するためのID。trackingIdを付与した動画メッセージを送信した場合に限り、ユーザーが動画の視聴を完了すると動画視聴完了イベントが発生します。
複数のメッセージで同じIDを使用することができます。
- 最大文字数：100
- 使用可能文字種：半角英数字（
a〜z、A～Z、0～9）、記号（-.=,+*()%$&;:@{}!?<>[]）
注意：trackingIdプロパティは、グループやトークルーム宛てのメッセージや、オーディエンスマッチでは使用できません。
動画メッセージの例
# 音声メッセージ
type
String
必須
audio
originalContentUrl
String
必須
音声ファイルのURL（最大文字数：1000）
HTTPS（TLS 1.2以降）
m4a
最大ファイルサイズ：200MB
注意
Messaging APIではM4Aファイルのみがサポートされます。お使いのサービスがMP3ファイルのみをサポートする場合は、FFmpegなどのサービスを使ってファイルをM4Aに変換できます。
duration
Number
必須
音声ファイルの長さ（ミリ秒）
音声メッセージの例
# 位置情報メッセージ
type
String
必須
location
title
String
必須
タイトル
最大文字数：100
address
String
必須
住所
最大文字数：100
latitude
Decimal
必須
緯度
longitude
Decimal
必須
経度
位置情報メッセージの例
# イメージマップメッセージ
イメージマップメッセージは、複数のタップ領域を設定した画像を送信できるメッセージです。画像全体に1つのタップ領域を割り当てることも、画像を区切って複数のタップ領域を設定することもできます。
また、画像の上で動画を再生したり、動画再生後にリンク先を設定したラベルを表示したりできます。
動画が正しく再生できない
動画が正しく再生できない場合、動画が再生可能なファイル形式であることと、動画をホストしているHTTPサーバーが、HTTPの部分リクエスト（Range request）に対応していることを確認してください。
type
String
必須
imagemap
baseUrl
String
必須
画像のベースURL
最大文字数：1000
HTTPS（TLS 1.2以降）
イメージマップメッセージで使える画像について詳しくは、「画像の設定方法」を参照してください。
altText
String
必須
代替テキスト
最大文字数：400
baseSize.width
Number
必須
基本画像の幅（px単位）。1040を指定します。
baseSize.height
Number
必須
基本画像の幅を1040pxとした場合の高さ
video.originalContentUrl
String
※1
動画ファイルのURL（最大文字数：1000）
HTTPS（TLS 1.2以降）
mp4
最大ファイルサイズ：200MB
注意
一定以上に縦長・横長の動画を送信した場合、一部の環境では動画の一部が欠けて表示される場合があります。
video.previewImageUrl
String
※1
プレビュー画像のURL（最大文字数：1000）
HTTPS（TLS 1.2以降）
JPG、JPEG、PNG
最大ファイルサイズ：1MB
video.area.x
Number
※1
イメージマップ領域の左端を基準とした動画領域の位置（横方向の相対位置）。0以上の値を設定してください。
video.area.y
Number
※1
イメージマップ領域の上端を基準とした動画領域の位置（縦方向の相対位置）。0以上の値を設定してください。
video.area.width
Number
※1
動画領域の幅
video.area.height
Number
※1
動画領域の高さ
video.externalLink.linkUri
String
※2
ウェブページのURL。動画再生後に表示されるラベルをタップしたときに呼び出されます。
最大文字数：1000
使用できるスキームは、http、https、line、およびtelです。 LINE URLスキームについて詳しくは、「LINE URLスキームでLINEの機能を使う」を参照してください。
video.externalLink.label
String
※2
ラベル。動画の再生が終了した後に表示されます。
最大文字数：30
actions
必須
画像がタップされたときのアクション
最大件数：50
※1 イメージマップで動画を再生する場合は必須です。
※2 イメージマップで動画を再生し、動画再生後にラベルを表示する場合は必須です。
2つのタップ領域を持つイメージマップメッセージの例
# 画像の設定方法
イメージマップメッセージで使用する画像は、以下の要件を満たす必要があります。
- 画像フォーマット：JPEGまたはPNG
- 画像の幅：240px、300px、460px、700px、および1040px
- 最大ファイルサイズ：1MB
「baseUrl/{image width}」というURL形式で、5つの異なるサイズの画像にアクセスできるようにしてください。LINEはユーザーのデバイスに応じて、適切な解像度の画像を取得します。
たとえば、画像のベースURLが「https://example.com/images/cats」だった場合、幅が700pxの画像のURLは「https://example.com/images/cats/700」になります。すべての画像のURLにアクセスして、画像が表示されることを確認してください。
| 画像の幅 | URLの例 |
|---|---|
| 240px | https://example.com/bot/images/rm001/240 |
| 300px | https://example.com/bot/images/rm001/300 |
| 460px | https://example.com/bot/images/rm001/460 |
| 700px | https://example.com/bot/images/rm001/700 |
| 1040px | https://example.com/bot/images/rm001/1040 |
注意
画像のURLには拡張子を含めないでください。「https://example.com/bot/images/rm001/700.png」のように、URLに拡張子が含まれている場合、イメージマップメッセージでは画像が表示されません。
# イメージマップアクションオブジェクト
イメージマップに設定するアクションとタップ領域を表すオブジェクトです。
領域がタップされると、uriの場合は指定するURIにユーザーがリダイレクトされ、messageの場合は指定するメッセージが送信されます。
# イメージマップURIアクションオブジェクト
type
String
必須
uri
label
String
任意
アクションのラベル。ユーザーデバイスのアクセシビリティ機能が有効な場合に読み上げられます。
最大文字数：50
iOS版LINE 8.2.0以降でサポートされます。
linkUri
String
必須
ウェブページのURL
最大文字数：1000
使用できるスキームは、http、https、line、およびtelです。 LINE URLスキームについて詳しくは、「LINE URLスキームでLINEの機能を使う」を参照してください。
area
タップ領域の定義
イメージマップURIアクションオブジェクトの例
# イメージマップメッセージアクションオブジェクト
type
String
必須
message
label
String
任意
アクションのラベル。ユーザーデバイスのアクセシビリティ機能が有効な場合に読み上げられます。
最大文字数：50
iOS版LINE 8.2.0以降でサポートされます。
text
String
必須
送信するメッセージ
最大文字数：400
iOS版とAndroid版のLINEでのみサポートされます。
area
タップ領域の定義
イメージマップメッセージアクションオブジェクトの例
# イメージマップ領域オブジェクト
タップ領域のサイズを表すオブジェクトです。画像の左上が座標の原点です。baseSize.widthプロパティとbaseSize.heightプロパティに基づいて指定します。
x
Number
必須
領域の左端を基準としたタップ領域の位置（横方向の相対位置）。0以上の値を設定してください。
y
Number
必須
領域の上端を基準としたタップ領域の位置（縦方向の相対位置）。0以上の値を設定してください。
width
Number
必須
タップ領域の幅
height
Number
必須
タップ領域の高さ
イメージマップ領域オブジェクトの例
# テンプレートメッセージ
テンプレートメッセージは、あらかじめレイアウトが定義されたテンプレートをカスタマイズして構築するメッセージです。詳しくは、「テンプレートメッセージ」を参照してください。
以下のタイプのテンプレートを利用できます。
# テンプレートメッセージオブジェクトの共通プロパティ
以下のプロパティは、すべてのテンプレートメッセージオブジェクトで共通です。
type
String
必須
template
altText
String
必須
代替テキスト。テンプレートメッセージに非対応のデバイスで表示されます。
最大文字数：400
# ボタンテンプレート
画像、タイトル、テキストに加えて、複数のアクションボタンが含まれたテンプレートです。
type
String
必須
buttons
thumbnailImageUrl
String
任意
画像URL（最大文字数：1000）
HTTPS（TLS 1.2以降）
JPEGまたはPNG
最大横幅サイズ：1024px
最大ファイルサイズ：1MB
imageAspectRatio
String
任意
画像のアスペクト比。以下のいずれかの値を指定します。
rectangle：1.51:1square：1:1
デフォルト値はrectangleです。
imageSize
String
任意
画像の表示形式。以下のいずれかの値を指定します。
cover：画像領域全体に画像を表示します。画像領域に収まらない部分は切り詰められます。contain：画像領域に画像全体を表示します。縦長の画像では左右に、横長の画像では上下に余白が表示されます。
デフォルト値はcoverです。
imageBackgroundColor
String
任意
画像の背景色。RGB値で設定します。デフォルト値は#FFFFFF（白）です。
title
String
任意
タイトル
最大文字数：40
text
String
必須
メッセージテキスト
画像もタイトルも指定しない場合の最大文字数：160
画像またはタイトルを指定する場合の最大文字数：60
defaultAction
任意
画像、タイトル、テキストの領域全体に対して設定できる、タップされたときのアクション
actions
アクションオブジェクトの配列
必須
タップされたときのアクション
最大件数：4
警告
ボタンテンプレートメッセージには高さに制限があり、textの表示領域がこの制限を超えると、領域の下部が切り詰められます。このため、メッセージのテキストが最大文字数以内であっても、文字幅によっては完全に表示されない可能性があります。
ボタンテンプレートメッセージの例
# 確認テンプレート
2つのアクションボタンを表示するテンプレートです。
type
String
必須
confirm
text
String
必須
メッセージのテキスト
最大文字数：240
actions
アクションオブジェクトの配列
必須
タップされたときのアクション
2つのボタンに1つずつアクションを設定します。
警告
確認テンプレートメッセージには高さに制限があり、textの表示領域がこの制限を超えると、領域の下部が切り詰められます。このため、メッセージのテキストが最大文字数以内であっても、文字幅によっては完全に表示されない可能性があります。
確認テンプレートメッセージの例
# カルーセルテンプレート
複数のカラムを表示するテンプレートです。カラムは横にスクロールして順番に表示できます。
type
String
必須
carousel
columns
カラムオブジェクトの配列
必須
カラムの配列
最大カラム数：10
imageAspectRatio
String
任意
画像のアスペクト比。以下のいずれかの値を指定します。
rectangle：1.51:1square：1:1
すべてのカラムに適用されます。デフォルト値はrectangleです。
imageSize
String
任意
画像の表示形式。以下のいずれかの値を指定します。
cover：画像領域全体に画像を表示します。画像領域に収まらない部分は切り詰められます。contain：画像領域に画像全体を表示します。縦長の画像では左右に、横長の画像では上下に余白が表示されます。
すべてのカラムに適用されます。デフォルト値はcoverです。
カルーセルテンプレートメッセージの例
# カルーセルのカラムオブジェクト
thumbnailImageUrl
String
任意
画像URL（最大文字数：1000）
HTTPS（TLS 1.2以降）
JPEGまたはPNG
縦横比：1:1.51
最大横幅サイズ：1024px
最大ファイルサイズ：1MB
imageBackgroundColor
String
任意
画像の背景色。RGB値で設定します。デフォルト値は#FFFFFF（白）です。
title
String
任意
タイトル
最大文字数：40
text
String
必須
メッセージテキスト
画像もタイトルも指定しない場合の最大文字数：120
画像またはタイトルを指定する場合の最大文字数：60
defaultAction
任意
画像、タイトル、テキストの領域全体に対して設定できる、タップされたときのアクション
actions
アクションオブジェクトの配列
必須
タップされたときのアクション
最大件数：3
警告
カルーセルテンプレートメッセージには高さに制限があり、textの表示領域がこの制限を超えると、領域の下部が切り詰められます。このため、メッセージのテキストが最大文字数以内であっても、文字幅によっては完全に表示されない可能性があります。
注意
各カラムのアクションの数は同じにします。画像またはタイトルの有無も、各カラムで統一してください。
# 画像カルーセルテンプレート
複数の画像を表示するテンプレートです。画像は横にスクロールして順番に表示できます。
type
String
必須
image_carousel
columns
カラムオブジェクトの配列
必須
カラムの配列
最大カラム数：10
画像カルーセルテンプレートメッセージの例
# 画像カルーセルのカラムオブジェクト
imageUrl
String
必須
画像URL（最大文字数：1000）
HTTPS（TLS 1.2以降）
JPEGまたはPNG
縦横比：1:1
最大横幅サイズ：1024px
最大ファイルサイズ：1MB
action
必須
画像がタップされたときのアクション
# Flex Message
Flex Messageは、CSS Flexible Box（CSS Flexbox）の基礎知識を使って、レイアウトを自由にカスタマイズできるメッセージです。Flex Messageの概要については、『Messaging APIドキュメント』の「Flex Messageを送信する」を参照してください。
Flex Messageの例
# コンテナ
コンテナは、Flex Messageの最上位の構造です。以下のタイプのコンテナを利用できます。
コンテナのJSONデータのサンプルや用途については、『Messaging APIドキュメント』の「Flex Messageの要素」を参照してください。
# バブル
1つのメッセージバブルを構成するコンテナです。ヘッダー、ヒーロー、ボディ、およびフッターの4つのブロックを含めることができます。各ブロックの用途について詳しくは、『Messaging APIドキュメント』の「ブロック」を参照してください。
バブルを定義するJSONデータの最大サイズは、30KBです。
type
String
必須
bubble
size
String
任意
バブルの大きさ。nano、micro、kilo、mega、gigaのいずれかの値を指定できます。デフォルト値はmegaです。
direction
String
任意
テキストの書字方向と、水平ボックス内でコンポーネントを配置する向き。以下のいずれかの値を指定します。
ltr：テキストは左横書き、コンポーネントは左から右に配置rtl：テキストは右横書き、コンポーネントは右から左に配置
デフォルト値はltrです。
header
Object
任意
ヘッダー。ボックスを指定します。
body
Object
任意
ボディ。ボックスを指定します。
footer
Object
任意
フッター。ボックスを指定します。
styles
Object
任意
各ブロックのスタイル。バブルスタイルを指定します。
action
Object
任意
バブルがタップされたときのアクション。アクションオブジェクトを指定します。このプロパティをサポートするLINEのバージョンは以下のとおりです。
- iOS版とAndroid版のLINE 8.11.0以降
バブルの例
# ブロックのスタイルを定義するオブジェクト
バブル内のブロックのスタイルは、以下の2つのオブジェクトを使って定義します。
バブルスタイルとブロックスタイルの例
# バブルスタイル
header
Object
任意
ヘッダーのスタイル。ブロックスタイルを指定します。
hero
Object
任意
ヒーローのスタイル。ブロックスタイルを指定します。
body
Object
任意
ボディのスタイル。ブロックスタイルを指定します。
footer
Object
任意
フッターのスタイル。ブロックスタイルを指定します。
# ブロックスタイル
backgroundColor
String
任意
ブロックの背景色。16進数カラーコードで設定します。
separator
Boolean
任意
ブロックの上にセパレータを配置する場合はtrueを指定します。デフォルト値はfalseです。
separatorColor
String
任意
セパレータの色。16進数カラーコードで設定します。
注意
先頭のブロックの上にはセパレータを配置できません。
# カルーセル
カルーセルは、子要素として1つ以上のバブルを持つコンテナです。カルーセル内のバブルは、横にスクロールして閲覧できます。
カルーセルを定義するJSONデータの最大サイズは、50KBです。
type
String
必須
carousel
contents
Objectの配列
必須
このカルーセル内のバブル。最大バブル数：10
バブルの幅
1つのカルーセルに、異なる幅（sizeプロパティ）のバブルを含めることはできません。バブルの幅は、カルーセルごとに揃えてください。
バブルの高さ
カルーセルの中で最大の高さのバブルと一致するように、各バブルのボディが伸長します。ただし、ボディがないバブルの大きさは変わりません。
カルーセルの例
# コンポーネント
コンポーネントは、ブロックを構成する要素です。以下のタイプのコンポーネントを利用できます。
各コンポーネントのJSONデータのサンプルや用途については、『Messaging APIドキュメント』の「Flex Messageの要素」と「Flex Messageのレイアウト」を参照してください。
# ボックス
子要素のレイアウトを定義するコンポーネントです。ボックスにボックスを含めることもできます。
type
String
必須
box
layout
String
必須
このボックス内のコンポーネントを配置する向き。詳しくは、『Messaging APIドキュメント』の「コンポーネントを配置する向き」を参照してください。
contents
Objectの配列
必須
backgroundColor
String
任意
ボックスの背景色。RGBカラーに加えて、アルファチャネル（透明度）も設定できます。16進数カラーコードで設定します。（例：#RRGGBBAA）デフォルト値は#00000000です。
borderColor
String
任意
ボックスの境界線の色。16進数カラーコードで設定します。
borderWidth
String
任意
ボックスの境界線の太さ。ピクセルまたはnone、light、normal、medium、semi-bold、boldのいずれかの値を指定できます。noneでは、境界線は描画されず、それ以外は列挙した順に太くなります。
cornerRadius
String
任意
ボックスの境界線の角を丸くするときの半径。ピクセル、またはnone、xs、sm、md、lg、xl、xxlのいずれかの値を指定できます。noneでは、角は丸くならず、それ以外は列挙した順に半径が大きくなります。デフォルト値はnoneです。
width
String
任意
ボックスの幅。詳しくは、『Messaging APIドキュメント』の「ボックスの幅」を参照してください。
height
String
任意
ボックスの高さ。詳しくは、『Messaging APIドキュメント』の「ボックスの高さ」を参照してください。
flex
Number
任意
親要素内での、このコンポーネントの幅または高さの比率。詳しくは、『Messaging APIドキュメント』の「コンポーネントの幅と高さ」を参照してください。
spacing
String
任意
このボックス内のコンポーネント間の最小スペース。デフォルト値はnoneです。詳しくは、『Messaging APIドキュメント』の「ボックスのspacingプロパティ」を参照してください。
margin
String
任意
親要素内での、このコンポーネントと前のコンポーネントの間の最小スペース。詳しくは、『Messaging APIドキュメント』の「コンポーネントのmarginプロパティ」を参照してください。
paddingAll
String
任意
このボックスの境界線と、子要素の間の余白。詳しくは、『Messaging APIドキュメント』の「ボックスのパディング」を参照してください。
paddingTop
String
任意
このボックスの上端の境界線と、子要素の上端の間の余白。詳しくは、『Messaging APIドキュメント』の「ボックスのパディング」を参照してください。
paddingBottom
String
任意
このボックスの下端の境界線と、子要素の下端の間の余白。詳しくは、『Messaging APIドキュメント』の「ボックスのパディング」を参照してください。
paddingStart
String
任意
このボックスの左端の境界線と、子要素の左端の間の余白。詳しくは、『Messaging APIドキュメント』の「ボックスのパディング」を参照してください。
paddingEnd
String
任意
このボックスの右端の境界線と、子要素の右端の間の余白。詳しくは、『Messaging APIドキュメント』の「ボックスのパディング」を参照してください。
position
String
任意
このボックスを配置する際の基準位置。以下のいずれかの値を指定します。
relative：直前のボックスを基準にします。absolute：親要素の左上を基準にします。
デフォルト値はrelativeです。詳しくは、『Messaging APIドキュメント』の「オフセット」を参照してください。
offsetTop
String
任意
オフセット。詳しくは、『Messaging APIドキュメント』の「オフセット」を参照してください。
offsetBottom
String
任意
オフセット。詳しくは、『Messaging APIドキュメント』の「オフセット」を参照してください。
offsetStart
String
任意
オフセット。詳しくは、『Messaging APIドキュメント』の「オフセット」を参照してください。
offsetEnd
String
任意
オフセット。詳しくは、『Messaging APIドキュメント』の「オフセット」を参照してください。
action
Object
任意
タップされたときのアクション。アクションオブジェクトを指定します。このプロパティをサポートするLINEのバージョンは以下のとおりです。
- iOS版とAndroid版のLINE 8.11.0以降
ボックスの例
# ボタン
ボタンを描画するコンポーネントです。ユーザーがタップすると、指定したアクションが実行されます。
type
String
必須
button
action
Object
必須
タップされたときのアクション。アクションオブジェクトを指定します。
flex
Number
任意
親要素内での、このコンポーネントの幅または高さの比率。詳しくは、『Messaging APIドキュメント』の「コンポーネントの幅と高さ」を参照してください。
margin
String
任意
親要素内での、このコンポーネントと前のコンポーネントの間の最小スペース。詳しくは、『Messaging APIドキュメント』の「コンポーネントのmarginプロパティ」を参照してください。
position
String
任意
offsetTop、offsetBottom、offsetStart、offsetEndの基準。以下のいずれかの値を指定します。
relative：直前のボックスを基準にします。absolute：親要素の左上を基準にします。
デフォルト値はrelativeです。詳しくは、『Messaging APIドキュメント』の「オフセット」を参照してください。
offsetTop
String
任意
オフセット。詳しくは、『Messaging APIドキュメント』の「オフセット」を参照してください。
offsetBottom
String
任意
オフセット。詳しくは、『Messaging APIドキュメント』の「オフセット」を参照してください。
offsetStart
String
任意
オフセット。詳しくは、『Messaging APIドキュメント』の「オフセット」を参照してください。
offsetEnd
String
任意
オフセット。詳しくは、『Messaging APIドキュメント』の「オフセット」を参照してください。
height
String
任意
ボタンの高さ。smまたはmdのいずれかの値を指定できます。デフォルト値はmdです。
style
String
任意
ボタンの表示形式。以下のいずれかの値を指定します。
primary：濃色のボタン向けのスタイルsecondary：淡色のボタン向けのスタイルlink：HTMLのリンクのスタイル
デフォルト値はlinkです。
color
String
任意
styleプロパティがlinkの場合は文字の色。styleプロパティがprimaryまたはsecondaryの場合は背景色です。16進数カラーコードで設定します。
gravity
String
任意
垂直方向の位置合わせ方式。詳しくは、『Messaging APIドキュメント』の「垂直方向の位置合わせ」を参照してください。
ボタンの例
# 画像
画像を描画するコンポーネントです。
type
String
必須
image
url
String
必須
画像のURL
プロトコル：HTTPS（TLS 1.2以降）
画像フォーマット：JPEGまたはPNG
最大画像サイズ：1024×1024px
最大データサイズ：1MB
flex
Number
任意
親要素内での、このコンポーネントの幅または高さの比率。詳しくは、『Messaging APIドキュメント』の「コンポーネントの幅と高さ」を参照してください。
margin
String
任意
親要素内での、このコンポーネントと前のコンポーネントの間の最小スペース。詳しくは、『Messaging APIドキュメント』の「コンポーネントのmarginプロパティ」を参照してください。
position
String
任意
offsetTop、offsetBottom、offsetStart、offsetEndの基準。以下のいずれかの値を指定します。
relative：直前のボックスを基準にします。absolute：親要素の左上を基準にします。
デフォルト値はrelativeです。詳しくは、『Messaging APIドキュメント』の「オフセット」を参照してください。
offsetTop
String
任意
オフセット。詳しくは、『Messaging APIドキュメント』の「オフセット」を参照してください。
offsetBottom
String
任意
オフセット。詳しくは、『Messaging APIドキュメント』の「オフセット」を参照してください。
offsetStart
String
任意
オフセット。詳しくは、『Messaging APIドキュメント』の「オフセット」を参照してください。
offsetEnd
String
任意
オフセット。詳しくは、『Messaging APIドキュメント』の「オフセット」を参照してください。
align
String
任意
水平方向の位置合わせ方式。詳しくは、『Messaging APIドキュメント』の「水平方向の位置合わせ」を参照してください。
gravity
String
任意
垂直方向の位置合わせ方式。詳しくは、『Messaging APIドキュメント』の「垂直方向の位置合わせ」を参照してください。
size
String
任意
画像の幅の最大サイズ。xxs、xs、sm、md、lg、xl、xxl、3xl、4xl、5xl、fullのいずれかの値を指定できます。列挙した順にサイズが大きくなります。デフォルト値はmdです。
aspectRatio
String
任意
画像のアスペクト比。{width}:{height}の形式で指定します。{width}と{height}は、それぞれ1～100000の値で入力します。ただし、{height}には{width}の3倍を超える値は指定できません。デフォルト値は1:1です。
aspectMode
String
任意
画像のアスペクト比とaspectRatioプロパティで指定されるアスペクト比が一致しない場合の、画像の表示方式。詳しくは、「描画領域について」を参照してください。
backgroundColor
String
任意
画像の背景色。16進数カラーコードで設定します。
action
Object
任意
タップされたときのアクション。アクションオブジェクトを指定します。
画像の例
# 描画領域について
sizeプロパティで画像の最大の幅を指定し、aspectRatioプロパティで画像のアスペクト比（横：縦の比率）を指定します。sizeプロパティとaspectRatioプロパティで決定される矩形の領域を、描画領域と呼びます。この描画領域に画像が表示されます。
flexプロパティによって算出されたコンポーネントの幅が、sizeプロパティで指定された画像の幅よりも小さい場合、描画領域の幅はコンポーネントの幅に縮小されます。- 画像のアスペクト比と
aspectRatioプロパティで指定されるアスペクト比が一致しない場合、aspectModeプロパティに基づいて画像が表示されます。デフォルト値はfitです。aspectModeがcoverの場合：描画領域全体に画像を表示します。描画領域に収まらない部分は切り詰められます。aspectModeがfitの場合：描画領域に画像全体を表示します。縦長の画像では左右に、横長の画像では上下に背景が表示されます。
# アイコン
隣接するテキストを装飾するために、アイコンを描画するコンポーネントです。
ベースラインボックス内でのみ使用できます。
type
String
必須
icon
url
String
必須
画像のURL
プロトコル：HTTPS（TLS 1.2以降）
画像フォーマット：JPEGまたはPNG
最大画像サイズ：1024×1024px
最大データサイズ：1MB
margin
String
任意
親要素内での、このコンポーネントと前のコンポーネントの間の最小スペース。詳しくは、『Messaging APIドキュメント』の「コンポーネントのmarginプロパティ」を参照してください。
position
String
任意
offsetTop、offsetBottom、offsetStart、offsetEndの基準。以下のいずれかの値を指定します。
relative：直前のボックスを基準にします。absolute：親要素の左上を基準にします。
デフォルト値はrelativeです。詳しくは、『Messaging APIドキュメント』の「オフセット」を参照してください。
offsetTop
String
任意
オフセット。詳しくは、『Messaging APIドキュメント』の「オフセット」を参照してください。
offsetBottom
String
任意
オフセット。詳しくは、『Messaging APIドキュメント』の「オフセット」を参照してください。
offsetStart
String
任意
オフセット。詳しくは、『Messaging APIドキュメント』の「オフセット」を参照してください。
offsetEnd
String
任意
オフセット。詳しくは、『Messaging APIドキュメント』の「オフセット」を参照してください。
size
String
任意
アイコンの幅の最大サイズ。xxs、xs、sm、md、lg、xl、xxl、3xl、4xl、5xlのいずれかの値を指定できます。列挙した順にサイズが大きくなります。デフォルト値はmdです。
aspectRatio
String
任意
アイコンのアスペクト比。{width}:{height}の形式で指定します。{width}と{height}は、それぞれ1～100000の値で入力します。ただし、{height}には{width}の3倍を超える値は指定できません。デフォルト値は1:1です。
アイコンのflexプロパティの値は、0に固定されます。
アイコンの例
# テキスト
1行の文字列を描画するコンポーネントです。色、サイズ、および太さを指定できます。
type
String
必須
text
text
String
任意
テキスト。textプロパティまたはcontentsプロパティのいずれかを必ず設定してください。contentsプロパティを設定すると、textは無視されます。
contents
Objectの配列
任意
スパンの配列。textプロパティまたはcontentsプロパティのいずれかを必ず設定してください。contentsプロパティを設定すると、textは無視されます。
flex
Number
任意
親要素内での、このコンポーネントの幅または高さの比率。詳しくは、『Messaging APIドキュメント』の「コンポーネントの幅と高さ」を参照してください。
margin
String
任意
親要素内での、このコンポーネントと前のコンポーネントの間の最小スペース。詳しくは、『Messaging APIドキュメント』の「コンポーネントのmarginプロパティ」を参照してください。
position
String
任意
offsetTop、offsetBottom、offsetStart、offsetEndの基準。以下のいずれかの値を指定します。
relative：直前のボックスを基準にします。absolute：親要素の左上を基準にします。
デフォルト値はrelativeです。詳しくは、『Messaging APIドキュメント』の「オフセット」を参照してください。
offsetTop
String
任意
オフセット。詳しくは、『Messaging APIドキュメント』の「オフセット」を参照してください。
offsetBottom
String
任意
オフセット。詳しくは、『Messaging APIドキュメント』の「オフセット」を参照してください。
offsetStart
String
任意
オフセット。詳しくは、『Messaging APIドキュメント』の「オフセット」を参照してください。
offsetEnd
String
任意
オフセット。詳しくは、『Messaging APIドキュメント』の「オフセット」を参照してください。
size
String
任意
フォントサイズ。xxs、xs、sm、md、lg、xl、xxl、3xl、4xl、5xlのいずれかの値を指定できます。列挙した順にサイズが大きくなります。デフォルト値はmdです。
align
String
任意
水平方向の位置合わせ方式。詳しくは、『Messaging APIドキュメント』の「水平方向の位置合わせ」を参照してください。
gravity
String
任意
垂直方向の位置合わせ方式。デフォルト値はtopです。詳しくは、『Messaging APIドキュメント』の「垂直方向の位置合わせ」を参照してください。
wrap
Boolean
任意
trueを指定すると文字列を折り返します。デフォルト値はfalseです。trueに設定した場合、改行文字（\n）を使って改行できます。詳しくは、『Messaging APIドキュメント』の「テキストを折り返す」を参照してください。
maxLines
Number
任意
最大行数。テキストがこの行数に収まらない場合は、最終行の末尾に省略記号（…）が表示されます。0ではすべてのテキストが表示されます。デフォルト値は0です。このプロパティをサポートするLINEのバージョンは以下のとおりです。
- iOS版とAndroid版のLINE 8.11.0以降
weight
String
任意
フォントの太さ。regular、boldのいずれかの値を指定できます。boldを指定すると太字になります。デフォルト値はregularです。
color
String
任意
フォントの色。16進数カラーコードで設定します。
action
Object
任意
タップされたときのアクション。アクションオブジェクトを指定します。
style
String
任意
テキストのスタイル。以下のいずれかの値を指定します。
normal：標準italic：斜体
デフォルト値はnormalです。
decoration
String
任意
テキストの装飾。以下のいずれかの値を指定します。
none：装飾なしunderline：下線line-through：取り消し線
デフォルト値はnoneです。
テキストの例
# スパン
1行に、デザインが異なる複数の文字列を描画するコンポーネントです。色、サイズ、太さ、および装飾を指定できます。スパンは、テキストのcontentsプロパティに設定します。
type
String
必須
span
text
String
任意
テキスト。親のテキストのwrapプロパティをtrueに設定した場合は、改行文字（\n）を使って改行できます。
color
String
任意
フォントの色。16進数カラーコードで設定します。
size
String
任意
フォントサイズ。xxs、xs、sm、md、lg、xl、xxl、3xl、4xl、5xlのいずれかの値を指定できます。列挙した順にサイズが大きくなります。デフォルト値はmdです。
weight
String
任意
フォントの太さ。regular、boldのいずれかの値を指定できます。boldを指定すると太字になります。デフォルト値はregularです。
style
String
任意
テキストのスタイル。以下のいずれかの値を指定します。
normal：標準italic：斜体
デフォルト値はnormalです。
decoration
String
任意
テキストの装飾。以下のいずれかの値を指定します。
none：装飾なしunderline：下線line-through：取り消し線
デフォルト値はnoneです。
注意
テキストのdecorationプロパティで設定した装飾は、スパンのdecorationプロパティで上書きできません。
スパンの例
# セパレータ
ボックス内に分割線を描画するコンポーネントです。水平ボックスでは垂直線、垂直ボックスでは水平線が描画されます。
type
String
必須
separator
margin
String
任意
親要素内での、このコンポーネントと前のコンポーネントの間の最小スペース。詳しくは、『Messaging APIドキュメント』の「コンポーネントのmarginプロパティ」を参照してください。
color
String
任意
セパレータの色。16進数カラーコードで設定します。
セパレータの例
# フィラー
スペースを作るためのコンポーネントです。ボックス内の任意の位置に挿入することで、コンポーネントの間にスペースを作ったり、他のコンポーネントを一方向に寄せたりできます。
type
String
必須
filler
flex
Number
任意
親要素内での、このコンポーネントの幅または高さの比率。詳しくは、『Messaging APIドキュメント』の「コンポーネントの幅と高さ」を参照してください。
フィラーでは親要素のspacingプロパティが無視されます。
フィラーの例
# スペーサー（非推奨）
注意
スペーサーは、将来のアップデートで削除される予定です。スペーサーを使わずに、ボックスのパディングを指定してください。詳しくは、『Messaging APIドキュメント』の「ボックスのパディング」を参照してください。
ボックス内の先頭または末尾に固定サイズのスペースを配置する不可視のコンポーネントです。
type
String
必須
spacer
size
String
任意
スペースのサイズ。xs、sm、md、lg、xl、xxlのいずれかの値を指定できます。列挙した順にサイズが大きくなります。デフォルト値はmdです。
スペーサーでは親要素のspacingプロパティが無視されます。
スペーサーの例
# アクションオブジェクト
ユーザーがメッセージ内のボタンまたは画像をタップしたときに、ボットが実行できるアクションのタイプです。
# ポストバックアクション
このアクションが関連づけられたコントロールがタップされると、dataプロパティに指定された文字列を含むポストバックイベントが、Webhookを介して返されます。
type
String
必須
postback
label
String
説明を参照
アクションのラベル
- 画像カルーセル以外のテンプレートメッセージには必須です。最大文字数：20
- 画像カルーセルテンプレートメッセージでは省略可能です。最大文字数：12
- リッチメニューでは省略可能です。ユーザーデバイスのアクセシビリティ機能が有効な場合に読み上げられます。最大文字数：20。iOS版LINE 8.2.0以降でサポートされます。
- クイックリプライボタンでは必須です。最大文字数：20。Android版とiOS版のLINE 8.11.0以降でサポートされます。
- Flex Messageでは、ボタンで必須です。ボックス、画像、およびテキストでは、指定しても表示されません。最大文字数：20
data
String
必須
Webhookを介して、ポストバックイベントのpostback.dataプロパティで返される文字列
最大文字数：300
displayText
String
説明を参照
アクションの実行時に、ユーザーのメッセージとしてLINEのトーク画面に表示されるテキスト。クイックリプライボタンでは必須です。それ以外のメッセージタイプでは省略可能です。
最大文字数：300
displayTextプロパティとtextプロパティは、同時に設定できません。
text
String
任意
【廃止予定】アクションの実行時に、ユーザーのメッセージとしてLINEのトーク画面に表示されるテキスト。Webhookを介してサーバーに返されます。クイックリプライボタンでは使用しないでください。
最大文字数：300
displayTextプロパティとtextプロパティは、同時に設定できません。
ポストバックアクションオブジェクトの例
# メッセージアクション
このアクションが関連づけられたコントロールがタップされると、textプロパティの文字列がユーザーからのメッセージとして送信されます。
type
String
必須
message
label
String
説明を参照
アクションのラベル
- 画像カルーセル以外のテンプレートメッセージには必須です。最大文字数：20
- 画像カルーセルテンプレートメッセージでは省略可能です。最大文字数：12
- リッチメニューでは省略可能です。ユーザーデバイスのアクセシビリティ機能が有効な場合に読み上げられます。最大文字数：20。iOS版LINE 8.2.0以降でサポートされます。
- クイックリプライボタンでは必須です。最大文字数：20。Android版とiOS版のLINE 8.11.0以降でサポートされます。
- Flex Messageでは、ボタンで必須です。ボックス、画像、およびテキストでは、指定しても表示されません。最大文字数：20
text
String
必須
アクションの実行時に送信されるテキスト
最大文字数：300
メッセージアクションオブジェクトの例
# URIアクション
このアクションが関連づけられたコントロールがタップされると、uriプロパティのURIが開きます。
type
String
必須
uri
label
String
説明を参照
アクションのラベル
- 画像カルーセル以外のテンプレートメッセージには必須です。最大文字数：20
- 画像カルーセルテンプレートメッセージでは省略可能です。最大文字数：12
- リッチメニューでは省略可能です。ユーザーデバイスのアクセシビリティ機能が有効な場合に読み上げられます。最大文字数：20。iOS版LINE 8.2.0以降でサポートされます。
- Flex Messageでは、ボタンで必須です。ボックス、画像、およびテキストでは、指定しても表示されません。最大文字数：20
uri
String
必須
アクションの実行時に開かれるURI（最大文字数：1000）
使用できるスキームは、http、https、line、およびtelです。LINE URLスキームについて詳しくは、「LINE URLスキームでLINEの機能を使う」を参照してください。
altUri.desktop
String
任意
macOS版とWindows版のLINEでアクションを実行したときに開かれるURI（最大文字数：1000）
altUri.desktopを指定した場合は、macOS版とWindows版のLINEではuriが無視されます。
使用できるスキームは、http、https、line、およびtelです。LINE URLスキームについて詳しくは、「LINE URLスキームでLINEの機能を使う」を参照してください。このプロパティを使用できるLINEのバージョンは以下のとおりです。
- macOS版とWindows版のLINE：5.12.0以降
注意
altUri.desktopは、Flex MessageにURIアクションを関連付けた場合にのみ有効です。
URIアクションオブジェクトの例
# 日時選択アクション
このアクションが関連づけられたコントロールがタップされると、日時選択ダイアログでユーザーが選択した日時を含むポストバックイベントが、Webhookを介して返されます。日時選択アクションはタイムゾーンの違いに対応していません。
type
String
必須
datetimepicker
label
String
説明を参照
アクションのラベル
- 画像カルーセル以外のテンプレートメッセージには必須です。最大文字数：20
- 画像カルーセルテンプレートメッセージでは省略可能です。最大文字数：12
- リッチメニューでは省略可能です。ユーザーデバイスのアクセシビリティ機能が有効な場合に読み上げられます。最大文字数：20。iOS版LINE 8.2.0以降でサポートされます。
- クイックリプライボタンでは必須です。最大文字数：20。Android版とiOS版のLINE 8.11.0以降でサポートされます。
- Flex Messageでは、ボタンで必須です。ボックス、画像、およびテキストでは、指定しても表示されません。最大文字数：20
data
String
必須
Webhookを介して、ポストバックイベントのpostback.dataプロパティで返される文字列
最大文字数：300
mode
String
必須
アクションモード
date：日付を選択します。
time：時刻を選択します。
datetime：日付と日時を選択します。
initial
String
任意
日付または時刻の初期値
max
String
任意
選択可能な日付または時刻の最大値。minの値より大きい必要があります。
min
String
任意
選択可能な日付または時刻の最小値。maxの値より小さい必要があります。
日時選択アクションオブジェクトの例
# 日付と日時の形式
initial、max、およびminの値の日付と日時の形式は以下のとおりです。full-date、time-hour、およびtime-minuteの形式は、RFC3339プロトコルで定義されています。
| モード | 形式 | 例 |
|---|---|---|
| date | full-date最大値：2100-12-31 最小値：1900-01-01 | 2017-06-18 |
| time | time-hour:time-minute最大値：23:59 最小値：00:00 | 00:00 06:15 23:59 |
| datetime | full-dateTtime-hour:time-minuteまたはfull-datettime-hour:time-minute最大値：2100-12-31T23:59 最小値：1900-01-01T00:00 | 2017-06-18T06:15 2017-06-18t06:15 |
# カメラアクション
クイックリプライボタンにのみ設定できるアクションです。このアクションが関連づけられたボタンがタップされると、LINE内のカメラが起動します。
type
String
必須
camera
label
String
必須
アクションのラベル
最大文字数：20
カメラアクションオブジェクトの例
# カメラロールアクション
クイックリプライボタンにのみ設定できるアクションです。このアクションが関連づけられたボタンがタップされると、LINEのカメラロール画面が開きます。
type
String
必須
cameraRoll
label
String
必須
アクションのラベル
最大文字数：20
カメラロールアクションオブジェクトの例
# 位置情報アクション
クイックリプライボタンにのみ設定できるアクションです。このアクションが関連づけられたボタンがタップされると、LINEの位置情報画面が開きます。
type
String
必須
location
label
String
必須
アクションのラベル
最大文字数：20
位置情報アクションオブジェクトの例
# リッチメニューの構造
リッチメニューは以下のどちらかのオブジェクトで表されます。
- リッチメニューIDを含まないリッチメニューオブジェクト。リッチメニューの作成時にこのオブジェクトを使用します。
- リッチメニューIDを含むリッチメニューレスポンスオブジェクト。リッチメニューの取得時またはリッチメニューの配列の取得時にこのオブジェクトが返されます。
これらのオブジェクトは領域オブジェクトとアクションオブジェクトから構成されます。
# リッチメニューオブジェクト
size
Object
必須
sizeオブジェクト。トークルームに表示されるリッチメニューの幅と高さを表します。使用できるリッチメニューの画像の幅サイズは800px以上2500px以下で、高さサイズは250px以上です。ただし幅/高さのアスペクト比は、1.45以上になるようにします。
selected
Boolean
必須
デフォルトでリッチメニューを表示する場合はtrueです。それ以外はfalseです。
name
String
必須
リッチメニューの名前。リッチメニューの管理に役立ちます。ユーザーには表示されません。
最大文字数：300
chatBarText
String
必須
トークルームメニューに表示されるテキストです。
最大文字数：14
areas
Array
必須
タップ領域の座標とサイズを定義する、領域オブジェクトの配列。
最大領域オブジェクト数：20
リッチメニューオブジェクトの例
# リッチメニューレスポンスオブジェクト
richMenuId
String
リッチメニューのID
size
Object
sizeオブジェクト。トークルームに表示されるリッチメニューの幅と高さを表します。使用できるリッチメニューの画像の幅サイズは800px以上2500px以下で、高さサイズは250px以上です。ただし幅/高さのアスペクト比は、1.45以上になるようにします。
selected
Boolean
デフォルトでリッチメニューを表示する場合はtrueです。それ以外はfalseです。
name
String
リッチメニューの名前。リッチメニューの管理に役立ちます。ユーザーには表示されません。
最大文字数：300
chatBarText
String
トークルームメニューに表示されるテキストです。
最大文字数：14
areas
Array
タップ領域の座標とサイズを定義する、領域オブジェクトの配列。
最大領域オブジェクト数：20
リッチメニューレスポンスオブジェクトの例
# sizeオブジェクト
width
Number
必須
リッチメニューの幅。800以上、2500以下の値を指定します。ただし、幅/高さのアスペクト比が1.45以上になるようにします。
height
Number
必須
リッチメニューの高さ。250以上の値を指定します。ただし、幅/高さのアスペクト比が1.45以上になるようにします。
sizeオブジェクトの例
# 領域オブジェクト
bounds
Object
必須
領域の境界をピクセルで表すオブジェクト。「boundsオブジェクト」を参照してください。
action
Object
必須
領域がタップされたときに実行されるアクション。「アクションオブジェクト」を参照してください。
領域オブジェクトの例
# boundsオブジェクト
x
Number
必須
画像の左端を基準としたタップ領域の位置（横方向の相対位置）。0以上の値を設定してください。
y
Number
必須
画像の上端を基準としたタップ領域の位置（縦方向の相対位置）。0以上の値を設定してください。
width
Number
必須
タップ領域の幅
height
Number
必須
タップ領域の高さ
boundsオブジェクトの例