配信メッセージ作成

curl --request POST \
  --url https://api.utage-system.com/v1/accounts/{account_id}/scenarios/{scenario_id}/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "draft",
  "title": "<string>",
  "use_ab_test": true,
  "send_type": "<string>",
  "send_date": "2023-12-25",
  "send_day": 123,
  "send_hour": 11,
  "send_min": 29,
  "base_date": "<string>",
  "line": {
    "sender_id": "<string>",
    "messages": [
      {}
    ]
  },
  "sms": {
    "message": "<string>"
  },
  "action_id": "<string>",
  "shorten_type": "shorten_url",
  "shorten_domain": "<string>",
  "conditions": [
    {}
  ],
  "url_actions": [
    {}
  ]
}
'

{
  "data": {
    "id": "<string>",
    "title": "<string>",
    "mail": {},
    "line": {
      "sender_id": "<string>",
      "messages": [
        {}
      ]
    },
    "sms": {},
    "url_actions": [
      {}
    ]
  },
  "warnings": [
    "<string>"
  ]
}

メッセージ

配信メッセージ作成

プレビュー機能。仕様は今後変更される可能性があります。 指定シナリオに配信メッセージを新規作成します。

channel と type は作成後に変更できません。
status を reserved（予約）にすると、配信安全制御・DKIM/SMS前提チェックが実行されます。
媒体に応じて原稿オブジェクト（mail / line / sms）を指定します。
channel=mail のメール本文には配信解除URL（%cancel% または %cancelall%）を必ず含めてください。含めない場合はバリデーションエラーになります。
channel=action の場合は原稿オブジェクト不要。status=reserved 時は action_id が必須です。

配信メッセージ作成

curl --request POST \
  --url https://api.utage-system.com/v1/accounts/{account_id}/scenarios/{scenario_id}/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "draft",
  "title": "<string>",
  "use_ab_test": true,
  "send_type": "<string>",
  "send_date": "2023-12-25",
  "send_day": 123,
  "send_hour": 11,
  "send_min": 29,
  "base_date": "<string>",
  "line": {
    "sender_id": "<string>",
    "messages": [
      {}
    ]
  },
  "sms": {
    "message": "<string>"
  },
  "action_id": "<string>",
  "shorten_type": "shorten_url",
  "shorten_domain": "<string>",
  "conditions": [
    {}
  ],
  "url_actions": [
    {}
  ]
}
'

{
  "data": {
    "id": "<string>",
    "title": "<string>",
    "mail": {},
    "line": {
      "sender_id": "<string>",
      "messages": [
        {}
      ]
    },
    "sms": {},
    "url_actions": [
      {}
    ]
  },
  "warnings": [
    "<string>"
  ]
}

POST

https://api.utage-system.com/v1/accounts/{account_id}/scenarios/{scenario_id}/messages

この機能はプレビュー版です。仕様が変更される場合があります。

Authorizations

Authorization

string

header

required

APIキーをBearerトークンとして指定

Path Parameters

account_id

string

required

アカウントID

scenario_id

string

required

シナリオID

Body

application/json

配信メッセージ作成リクエスト。type に応じて送信タイミング系フィールドを指定します。送信タイミングの詳細な指定方法は MCPツール（message_create）の説明も参照してください。

channel

enum<string>

required

媒体（作成後に変更不可）

Available options:

mail,

line,

sms,

action

type

enum<string>

required

配信タイプ（作成後に変更不可）

Available options:

broadcast,

step,

reminder

status

enum<string>

default:draft

ステータス。reserved（予約）にすると配信安全制御・DKIM/SMS前提チェックが実行されます。

Available options:

draft,

reserved

title

string

管理名称

Maximum string length: 255

use_ab_test

boolean

A/Bテスト使用

send_type

string

送信タイプ。broadcast: immediately（即時）/scheduled（日時指定）。 step: immediately / scheduled（日数指定）/scheduled_addition（追加配信）。

send_date

string<date>

送信日（broadcast用、YYYY-MM-DD）

send_day

integer

送信日数（step / reminder 用）。step: 登録からの日数（0=当日）。 reminder: 基準日からの日数（0以上）。

send_hour

integer

送信時（0-23）

Required range: 0 <= x <= 23

send_min

integer

送信分（0-59）

Required range: 0 <= x <= 59

send_timing

enum<string>

送信タイミング（reminder用）。before=基準日の前、after=基準日の後、today=基準日当日、 addition_before/addition_after=追加配信。

Available options:

before,

after,

today,

addition_before,

addition_after

base_date

string

基準日の読者項目名（reminder用）。置き換え文字一覧の reader_item から取得。

step_send_type

enum<string>

ステップ送信タイプ（step用）。none=指定日時に送信、immediately=登録直後に即時送信。

Available options:

none,

immediately

mail

object

メール原稿（channel=mail 時に必須）

Show child attributes

line

object

LINE原稿（channel=line 時に必須）

Show child attributes

sms

object

SMS原稿（channel=sms 時に必須）

Show child attributes

action_id

string

配信後に実行するアクションID（channel=action かつ status=reserved 時に必須）

shorten_type

enum<string>

default:shorten_url

URL置換方法（shorten_url: 置換URLを表示、original_url: 元のURLを表示）

Available options:

shorten_url,

original_url

shorten_domain

string

URL置換ドメイン

conditions

object[]

配信条件。グループ間はOR結合、グループ内の rules はAND結合。使用可能な key / condition / value は配信条件タイプ定義を参照してください。

url_actions

object[]

URLアクションの配列

Response

作成された配信メッセージ

data

object

配信メッセージの詳細。共通フィールドに加え、type に応じた送信タイミング系フィールド（send_type / send_date / send_day / send_hour / send_min / base_date / send_timing / step_send_type 等）と、channel に応じた原稿（mail / line / sms）、 url_actions を含みます。

Show child attributes

warnings

string[]

予約（reserved）化時に検出された警告（DKIM未設定・配信安全制御など）。警告がある場合のみ返されることがあります。

配信メッセージ一覧配信メッセージ詳細取得