概要
配信系ツールでは、メール配信・LINE配信のアカウントとシナリオ(配信シーケンス)を管理できます。アカウント操作
message_account_list
配信アカウントの一覧を取得します。タイプや名前で絞り込みできます。 パラメータ:
指示例:
- 「配信アカウント一覧を見せて」
- 「LINE配信のアカウントを検索して」
- 「“メルマガ”を含むアカウントを探して」
message_account_create
配信アカウントを新規作成します。 パラメータ:
指示例:
- 「“新商品メルマガ”というメール配信アカウントを作成して」
- 「LINE配信用のアカウントを作って」
シナリオ操作
message_scenario_list
指定アカウント配下のシナリオ一覧を取得します。タイトルで部分一致検索できます。 パラメータ:
指示例:
- 「このアカウントのシナリオ一覧を見せて」
- 「“セミナー”を含むシナリオを検索して」
message_scenario_create
シナリオを新規作成します。 パラメータ:
指示例:
- 「“無料メール講座”というシナリオを作成して」
- 「新しいステップメールのシナリオを追加して」
メッセージ操作
シナリオ配下の配信メッセージ(メール・LINE・SMS・アクション)を作成・編集・削除します。メッセージ系ツール(
message_list / message_create / message_get / message_update / message_delete / message_test_send / message_stats_get / message_scenario_stats_list)はプレビュー機能です。仕様が変更される場合があります。message_list
指定シナリオ配下のメッセージ一覧を取得します。媒体・配信タイプ・ステータスで絞り込みできます。**プレビュー機能。**仕様は今後変更される可能性があります。パラメータ:
指示例:
- 「このシナリオの配信メッセージ一覧を見せて」
- 「下書きのメールだけ表示して」
message_create
メッセージを新規作成します。channel と type は作成後に変更できません。status=reserved(予約)にすると配信安全制御・DKIM/SMS前提チェックが実行されます。
**プレビュー機能。**仕様は今後変更される可能性があります。主要パラメータ:
送信タイミングパラメータ(
type 別):
原稿オブジェクトの構造:
mail:{type: "plain_text"|"html", from_name, from_mail, subject, text(plain_text時), elements(html時), preview_text(最大150文字)}。HTMLメールのelementsのプロパティ名はelement_types_mail/element_types_mail_propertiesで確認してください。line:{sender_id?, messages: [...](最大5件)}。タイプ別の詳細はmessage_types_lineを参照してください。sms:{message: "本文(最大360文字、絵文字不可)"}。
- 「明日の10時に一斉送信するメールを作成して」
- 「登録3日後に届くステップメールを下書きで作って」
message_get
メッセージの詳細情報を取得します。メール本文やHTMLメール要素構造、LINEメッセージ、URLアクションを含みます。**プレビュー機能。**仕様は今後変更される可能性があります。パラメータ:
指示例:
- 「このメッセージの内容を見せて」
- 「メールの本文を確認したい」
message_update
既存メッセージを部分更新します。指定したフィールドのみ変更され、省略したフィールドは既存値を維持します。**プレビュー機能。**仕様は今後変更される可能性があります。パラメータ:
message_create と同じフィールド群を任意で指定できます。加えて以下が必須です。
注意事項:
channel/typeは変更できません(既存と異なる値を指定すると422 validation_error)。- 空のボディは何も変更しません(200で現在値を返します)。
conditions/url_actions/line.messagesは指定すると全件置換されます(省略時は既存維持)。statusをdraft→reservedで予約実行、reserved→draftで予約解除。reserved状態で送信日時・条件・A/Bテストを変更すると配信予約が自動で再作成されます。再作成から5分間は再変更できず、429(クールダウン)が返ります。sending/completedのメッセージは更新できません(409)。
- 「このメールの件名を変更して」
- 「予約を解除して下書きに戻して」
message_delete
メッセージを論理削除します。未送信の配信予約(キュー)は削除されますが、メール原稿・配信条件・URLアクションは保持されます。送信中のメッセージは削除できません。**プレビュー機能。**仕様は今後変更される可能性があります。パラメータ:
指示例:
- 「このメッセージを削除して」
message_test_send
メッセージのテスト送信を実行します(channel=mail / line / sms のみ。channel=action は非対応)。
**プレビュー機能。**仕様は今後変更される可能性があります。
type=step / type=reminder のメッセージは、設定済みの日時指定を無視して即時テスト送信されます。本番配信のスケジュールはそのまま保持されます。
指示例:
- 「このメールを自分宛にテスト送信して」
配信統計
メッセージの送信数・開封率・クリック率・配信解除数を取得します。配信統計ツール(
message_stats_get / message_scenario_stats_list)はプレビュー機能です。仕様が変更される場合があります。message_scenario_stats_list
シナリオ内のメッセージごとの配信統計(送信数・開封数・開封率・クリック数・クリック率・解除数)を一覧で取得します。A/Bテスト(メール件名)のパターン別集計も含みます。**プレビュー機能。**仕様は今後変更される可能性があります。パラメータ:
指示例:
- 「このシナリオのメッセージ別の開封率を一覧で見せて」
- 「先月の配信成績をまとめて」
message_stats_get
指定したメッセージ単体の配信統計を取得します。date_from / date_to で期間指定できます。
**プレビュー機能。**仕様は今後変更される可能性があります。パラメータ:
指示例:
- 「このメールの開封率とクリック率を教えて」
置き換え文字
message_placeholder_list
シナリオで使用できる置き換え文字(書式は%name%)の一覧を取得します。カテゴリで絞り込みできます。
**プレビュー機能。**仕様は今後変更される可能性があります。パラメータ:
レスポンスの補足:
reader_itemの項目にはis_filterable(boolean)が付与されます。trueの項目のみmessage_reader_list/message_reader_list_allのconditions.rules[].keyとして使用できます。reader_itemの項目にはfield_group(scenario_fields|common_fields)が付与されます。common_fieldsを更新すると同一人物の全シナリオに波及します。
- 「このシナリオで使える置き換え文字を見せて」
- 「読者の名前を差し込む置き換え文字を教えて」
読者操作
読者系ツールはプレビュー機能です。仕様は今後変更される可能性があります。
message_reader_list
シナリオ別の読者一覧を取得します。conditions で配信条件と同じ構造の絞り込みができます(JSON文字列でも可)。
**プレビュー機能。**仕様は今後変更される可能性があります。パラメータ:
conditions の key 制約: 特別キー(
label / scenario / broadcast / tracking / status / base_date 等)に加え、該当シナリオの登録フォームに組み込まれた読者項目(message_placeholder_list で is_filterable=true の reader_item)のみ使用できます。base_datetime は配信条件専用で読者一覧では使用できません。各読者の読者項目は scenario_fields(シナリオ固有)/ common_fields(全シナリオ共通)の2グループで返ります。
指示例:
- 「このシナリオの読者一覧を見せて」
- 「“見込み客”ラベルが付いた読者を抽出して」
message_reader_list_all
アカウント配下の全シナリオを横断して読者一覧を取得します。conditions で絞り込みができます(JSON文字列でも可)。
**プレビュー機能。**仕様は今後変更される可能性があります。パラメータ:
conditions の key 制約: シナリオ横断のため、読者項目で使用できるキーは
name / mail のみです(特別キーは使用可)。シナリオ固有の読者項目で絞り込むには message_reader_list を使用してください。
指示例:
- 「アカウント全体の読者一覧を見せて」
- 「全シナリオから特定のメールアドレスの読者を探して」
message_reader_get
読者の詳細情報を取得します。読者項目はscenario_fields(シナリオ固有)/ common_fields(全シナリオ共通)の2グループで返り、トップレベルはシステム情報のみです。
**プレビュー機能。**仕様は今後変更される可能性があります。パラメータ:
指示例:
- 「この読者の詳細を見せて」
- 「読者の登録項目を確認したい」
message_reader_create
指定シナリオに読者を1件登録します。オプトインを取得済みのアドレスのみ登録してください。**プレビュー機能。**仕様は今後変更される可能性があります。パラメータ:
指示例:
- 「このシナリオに読者を1件登録して」
- 「メールアドレスと名前を指定して読者を追加して」
読者作成はバーストが発生するため分間レート制限(60回/分)の対象外で、独自の時間/月間上限で制御されます。
message_reader_update
読者を部分更新します。リクエストに含めたフィールドのみ変更し、省略したフィールドは既存値を維持します。**プレビュー機能。**仕様は今後変更される可能性があります。パラメータ:
指示例:
- 「この読者の名前を変更して」
- 「読者の配信基準日を更新して」
message_reader_label_list
読者に付与されているラベル一覧を取得します。**プレビュー機能。**仕様は今後変更される可能性があります。パラメータ:
指示例:
- 「この読者に付いているラベルを見せて」
message_reader_label_create
読者にラベルを1件付与します。既に付与済みの場合は付与済みの情報を返します。**プレビュー機能。**仕様は今後変更される可能性があります。パラメータ:
指示例:
- 「この読者に”購入者”ラベルを付けて」
message_reader_label_delete
読者からラベルを1件解除します。**プレビュー機能。**仕様は今後変更される可能性があります。パラメータ:
指示例:
- 「この読者から”見込み客”ラベルを外して」
message_reader_scenario_list
同じ読者が登録されている他のシナリオ一覧を取得します。**プレビュー機能。**仕様は今後変更される可能性があります。パラメータ:
指示例:
- 「この読者が登録されている他のシナリオを見せて」
message_reader_queue_list
読者の配信予約(今後送信予定のメッセージ)一覧を取得します。**プレビュー機能。**仕様は今後変更される可能性があります。パラメータ:
指示例:
- 「この読者に今後送信される予定のメッセージを見せて」
message_reader_sent_list
読者への配信済メッセージ一覧を取得します。**プレビュー機能。**仕様は今後変更される可能性があります。パラメータ:
指示例:
- 「この読者に送信済みのメッセージ履歴を見せて」
message_reader_open_list
読者のメール開封履歴を取得します。**プレビュー機能。**仕様は今後変更される可能性があります。パラメータ:
指示例:
- 「この読者のメール開封履歴を見せて」
message_reader_click_list
読者のクリック履歴を取得します。**プレビュー機能。**仕様は今後変更される可能性があります。パラメータ:
指示例:
- 「この読者がクリックしたリンクの履歴を見せて」
LINE友だち操作
message_line_friend_list
**プレビュー機能。**仕様は今後変更される可能性があります。LINE友だち一覧を取得します。LINE登録名・ブロック状態・配信除外・未読有無・ラベル等で絞り込みできます。ソートは
created_at(登録順)または last_acted_at(最終アクション順)で、いずれも降順固定です。
パラメータ:
指示例:
- 「このアカウントのLINE友だち一覧を見せて」
- 「未読のある友だちだけ表示して」
- 「“田中”を含むLINE登録名の友だちを検索して」
message_line_friend_get
**プレビュー機能。**仕様は今後変更される可能性があります。LINE友だちの詳細を取得します。共通読者ID・対応ステータス・ラベル・共通読者の読者項目(
common_fields)・メモ・登録経路名等を含みます。
パラメータ:
指示例:
- 「この友だちの詳細を見せて」
- 「この友だちに付いているラベルを確認して」
message_line_friend_update
**プレビュー機能。**仕様は今後変更される可能性があります。LINE友だちの属性を部分更新します。指定したフィールドのみ変更され、省略したフィールドは既存値を維持します。
is_blocked はLINEプラットフォーム側の状態のため更新できません(含めても無視されます)。
パラメータ:
指示例:
- 「この友だちをテスト対象にして」
- 「この友だちを配信除外に設定して」
message_line_friend_menu_update
**プレビュー機能。**仕様は今後変更される可能性があります。LINE友だちに紐づくリッチメニューを切り替えます。
rich_menu_id に null を指定すると解除(unlink)します。キーを省略した場合は更新しません。
パラメータ:
指示例:
- 「この友だちのリッチメニューをAに切り替えて」
- 「この友だちのリッチメニューを解除して」
message_line_friend_reader_create
**プレビュー機能。**仕様は今後変更される可能性があります。LINE友だちを指定シナリオの読者として登録します。
allow_duplicates=false(デフォルト)の場合、配信解除されていない同一の友だち×シナリオの読者が既に存在すると409を返します。
読者作成はバーストが発生しやすいため、このエンドポイントは分間レート制限(60回/分)の対象外です。代わりに時間単位・月間単位の作成上限で制御されます。
指示例:
- 「この友だちを”無料講座”シナリオに登録して」
LINE 1対1チャット
message_line_chat_message_send
**プレビュー機能。**仕様は今後変更される可能性があります。LINE友だちに1対1チャットでメッセージを送信します。
type で送信種別を指定し、種別ごとに必要なフィールドが異なります。ブロック済み(is_blocked=true)の友だちには送信できません。
type別の必須フィールド:
パラメータ:
指示例:
- 「この友だちに”ありがとうございます”とメッセージを送って」
- 「この友だちにテンプレートを送信して」
message_line_chat_message_list
**プレビュー機能。**仕様は今後変更される可能性があります。LINE友だちとの送受信メッセージ履歴を取得します(送信日時の降順)。
direction で送信・受信を絞り込めます。
パラメータ:
指示例:
- 「この友だちとのやり取りを見せて」
- 「この友だちからの受信メッセージだけ表示して」
LINEテンプレート
message_line_template_list
**プレビュー機能。**仕様は今後変更される可能性があります。LINEテンプレート一覧を取得します。
message_line_chat_message_send の template_id で参照できるテンプレートを返します。テンプレートの作成・編集はAPI対象外です(管理画面で行います)。
パラメータ:
指示例:
- 「使える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送信者の名前を変更して」
- 「このLINE送信者のアイコンを差し替えて」
message_line_sender_delete
**プレビュー機能。**仕様は今後変更される可能性があります。LINEカスタム送信者を削除します。 パラメータ:
指示例:
- 「このLINE送信者を削除して」
ラベル操作
message_label_list
配信アカウント配下のラベル一覧を取得します。名前で部分一致検索できます。**プレビュー機能。**仕様は今後変更される可能性があります。パラメータ:
指示例:
- 「このアカウントのラベル一覧を見せて」
- 「“見込み客”を含むラベルを検索して」
message_label_create
ラベルを新規作成します。**プレビュー機能。**仕様は今後変更される可能性があります。パラメータ:
指示例:
- 「“購入者”というラベルを作成して」
message_label_get
指定したラベルの詳細を取得します。**プレビュー機能。**仕様は今後変更される可能性があります。パラメータ:
指示例:
- 「このラベルの詳細を見せて」
message_label_update
ラベルを更新します。指定したフィールドのみ変更される部分更新です。**プレビュー機能。**仕様は今後変更される可能性があります。パラメータ:
指示例:
- 「このラベルの名前を”VIP”に変更して」
message_label_delete
ラベルを削除します。読者へのラベル付与情報は連動して削除されません。**プレビュー機能。**仕様は今後変更される可能性があります。パラメータ:
指示例:
- 「このラベルを削除して」
共通読者操作
message_common_reader_get
共通読者(同一人物としてまとめられた読者)の詳細を取得します。common_fields は全シナリオ共通の読者項目です。
**プレビュー機能。**仕様は今後変更される可能性があります。パラメータ:
指示例:
- 「この共通読者の情報を見せて」
message_common_reader_update
共通読者のメモと共通項目(common_fields)を更新します。指定したキーのみ変更される部分更新で、更新内容は同一人物が登録している全シナリオに反映されます。
**プレビュー機能。**仕様は今後変更される可能性があります。パラメータ:
指示例:
- 「この共通読者のメモを更新して」
message_common_reader_scenario_list
共通読者が登録している全シナリオの一覧を取得します。**プレビュー機能。**仕様は今後変更される可能性があります。パラメータ:
指示例:
- 「この読者が登録しているシナリオを見せて」
message_common_reader_label_list
共通読者に付与されているラベルの一覧を取得します。**プレビュー機能。**仕様は今後変更される可能性があります。パラメータ:
指示例:
- 「この読者に付いているラベルを見せて」
message_common_reader_label_create
共通読者にラベルを1件付与します。既に付与済みの場合は既存の付与情報を返します(冪等)。**プレビュー機能。**仕様は今後変更される可能性があります。パラメータ:
指示例:
- 「この読者に”購入者”ラベルを付けて」
message_common_reader_label_delete
共通読者からラベルを解除します。付与されていないラベルを指定すると404エラーになります。**プレビュー機能。**仕様は今後変更される可能性があります。パラメータ:
指示例:
- 「この読者から”見込み客”ラベルを外して」
アクション・登録経路
message_action_list
配信後に実行するアクションの一覧を取得します。ここで取得したid は配信メッセージ作成時の action_id に利用できます。
**プレビュー機能。**仕様は今後変更される可能性があります。パラメータ:
指示例:
- 「このアカウントのアクション一覧を見せて」
message_tracking_list
シナリオに紐づく登録経路の一覧を取得します。各登録経路には登録用のurl を含みます。
**プレビュー機能。**仕様は今後変更される可能性があります。パラメータ:
指示例:
- 「このシナリオの登録経路一覧を見せて」
message_tracking_stats
登録経路別のアクセス数・登録数を取得します。**プレビュー機能。**仕様は今後変更される可能性があります。パラメータ:
指示例:
- 「登録経路ごとの登録数を見せて」
- 「今月の流入経路別の実績を確認したい」