Messaging APIリファレンス

共通仕様

Messaging APIにおけるエンドポイントのドメイン名、リクエストが成功・失敗した際のレスポンス、レート制限などの共通仕様です。

• ドメイン名
• レート制限
• ステータスコード
• レスポンスヘッダー
• エラーレスポンス
• その他の共通仕様

domain-name rate-limits rate-limits-scpoe limit-on-the-number-of-concurrent-operations status-codes response-headers error-responses error-messages error-details-message error-handling-methods other-common-specifications url-encoding

Webhook

友だち追加やメッセージの送信のようなイベントが発生すると、LINEプラットフォームからWebhook URL（ボットサーバー）にHTTPS POSTリクエストが送信されます。

Webhook URLはチャネルごとにLINE Developersコンソールで設定します。

request-headers request-body response signature-validation

Webhookイベントオブジェクト

LINEプラットフォームで生成されるイベントを含むJSONオブジェクトです。

common-properties source-user source-group source-room message-event wh-text wh-image wh-video wh-audio wh-file wh-location wh-sticker unsend-event follow-event unfollow-event join-event leave-event member-joined-event member-left-event postback-event postback-params-object postback-params-object-for-richmenu-switch-action video-viewing-complete beacon-event beacon-event-types account-link-event device-link-event device-unlink-event scenario-result-event things-result-resultcode

Webhook設定

チャネルのWebhookエンドポイントを設定、検証、取得します。

エンドポイント一覧

PUT  /v2/bot/channel/webhook/endpoint

GET  /v2/bot/channel/webhook/endpoint

POST /v2/bot/channel/webhook/test

set-webhook-endpoint-url set-webhook-endpoint-url-request-headers set-webhook-endpoint-url-request-body set-webhook-endpoint-url-response set-webhook-endpoint-url-error-response get-webhook-endpoint-information get-webhook-endpoint-information-request-headers get-webhook-endpoint-information-response get-webhook-endpoint-information-error-response test-webhook-endpoint test-webhook-endpoint-request-headers test-webhook-endpoint-request-body test-webhook-endpoint-response test-webhook-endpoint-error-response

コンテンツ取得

ユーザーがLINE公式アカウントに対して送信したコンテンツを、Webhookで受信したメッセージIDを使うことで取得できます。

エンドポイント一覧

GET /v2/bot/message/{messageId}/content

GET /v2/bot/message/{messageId}/content/transcoding

GET /v2/bot/message/{messageId}/content/preview

get-content get-content-request-headers get-content-path-parameters get-content-response get-content-error-response verify-video-or-audio-preparation-status verify-video-or-audio-preparation-status-request-headers verify-video-or-audio-preparation-status-path-parameters verify-video-or-audio-preparation-status-response verify-video-or-audio-preparation-status-error-response get-image-or-video-preview get-content-preview-request-headers get-content-preview-path-parameters get-content-preview-response get-content-preview-error-response

チャネルアクセストークン

アプリからMessaging APIを呼び出す際に必要となるチャネルアクセストークンを発行、取得、取り消しします。

エンドポイント一覧

POST /oauth2/v2.1/token

GET  /oauth2/v2.1/verify

GET  /oauth2/v2.1/tokens/kid

POST /oauth2/v2.1/revoke

POST /v2/oauth/accessToken

POST /v2/oauth/verify

POST /v2/oauth/revoke

issue-channel-access-token-v2-1 issue-channel-access-token-v2.1-request-headers issue-channel-access-token-v2.1-request-body issue-channel-access-token-v2.1-response issue-channel-access-token-v2.1-error-response verfiy-channel-access-token-v2-1 verfiy-channel-access-token-v2-1-query-parameters verfiy-channel-access-token-v2-1-response verfiy-channel-access-token-v2-1-error-response get-all-valid-channel-access-token-key-ids-v2-1 get-all-issued-channel-access-token-key-ids-v2.1-query-parameter get-all-issued-channel-access-token-key-ids-v2.1-response get-all-issued-channel-access-token-key-ids-v2.1-error-response revoke-channel-access-token-v2-1 revoke-channel-access-token-v2.1-request-body revoke-channel-access-token-v2.1-response revoke-channel-access-token-v2.1-error-response issue-shortlived-channel-access-token issue-channel-access-token-playground issue-channel-access-token-request-headers issue-channel-access-token-request-body issue-channel-access-token-response issue-channel-access-token-error-response verfiy-channel-access-token verfiy-channel-access-token-request-headers verfiy-channel-access-token-request-body verfiy-channel-access-token-response verfiy-channel-access-token-error-response revoke-longlived-or-shortlived-channel-access-token revoke-channel-access-token-playground revoke-channel-access-token-request-headers revoke-channel-access-token-request-body revoke-channel-access-token-response revoke-channel-access-token-error-response

メッセージ

メッセージを送ったり、送信済みメッセージについての情報を取得したりできます。

エンドポイント一覧

POST /v2/bot/message/reply

POST /v2/bot/message/push

POST /v2/bot/message/multicast

POST /v2/bot/message/narrowcast

GET  /v2/bot/message/progress/narrowcast

POST /v2/bot/message/broadcast

GET  /v2/bot/message/quota

GET  /v2/bot/message/quota/consumption

GET  /v2/bot/message/delivery/reply

GET  /v2/bot/message/delivery/push

GET  /v2/bot/message/delivery/multicast

GET  /v2/bot/message/delivery/broadcast

POST /v2/bot/message/validate/reply

POST /v2/bot/message/validate/push

POST /v2/bot/message/validate/multicast

POST /v2/bot/message/validate/narrowcast

POST /v2/bot/message/validate/broadcast

GET  /v2/bot/message/aggregation/info

GET  /v2/bot/message/aggregation/list

send-reply-message send-reply-message-reply-token send-reply-message-request-headers send-reply-message-request-body send-reply-message-response send-reply-message-error-response send-push-message send-push-message-conditions send-push-message-request-headers send-push-message-request-body send-push-message-response send-push-message-error-response send-multicast-message send-multicast-message-conditions send-multicast-request-headers send-multicast-request-body send-multicast-response send-multicast-message-error-response send-narrowcast-message send-narrowcast-message-conditions send-narrowcast-message-restrictions send-narrowcast-message-cautions send-narrowcast-request-headers send-narrowcast-request-body narrowcast-recipient narrowcast-recipient-audience-objects narrowcast-recipient-redelivery-object narrowcast-recipient-logical-operator-objects narrowcast-demographic-filter narrowcast-demographic-filter-gender narrowcast-demographic-filter-age narrowcast-demographic-filter-operating-system narrowcast-demographic-filter-region narrowcast-demographic-filter-friendship-duration narrowcast-demographic-filter-logical-operator-objects send-narrowcast-response send-narrowcast-error-response get-narrowcast-progress-status get-narrowcast-progress-status-request-headers get-narrowcast-progress-status-query-parameters get-narrowcast-progress-status-response get-narrowcast-progress-status-error-response send-broadcast-message send-broadcast-request-headers send-broadcast-request-body send-broadcast-response send-broadcast-message-error-response get-quota get-quota-playground get-quota-request-headers get-quota-response get-consumption get-number-of-sent-messages-playground get-number-of-sent-messages-request-headers get-number-of-sent-messages-response get-number-of-reply-messages get-number-of-reply-messages-playground get-number-of-reply-messages-request-headers get-number-of-reply-messages-query-parameters get-number-of-reply-messages-response get-number-of-push-messages get-number-of-push-messages-playground get-number-of-push-messages-request-headers get-number-of-push-messages-query-parameters get-number-of-push-messages-response get-number-of-multicast-messages get-number-of-multicast-messages-playground get-number-of-multicast-messages-request-headers get-number-of-multicast-messages-query-parameters get-number-of-multicast-messages-response get-number-of-broadcast-messages get-number-of-broadcast-messages-request-headers get-number-of-broadcast-messages-query-parameters get-number-of-broadcast-messages-response validate-message-objects-of-reply-message validate-message-objects-of-reply-message-request-headers validate-message-objects-of-reply-message-request-body validate-message-objects-of-reply-message-response validate-message-objects-of-reply-message-error-response validate-message-objects-of-push-message validate-message-objects-of-push-message-request-headers validate-message-objects-of-push-message-request-body validate-message-objects-of-push-message-response validate-message-objects-of-push-message-error-response validate-message-objects-of-multicast-message validate-message-objects-of-multicast-message-request-headers validate-message-objects-of-multicast-message-request-body validate-message-objects-of-multicast-message-response validate-message-objects-of-multicast-message-error-response validate-message-objects-of-narrowcast-message validate-message-objects-of-narrowcast-message-request-headers validate-message-objects-of-narrowcast-message-request-body validate-message-objects-of-narrowcast-message-response validate-message-objects-of-narrowcast-message-error-response validate-message-objects-of-broadcast-message validate-message-objects-of-broadcast-message-request-headers validate-message-objects-of-broadcast-message-request-body validate-message-objects-of-broadcast-message-response validate-message-objects-of-broadcast-message-error-response get-number-of-units-used-this-month get-number-of-units-used-this-month-request-headers get-number-of-units-used-this-month-response get-name-list-of-units-used-this-month get-name-list-of-units-used-this-month-request-headers get-name-list-of-units-used-this-month-query-parameters get-name-list-of-units-used-this-month-response retry-api-request retry-api-request-request-headers retry-api-request-response

オーディエンス管理

オーディエンスを作成、更新、有効化、削除できます。オーディエンスは、ナローキャストメッセージを配信する際に指定します。

エンドポイント一覧

POST   /v2/bot/audienceGroup/upload

POST   /v2/bot/audienceGroup/upload/byFile

PUT    /v2/bot/audienceGroup/upload

PUT    /v2/bot/audienceGroup/upload/byFile

POST   /v2/bot/audienceGroup/click

POST   /v2/bot/audienceGroup/imp

PUT    /v2/bot/audienceGroup/{audienceGroupId}/updateDescription

PUT    /v2/bot/audienceGroup/{audienceGroupId}/activate

DELETE /v2/bot/audienceGroup/{audienceGroupId}

GET    /v2/bot/audienceGroup/{audienceGroupId}

GET    /v2/bot/audienceGroup/list

GET    /v2/bot/audienceGroup/authorityLevel

PUT    /v2/bot/audienceGroup/authorityLevel

create-upload-audience-group create-upload-audience-group-conditions create-upload-audience-group-request-headers create-upload-audience-group-request-body create-upload-audience-group-response create-upload-audience-group-error-response create-upload-audience-group-by-file create-upload-audience-group-by-file-conditions create-upload-audience-group-by-file-request-headers create-upload-audience-group-by-file-request-body create-upload-audience-group-by-file-response create-upload-audience-group-by-file-error-response update-upload-audience-group update-upload-audience-group-conditions update-upload-audience-group-request-headers update-upload-audience-group-request-body update-upload-audience-group-response update-upload-audience-group-error-response update-upload-audience-group-by-file update-upload-audience-group-by-file-conditions update-upload-audience-group-by-file-request-headers update-upload-audience-group-by-file-request-body update-upload-audience-group-by-file-response update-upload-audience-group-by-file-error-response create-click-audience-group create-click-audience-group-request-headers create-click-audience-group-request-body create-click-audience-group-response create-click-audience-group-error-response create-imp-audience-group create-imp-audience-group-request-headers create-imp-audience-group-request-body create-imp-audience-group-response create-imp-audience-group-error-response set-description-audience-group set-description-audience-group-request-headers set-description-audience-group-path-parameters set-description-audience-group-request-body set-description-audience-group-response set-description-audience-group-error-response activate-audience-group activate-audience-group-request-headers activate-audience-group-path-parameters activate-audience-group-response activate-audience-group-error-response delete-audience-group delete-audience-group-request-headers delete-audience-group-path-parameters delete-audience-group-response delete-audience-group-error-response get-audience-group get-audience-group-request-headers get-audience-group-path-parameters get-audience-group-response get-audience-group-error-response get-audience-groups get-audience-groups-request-headers get-audience-groups-query-parameters get-audience-groups-response get-audience-groups-error-response get-authority-level get-authority-level-request-headers get-authority-level-response change-authority-level change-authority-level-request-headers change-authority-level-request-body change-authority-level-response

分析

LINE公式アカウントから送信したメッセージの数や友だち数、統計情報などを取得できます。

エンドポイント一覧

GET /v2/bot/insight/message/delivery?date={date}

GET /v2/bot/insight/followers?date={date}

GET /v2/bot/insight/demographic

GET /v2/bot/insight/message/event?requestId={requestId}

GET /v2/bot/insight/message/event/aggregation?customAggregationUnit={customAggregationUnit}&from={from}&to={to}

get-number-of-delivery-messages get-insight-message-delivery-request-headers get-insight-message-delivery-query-parameters get-insight-message-delivery-response get-number-of-followers get-insight-followers-request-headers get-insight-followers-query-parameters get-insight-followers-response get-demographic get-insight-demographic-request-headers get-insight-demographic-response get-message-event get-insight-message-event-request-headers get-insight-message-event-query-parameters get-insight-message-event-response get-statistics-per-unit get-statistics-per-unit-request-headers get-statistics-per-unit-query-parameters get-statistics-per-unit-response

ユーザー

LINE公式アカウントを友だち追加したユーザーの情報を取得できます。

自分のユーザーIDを取得する

自分のユーザーIDは、LINE Developersコンソールのチャネルの［チャネル基本設定］タブにある［あなたのユーザーID］で確認できます。LINE Developersコンソールのアクセス権限について詳しくは、『権限を管理する』の「チャネルの権限」を参照してください。開発者が自分自身のユーザーIDを取得するためのAPIはありません。

エンドポイント一覧

GET /v2/bot/profile/{userId}

GET /v2/bot/followers/ids

get-profile get-profile-playground get-profile-request-headers get-profile-path-parameters get-profile-response get-profile-error-response get-follower-ids get-follower-ids-obtainable-ids get-follower-ids-request-headers get-follower-ids-query-parameters get-follower-ids-response get-follower-ids-error-response

ボット

LINE公式アカウントのボットの基本情報を取得できます。

エンドポイント一覧

GET /v2/bot/info

get-bot-info get-bot-info-request-headers get-bot-info-response

グループトーク

LINE公式アカウントが参加しているグループトークの情報や、グループトークのメンバーの情報を取得できます。

エンドポイント一覧

GET  /v2/bot/group/{groupId}/summary

GET  /v2/bot/group/{groupId}/members/count

GET  /v2/bot/group/{groupId}/members/ids

GET  /v2/bot/group/{groupId}/member/{userId}

POST /v2/bot/group/{groupId}/leave

get-group-summary get-group-summary-request-headers get-group-summary-path-parameters get-group-summary-response get-group-summary-error-response get-members-group-count get-members-in-group-count-request-headers get-members-in-group-count-path-parameters get-count-members-in-group-response get-count-members-in-group-error-response get-group-member-user-ids get-group-member-ids-request-headers get-group-member-ids-path-parameters get-group-member-ids-query-parameters get-group-member-user-ids-response get-group-member-user-ids-error-response get-group-member-profile get-group-member-profile-request-headers get-group-member-profile-path-parameters get-group-member-profile-response get-group-member-profile-error-response leave-group leave-group-request-headers leave-group-path-parameters leave-group-response leave-group-error-response

複数人トーク

LINE公式アカウントが参加している複数人トークの情報や、複数人トークのメンバーの情報を取得できます。

エンドポイント一覧

GET  /v2/bot/room/{roomId}/members/count

GET  /v2/bot/room/{roomId}/members/ids

GET  /v2/bot/room/{roomId}/member/{userId}

POST /v2/bot/room/{roomId}/leave

get-members-room-count get-members-in-room-count-request-headers get-members-in-room-count-path-parameters get-count-members-in-room-response get-room-member-user-ids get-room-member-ids-request-headers get-room-member-ids-path-parameters get-room-member-ids-query-parameters get-room-member-user-ids-response get-room-member-profile get-room-member-profile-request-headers get-room-member-profile-path-parameters get-room-member-profile-response leave-room leave-room-request-headers leave-room-path-parameters leave-room-response

リッチメニュー

LINE公式アカウントのトーク画面に表示される、カスタマイズ可能なメニューです。詳しくは、「リッチメニューを使う」を参照してください。

エンドポイント一覧

POST   /v2/bot/richmenu

POST   /v2/bot/richmenu/validate

POST   /v2/bot/richmenu/{richMenuId}/content

GET    /v2/bot/richmenu/{richMenuId}/content

GET    /v2/bot/richmenu/list

GET    /v2/bot/richmenu/{richMenuId}

DELETE /v2/bot/richmenu/{richMenuId}

POST   /v2/bot/user/all/richmenu/{richMenuId}

GET    /v2/bot/user/all/richmenu

DELETE /v2/bot/user/all/richmenu

POST   /v2/bot/richmenu/alias

DELETE /v2/bot/richmenu/alias/{richMenuAliasId}

POST   /v2/bot/richmenu/alias/{richMenuAliasId}

GET    /v2/bot/richmenu/alias/{richMenuAliasId}

GET    /v2/bot/richmenu/alias/list

POST   /v2/bot/user/{userId}/richmenu/{richMenuId}

POST   /v2/bot/richmenu/bulk/link

GET    /v2/bot/user/{userId}/richmenu

DELETE /v2/bot/user/{userId}/richmenu

POST   /v2/bot/richmenu/bulk/unlink

create-rich-menu create-rich-menu-request-headers create-rich-menu-request-body create-rich-menu-response validate-rich-menu-object validate-rich-menu-object-request-headers validate-rich-menu-object-request-body validate-rich-menu-object-response validate-rich-menu-object-error-response upload-rich-menu-image upload-rich-menu-image-request-headers upload-rich-menu-image-path-parameters upload-rich-menu-image-response download-rich-menu-image download-rich-menu-image-request-headers download-rich-menu-image-path-parameters download-rich-menu-image-response get-rich-menu-list get-rich-menu-list-request-headers get-rich-menu-list-response get-rich-menu get-rich-menu-request-headers get-rich-menu-path-parameters get-rich-menu-response delete-rich-menu delete-rich-menu-request-headers delete-rich-menu-path-parameters delete-rich-menu-response set-default-rich-menu set-default-rich-menu-request-headers set-default-rich-menu-path-parameters set-default-rich-menu-response get-default-rich-menu-id get-default-rich-menu-id-request-headers get-default-rich-menu-id-response cancel-default-rich-menu cancel-default-rich-menu-request-headers cancel-default-rich-menu-response create-rich-menu-alias create-rich-menu-alias-request-headers create-rich-menu-alias-request-body create-rich-menu-alias-response create-rich-menu-alias-error-response delete-rich-menu-alias delete-rich-menu-alias-request-headers delete-rich-menu-alias-path-parameters delete-rich-menu-alias-response delete-rich-menu-alias-error-response update-rich-menu-alias update-rich-menu-alias-request-headers update-rich-menu-alias-path-parameters update-rich-menu-alias-request-body update-rich-menu-alias-response update-rich-menu-alias-error-response get-rich-menu-alias-by-id get-rich-menu-alias-by-id-request-headers get-rich-menu-alias-by-id-path-parameters get-rich-menu-alias-by-id-response get-rich-menu-alias-by-id-error-response get-rich-menu-alias-list get-rich-menu-alias-list-request-headers get-rich-menu-alias-list-response get-rich-menu-alias-list-error-response link-rich-menu-to-user link-rich-menu-to-user-conditions link-rich-menu-request-headers link-rich-menu-path-parameters link-rich-menu-response link-rich-menu-error-response link-rich-menu-to-users link-rich-menu-to-users-conditions bulk-link-rich-menu-request-headers bulk-link-rich-menu-request-body bulk-link-rich-menu-response bulk-link-rich-menu-error-response get-rich-menu-id-of-user get-rich-menu-id-request-headers get-rich-menu-id-path-parameters get-rich-menu-id-response unlink-rich-menu-from-user unlink-rich-menu-from-user-conditions unlink-rich-menu-request-headers unlink-rich-menu-path-parameters unlink-rich-menu-response unlink-rich-menu-error-response unlink-rich-menu-from-users unlink-rich-menu-from-users-conditions bulk-unlink-rich-menu-request-headers bulk-unlink-rich-menu-request-body bulk-unlink-rich-menu-response bulk-unlink-rich-menu-error-response

アカウント連携

プロバイダー（企業や開発者）が提供するサービスのアカウントと、LINEユーザーのアカウントを連携できます。

エンドポイント一覧

POST /v2/bot/user/{userId}/linkToken

issue-link-token issue-link-token-request-headers issue-link-token-path-parameters issue-link-token-response

メッセージオブジェクト

送信するメッセージの内容を表すJSONオブジェクトです。

メッセージオブジェクトが有効かを検証する

以下のエンドポイントを使用すると、メッセージオブジェクトが有効かを検証できます。

• 応答メッセージのメッセージオブジェクトを検証する
• プッシュメッセージのメッセージオブジェクトを検証する
• マルチキャストメッセージのメッセージオブジェクトを検証する
• ナローキャストメッセージのメッセージオブジェクトを検証する
• ブロードキャストメッセージのメッセージオブジェクトを検証する

message-common-properties quick-reply items-object quick-reply-button-object icon-nickname-switch text-message sticker-message image-message video-message audio-message location-message imagemap-message base-url imagemap-action-objects imagemap-uri-action-object imagemap-message-action-object imagemap-area-object template-messages common-properties-of-template-message-objects buttons confirm carousel column-object-for-carousel image-carousel column-object-for-image-carousel flex-message operating-environment container bubble style-setting-objects bubble-style block-style f-carousel flex-component box button f-image drawing-area f-video icon f-text span separator filler

アクションオブジェクト

ユーザーがメッセージ内のボタンまたは画像をタップしたときに、ボットが実行できるアクションのタイプです。

• ポストバックアクション
• メッセージアクション
• URIアクション
• 日時選択アクション
• カメラアクション
• カメラロールアクション
• 位置情報アクション
• リッチメニュー切替アクション

postback-action action-object-label-spec message-action uri-action datetime-picker-action date-and-time-format camera-action camera-roll-action location-action richmenu-switch-action

リッチメニューの構造

リッチメニューは以下のどちらかのオブジェクトで表されます。

• リッチメニューIDを含まないリッチメニューオブジェクト。リッチメニューの作成時にこのオブジェクトを使用します。
• リッチメニューIDを含むリッチメニューレスポンスオブジェクト。リッチメニューの取得時またはリッチメニューの配列の取得時にこのオブジェクトが返されます。

これらのオブジェクトは領域オブジェクトとアクションオブジェクトから構成されます。

rich-menu-object rich-menu-response-object size-object area-object bounds-object