概要
LINE系ツールでは、種類が LINEのみ(line)またはメール・LINE併用(mail_line)の配信アカウントに紐づく LINE友だち・1対1チャット(管理画面の「LINE チャット」)・LINEテンプレート(テンプレートグループを含む)・LINEリッチメニュー(リッチメニューグループを含む。リッチメニュー自体の作成・編集は管理画面で行います)・LINE自動応答(自動応答グループを含む)・LINEカスタム送信者を操作できます。各ツールの account_id には配信アカウントIDを指定します(message_account_list で取得)。
LINEメッセージ本文(line.messages)の書き方は 配信ツール の message_create と、参照ツール の message_types_line を参照してください。
LINE友だち
message_line_friend_list
LINE友だち一覧を取得します。LINE登録名・ブロック状態・配信除外・未読有無・ラベル等で絞り込みできます。ソートはcreated_at(登録順)または last_acted_at(最終アクション順)で、いずれも降順固定です。種類が line / mail_line 以外のアカウントではエラー(not_found)になります。未読メッセージを既読にするには message_line_chat_message_mark_as_read を使います。
パラメータ:
指示例:
- 「このアカウントのLINE友だち一覧を見せて」
- 「未読のある友だちだけ表示して」
- 「“田中”を含むLINE登録名の友だちを検索して」
message_line_friend_get
LINE友だちの詳細を取得します。共通読者ID・対応ステータス・ラベル・共通読者の読者項目(common_fields)・メモ・登録経路名等を含みます。
パラメータ:
指示例:
- 「この友だちの詳細を見せて」
- 「この友だちに付いているラベルを確認して」
message_line_friend_update
LINE友だちの属性を部分更新します。指定したフィールドのみ変更され、省略したフィールドは既存値を維持します。is_blocked はLINEプラットフォーム側の状態のため更新できません(含めても無視されます)。
パラメータ:
指示例:
- 「この友だちをテスト対象にして」
- 「この友だちを配信除外に設定して」
message_line_friend_menu_update
LINE友だちに紐づくリッチメニューを切り替えます。指定するリッチメニューIDはmessage_line_richmenu_list で取得します。rich_menu_id に null を指定すると解除(unlink)します。キーを省略した場合は更新しません。LINE APIの呼び出しに失敗した場合はエラー(external_service_error)になり、DBは更新されません。
パラメータ:
指示例:
- 「この友だちのリッチメニューをAに切り替えて」
- 「この友だちのリッチメニューを解除して」
message_line_friend_reader_create
LINE友だちを指定シナリオの読者として登録します。allow_duplicates=false(デフォルト)の場合、配信解除されていない同一の友だち×シナリオの読者が既に存在するとエラー(conflict)を返します。
読者作成はバーストが発生しやすいため、このエンドポイントは分間レート制限の対象外です。代わりに時間単位・月間単位・累計の作成上限で制御されます。
指示例:
- 「この友だちを”無料講座”シナリオに登録して」
LINE 1対1チャット
message_line_chat_message_send
LINE友だちに1対1チャットでメッセージを送信します。type で送信種別を指定し、種別ごとに必要なフィールドが異なります。ブロック済み(is_blocked=true)の友だちには送信できません(エラー friend_blocked)。配信除外(is_exclusion=true)の友だちには送信できます。
type=text の本文に、配信済みのメッセージから取得したURL(置換URL)や rid パラメータ付きのURLを含めることはできません(エラー validation_error)。元のURLを指定してください。type=image / video / audio のURLは取り込まれず、指定したURLがそのまま使われます。
type別の必須フィールド:
パラメータ:
指示例:
- 「この友だちに”ありがとうございます”とメッセージを送って」
- 「この友だちにテンプレートを送信して」
message_line_chat_message_list
LINE友だちとの送受信メッセージ履歴を取得します(送信日時の降順)。direction で送信・受信を絞り込めます。
送信メッセージは配信APIの line.messages[] と同じフィールド・構造で返ります(seq とボタン動作の action_details は含みません)。受信メッセージのうち text / image / audio / file / video / template / location / sticker には is_read(管理側で既読にしたか。false が未読)が付きます。送信メッセージと follow / unfollow / postback / richmenutap には付きません。友だち側がメッセージを読んだかどうかではありません。既読にするには message_line_chat_message_mark_as_read を使います。
パラメータ:
指示例:
- 「この友だちとのやり取りを見せて」
- 「この友だちからの受信メッセージだけ表示して」
message_line_chat_message_mark_as_read
LINE友だちとの1対1チャットの未読メッセージを全て既読にします(LINE チャット画面の「全て既読にする」と同じ操作)。送信・受信、メッセージタイプを問わず未読の履歴が全て既読になり、message_line_friend_list の has_unread=true の絞り込みから外れ、message_line_chat_message_list の受信メッセージの is_read も true になります。既に全て既読の友だちに実行しても成功を返し、ブロック中・配信除外の友だちにも実行できます。結果の unread_count は既読化後の未読受信メッセージ数です(通常は0)。
パラメータ:
指示例:
- 「この友だちのチャットを全て既読にして」
- 「この友だちの未読を消して」
LINEテンプレート
message_line_template_list
LINEテンプレート一覧を取得します。message_line_chat_message_send の template_id や配信アクションの template(line_template_id)など、テンプレートIDを指定する操作のIDの取得元です。template_group_id・name で絞り込みできます。並び順は管理画面の一覧と同じで、未分類が先頭、次にテンプレートグループの表示順、グループの中はテンプレートの表示順です(グループの表示順が同じときはグループIDの昇順)。
メッセージ内容・URL設定は message_line_template_get で取得します。作成・更新・削除・並び替えは message_line_template_create / message_line_template_update / message_line_template_delete / message_line_template_reorder、テンプレートグループは message_line_template_group_list 等で操作します。応答の updated_at は、管理名称・テンプレートグループ・URL置換ドメインを更新したとき、またはAPIでメッセージ・URL設定を更新したときに進みます(管理画面でメッセージ本文だけを変えて保存した場合は進みません)。種類が line / mail_line 以外のアカウントでは空の一覧を返します。
パラメータ:
指示例:
- 「使えるLINEテンプレートの一覧を見せて」
- 「“キャンペーン”グループのLINEテンプレートを探して」
message_line_template_create
LINEテンプレートを作成します。テンプレートは最大5件のLINEメッセージのセットで、1対1チャット送信(message_line_chat_message_send の type=button)・配信アクション・LINE自動応答(action_type=template)・ボタン/カルーセルのボタン(type=template)から送信できます。line.messages の各要素は message_create の line と同じ形式・同じ制約で(タイプ別の項目は message_types_line を参照)、テンプレートには下書きが無いため、message_create の下書き(status=draft)のように項目を省略できず、message_types_line で required の項目は必須です。作成したテンプレートは所属グループ内(未分類なら未分類内)の末尾に並びます。種類が line / mail_line 以外のアカウントではエラー(validation_error)になります。
パラメータ:
主な制約:
- ボタン(
type=message/nothing)とurl_actions[]のaction_detailsで、押下時・クリック時に実行するアクションをテンプレートの中で直接作成できます(管理画面の「新規にアクションを追加」と同じ。アクション一覧には出ません。形式・制約はmessage_createのaction_detailsと同じ)。作成では同じ箇所のaction_idと同時に指定できません - ボタン内の
line_template_id/action_id/add_label_id/del_label_idとurl_actions[].action_idは同じアカウントに存在するIDのみ(存在しないIDは validation_error) image/imagemapの画像は取り込まれ、応答のoriginal_content_urlは取り込み後のURLになります。取り込みに失敗した場合は validation_error で何も保存されません- 本文・ボタンのURL・応答テキストに配信済みメッセージの置換URL・
rid付きURLを含む場合は validation_error url_actions[]:{url, action_id?, action_details?, expiration_type: none/scheduled/scheduled_addition/datetime, expiration_day(0〜365), expiration_hour(0〜23), expiration_min(0〜59), expiration_date(YYYY-MM-DD), expiration_redirect_url}。urlは重複不可。scheduledは送信からN日後のH時M分(day・hour 必須)、scheduled_additionは送信からN日H時間M分後(いずれか1つ以上)、datetimeは指定した日時(date・hour 必須)
- 「“初回案内”というLINEテンプレートを作って、1件目にテキスト、2件目に画像を入れて」
- 「このメッセージ内容でテンプレートを作成して、グループ”キャンペーン”に入れて」
message_line_template_get
LINEテンプレートの詳細(メッセージ内容・URL設定)を取得します。結果のline / url_actions は message_line_template_update にそのまま送り返せる形式です。ボタンと url_actions[] の action_details は、テンプレートの中で直接作成したアクションが設定されているときだけ動作の配列になり、アクション一覧のアクションを参照しているとき・未設定のときは null です(配列のときの action_id はその設定箇所専用で、message_action_get では取得できません)。
パラメータ:
指示例:
- 「このテンプレートの内容を見せて」
- 「このテンプレートのURL設定を確認して」
message_line_template_update
LINEテンプレートを部分更新します。指定したフィールドのみ変更され、省略したフィールドは既存値を維持します。line.messages を指定すると全件置換、line.sender_id のみの指定も可能です(既存のメッセージを維持して送信者だけ変更。null でデフォルト)。url_actions は指定時に全件置換(空配列でクリア)、template_group_id は null で未分類に変更します。空のボディは何も変更せず現在値を返します。message_line_template_get の結果をそのまま送り返しても内容は変わりません(更新前と同じ送信者・参照先は再検証せずに維持し、更新前と同じ画像URL(本APIまたは管理画面で取り込んだもの)は再取り込みしません)。新しく指定する項目の制約は message_line_template_create と同じです。種類が line / mail_line 以外のアカウントではエラー(validation_error)になります。
パラメータ:
注意事項:
- ボタン・
url_actions[]のaction_detailsの指定方法はmessage_updateと同じです。既存のボタンの動作を書き換えるときは取得結果のaction_idを付けたままaction_detailsを指定し(省略すると新しく作成)、url_actions[]のaction_idは省略するか取得結果の同じurlの値のままにします - 画像の取り込みに失敗した場合は validation_error で何も変更されません
- 「このテンプレートの管理名称を”再案内”に変えて」
- 「このテンプレートの1件目のテキストを差し替えて」
- 「このテンプレートを”キャンペーン”グループに移して」
message_line_template_delete
LINEテンプレートを削除します。自動応答・配信アクションからの参照は残りますが、削除済みのテンプレートは送信されません。種類がline / mail_line 以外のアカウントではエラー(validation_error)になります。
パラメータ:
指示例:
- 「このテンプレートを削除して」
message_line_template_reorder
LINEテンプレートの表示順を変更します(LINE テンプレート画面の「表示順変更」と同じ操作)。グループの表示順・テンプレートの所属グループ・グループ内の表示順を一括で更新します。groups には未分類(template_group_id: null)の要素を先頭に1つ置き、全テンプレートグループと削除済みを除く全テンプレートを過不足なく指定します(過不足・重複・未分類が先頭以外はエラー validation_error)。所属グループだけを変えたい場合は message_line_template_update の template_group_id でも変更できます。
パラメータ:
指示例:
- 「テンプレート”初回案内”を一番上に移動して」
- 「“キャンペーン”グループを未分類の次に並べて」
message_line_template_group_list
LINEテンプレートのグループ(LINE テンプレート画面の「グループ管理」)の一覧を表示順で全件取得します。グループはテンプレートの分類用で、グループ名と表示順を持ちます。未分類はグループとして存在しないため含まれません(未分類のテンプレートはtemplate_group_id が null)。種類が line / mail_line 以外のアカウントでは空配列を返します。
パラメータ:
指示例:
- 「LINEテンプレートのグループ一覧を見せて」
message_line_template_group_create
LINEテンプレートのグループを作成します。作成したグループは一覧の末尾に追加されます。テンプレートの所属はmessage_line_template_create / message_line_template_update の template_group_id、または message_line_template_reorder で設定します。種類が line / mail_line 以外のアカウントではエラー(validation_error)になります。
パラメータ:
指示例:
- 「“キャンペーン”というテンプレートグループを作って」
message_line_template_group_get
LINEテンプレートのグループの詳細(グループ名・表示順)を取得します。 パラメータ:
指示例:
- 「このテンプレートグループの詳細を見せて」
message_line_template_group_update
LINEテンプレートのグループ名を変更します。管理画面のグループ管理と同じく、グループ名はnull でも保存できます。種類が line / mail_line 以外のアカウントではエラー(validation_error)になります。
パラメータ:
指示例:
- 「このテンプレートグループの名前を”季節キャンペーン”に変えて」
message_line_template_group_delete
LINEテンプレートのグループを削除します。削除されていないテンプレートが1件でも所属している場合はエラー(conflict)になるため、先にmessage_line_template_update / message_line_template_reorder で所属を外してください。種類が line / mail_line 以外のアカウントではエラー(validation_error)になります。
パラメータ:
指示例:
- 「このテンプレートグループを削除して」
LINEリッチメニュー
message_line_richmenu_list
LINEリッチメニューの一覧を取得します。アーカイブ済みも含めて返し(is_archived で判別)、並びはアーカイブ済みでないものが先、次に表示順です。message_line_friend_menu_update の rich_menu_id や配信アクションのリッチメニュー切替で指定するIDの取得元です。rich_menu_group_id で所属グループを絞り込めます(存在しないIDは0件)。リッチメニューの作成・編集はAPIの対象外です(管理画面で行います)。
パラメータ:
指示例:
- 「このアカウントのリッチメニュー一覧を見せて」
- 「“会員向け”グループのリッチメニューだけ表示して」
message_line_richmenu_group_list
LINEリッチメニューのグループ(LINE リッチメニュー画面の「グループ管理」)の一覧を表示順で全件取得します。グループはリッチメニューの分類用で、グループ名と表示順を持ちます。未分類はグループとして存在しないため含まれません(未分類のリッチメニューはrich_menu_group_id が null)。
パラメータ:
指示例:
- 「リッチメニューのグループ一覧を見せて」
message_line_richmenu_group_create
LINEリッチメニューのグループを作成します。作成したグループは一覧の末尾に追加されます。リッチメニューの所属は管理画面(リッチメニューの登録・編集、表示順変更)で設定します。 パラメータ:
指示例:
- 「“会員向け”というリッチメニューグループを作って」
message_line_richmenu_group_get
LINEリッチメニューのグループの詳細(グループ名・表示順)を取得します。 パラメータ:
指示例:
- 「このリッチメニューグループの詳細を見せて」
message_line_richmenu_group_update
LINEリッチメニューのグループ名を変更します。name を指定する場合は空にできません(validation_error)。
パラメータ:
指示例:
- 「このリッチメニューグループの名前を”新規向け”に変えて」
message_line_richmenu_group_delete
LINEリッチメニューのグループを削除します。リッチメニュー(アーカイブ済みを含む)が1件でも所属している場合はエラー(conflict)になるため、管理画面で所属を外してから削除してください。 パラメータ:
指示例:
- 「このリッチメニューグループを削除して」
LINE自動応答
message_line_autoreply_list
LINE自動応答の一覧を表示順で取得します。自動応答はLINE友だちからテキストメッセージを受信したときの応答設定で、一覧の表示順にキーワード応答(response_type=keyword)を評価して最初に一致した1件だけを実行し、どのキーワードにも一致しない場合は一律応答(response_type=all_messages)のうち表示順で最初の1件を実行します。表示順の変更はAPIの対象外です(管理画面の「表示順変更」で行います)。種類が line / mail_line 以外のアカウントでは空配列を返します。
パラメータ:
指示例:
- 「このアカウントのLINE自動応答一覧を見せて」
- 「“資料”という管理名称の自動応答を探して」
message_line_autoreply_create
LINE自動応答を作成します。response_type=keyword(キーワード応答)のとき keyword_type と keywords が必須で、action_type に応じて message(メッセージを送信)/ action_id(アクションを実行)/ line_template_id(テンプレートを送信)のうち対応するものが必須です。作成した自動応答は一覧の末尾(最も低い優先度)に追加されます。種類が line / mail_line 以外のアカウントではエラー(validation_error)になります。
パラメータ:
指示例:
- 「“資料”という言葉を含むメッセージが来たら資料のURLを返す自動応答を作って」
- 「どのキーワードにも当てはまらないメッセージには”担当者が確認します”と返す一律応答を作って」
message_line_autoreply_get
LINE自動応答の詳細を取得します。結果ではresponse_type / action_type に対応する項目のみ値が入り、対応しない項目は null です(一律応答では keyword_type / keywords が null、など)。action_id は管理画面の自動応答編集内で直接作成したアクションを指す場合があり、その場合は message_action_list / message_action_get では取得できません(更新時にそのまま送り返せば参照は維持されます)。line_template_id は削除済みのテンプレートを指す場合があり、その場合は message_line_template_list に現れず、削除されている間は何も送信されません。
パラメータ:
指示例:
- 「この自動応答の設定を見せて」
- 「この自動応答のキーワードを確認して」
message_line_autoreply_update
LINE自動応答を部分更新します。省略したフィールドは既存値を維持します。keyword_type / keywords / message / action_id / line_template_id は null を指定しても既存値を維持し(取得結果の送り返し用。keywords はキーワード応答のまま更新する場合に限り空配列も既存維持)、autoreply_group_id のみ null で未分類に変更します。response_type / action_type を変更する場合は、変更後に使う設定(キーワード応答へ変更なら keywords、動作の変更なら message / action_id / line_template_id のうち対応するもの)の指定が必須です。message_line_autoreply_get の結果をそのまま送り返しても設定は変わりません(例外: 管理画面で登録した5,000文字超の message を含む場合は validation_error になるため、message を省略して更新します)。種類が line / mail_line 以外のアカウントではエラー(validation_error)になります。
パラメータ:
指示例:
- 「この自動応答のキーワードに”パンフレット”を追加して」
- 「この自動応答の動作をテンプレート送信に変えて、テンプレート”資料案内”を送るようにして」
message_line_autoreply_delete
LINE自動応答を削除します。種類がline / mail_line 以外のアカウントではエラー(validation_error)になります。
パラメータ:
指示例:
- 「この自動応答を削除して」
message_line_autoreply_group_list
LINE自動応答のグループ(LINE 自動応答画面の「グループ管理」)の一覧を表示順で全件取得します。message_line_autoreply_create / message_line_autoreply_update の autoreply_group_id や message_line_autoreply_list の絞り込みに使います。グループの作成・変更・削除はAPIの対象外です(管理画面で行います)。未分類はグループとして存在しないため含まれません。種類が line / mail_line 以外のアカウントでは空配列を返します。
パラメータ:
指示例:
- 「自動応答のグループ一覧を見せて」
LINEカスタム送信者
message_line_sender_list
LINEカスタム送信者の一覧を取得します。名前で部分一致検索できます。 パラメータ:
指示例:
- 「このアカウントのLINE送信者一覧を見せて」
message_line_sender_create
LINEカスタム送信者を作成します。icon_url はHTTPS必須かつPNG形式(拡張子 .png)のみ受け付けます。
パラメータ:
指示例:
- 「“サポート窓口”というLINE送信者を作成して」
message_line_sender_get
LINEカスタム送信者の詳細を取得します。 パラメータ:
指示例:
- 「このLINE送信者の詳細を見せて」
message_line_sender_update
LINEカスタム送信者を部分更新します。指定したフィールドのみ変更され、省略したフィールドは既存値を維持します。icon_url はHTTPS必須かつPNG形式(拡張子 .png)のみ受け付けます。種類が line / mail_line 以外のアカウントではエラー(validation_error)になります。
パラメータ:
指示例:
- 「このLINE送信者の名前を変更して」
- 「このLINE送信者のアイコンを差し替えて」
message_line_sender_delete
LINEカスタム送信者を削除します。種類がline / mail_line 以外のアカウントではエラー(validation_error)になります。
パラメータ:
指示例:
- 「このLINE送信者を削除して」