> ## Documentation Index > Fetch the complete documentation index at: https://docs.utage-system.com/llms.txt > Use this file to discover all available pages before exploring further. # 配信メッセージ一覧 > **プレビュー機能。仕様は今後変更される可能性があります。** 指定シナリオ配下の配信メッセージ一覧を取得します。媒体・配信タイプ・ステータスで絞り込みできます。 `GET` ``` https://api.utage-system.com/v1/accounts/{account_id}/scenarios/{scenario_id}/messages ``` この機能はプレビュー版です。仕様が変更される場合があります。 ## OpenAPI ````yaml GET /accounts/{account_id}/scenarios/{scenario_id}/messages openapi: 3.0.3 info: title: UTAGE API description: | UTAGEのパブリックAPIです。ファネル、配信アカウント、シナリオ、メディアなどのリソースをプログラムから操作できます。 ## 認証 すべてのリクエストにAPIキーによるBearer認証が必要です（要素タイプエンドポイントを除く）。 ``` Authorization: Bearer {api_key} ``` APIキーはUTAGE管理画面から発行できます。 ## レート制限 リクエスト数には以下の制限があります。 | 分間上限 | 日間上限 | |----------|----------| | 60リクエスト/分 | 10,000リクエスト/日 | レスポンスヘッダーで現在の使用状況を確認できます。 | ヘッダー | 説明 | |----------|------| | X-RateLimit-Limit | 分間の上限値 | | X-RateLimit-Remaining | 分間の残りリクエスト数 | | X-RateLimit-Reset | 制限がリセットされるUNIXタイムスタンプ | 上限を超えた場合は `429 Too Many Requests` が返されます。 ## エラーレスポンス エラー時は以下の形式で返されます。 ```json { "error": { "code": "error_code", "message": "エラーメッセージ" } } ``` version: '1.0' contact: name: UTAGE サポート servers: - url: https://api.utage-system.com/v1 description: UTAGE API security: - BearerAuth: [] tags: - name: ファネル description: ファネルの作成・更新・一覧取得 - name: ステップ description: ファネル内のステップの作成・更新・並び替え - name: ページ description: ステップ内のページの作成・更新・取得・削除 - name: 配信アカウント description: 配信アカウントの作成・一覧取得 - name: シナリオ description: シナリオの作成・一覧取得 - name: メディア description: 動画・音声・通常メディアの一覧取得とアップロード - name: 要素タイプ description: ファネルページ・HTMLメールの要素タイプ定義、LINEメッセージタイプ・配信条件タイプの取得（認証不要） - name: ファネル統計 description: ファネルの集計データ・登録者・登録経路の取得（プレビュー） - name: 配信メッセージ description: 配信メッセージの作成・更新・テスト送信・配信統計、置き換え文字の取得（プレビュー） - name: 読者 description: 読者の作成・更新・取得、ラベル・配信履歴・開封/クリック履歴の取得（プレビュー） - name: LINE description: LINE友だち・カスタム送信者・1対1チャット・テンプレートの操作（プレビュー） - name: ラベル・共通読者・登録経路 description: ラベル・共通読者・アクション・登録経路の操作（プレビュー） paths: /accounts/{account_id}/scenarios/{scenario_id}/messages: get: tags: - 配信メッセージ summary: 配信メッセージ一覧 description: > **プレビュー機能。仕様は今後変更される可能性があります。** 指定シナリオ配下の配信メッセージ一覧を取得します。媒体・配信タイプ・ステータスで絞り込みできます。 operationId: listMessages parameters: - $ref: '#/components/parameters/AccountId' - name: scenario_id in: path required: true description: シナリオID schema: type: string - name: channel in: query description: | 媒体で絞り込み - `mail`: メール - `line`: LINE - `sms`: SMS - `action`: アクション schema: type: string enum: - mail - line - sms - action - name: type in: query description: | 配信タイプで絞り込み - `broadcast`: 一斉送信 - `step`: ステップ配信 - `reminder`: リマインダ配信 schema: type: string enum: - broadcast - step - reminder - name: status in: query description: | ステータスで絞り込み - `draft`: 下書き - `reserved`: 予約中 - `sending`: 送信中 - `completed`: 配信済 schema: type: string enum: - draft - reserved - sending - completed - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PerPage' responses: '200': description: 配信メッセージ一覧 content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/MessageSummary' meta: $ref: '#/components/schemas/PaginationMeta' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/RateLimitExceeded' components: parameters: AccountId: name: account_id in: path required: true description: アカウントID schema: type: string Page: name: page in: query description: ページ番号 schema: type: integer minimum: 1 PerPage: name: per_page in: query description: 1ページあたりの件数（既定20・最大100。超過時は100に丸められます） schema: type: integer minimum: 1 maximum: 100 default: 20 schemas: MessageSummary: type: object description: 配信メッセージ一覧の要素 properties: id: type: string description: メッセージID channel: type: string enum: - mail - line - sms - action description: '媒体（mail: メール、line: LINE、sms: SMS、action: アクション）' type: type: string enum: - broadcast - step - reminder description: '配信タイプ（broadcast: 一斉送信、step: ステップ配信、reminder: リマインダ配信）' status: type: string enum: - draft - reserved - sending - completed description: 'ステータス（draft: 下書き、reserved: 予約中、sending: 送信中、completed: 配信済）' title: type: string nullable: true description: 管理名称 mail: type: object nullable: true description: メール概要（channel=mail のとき） properties: subject: type: string description: 件名 from_name: type: string description: 送信者名 from_mail: type: string description: 送信者メールアドレス type: type: string enum: - plain_text - html description: '種類（plain_text: テキスト、html: HTML）' line: type: object nullable: true description: LINE概要（channel=line のとき） properties: messages_count: type: integer description: LINEメッセージ件数 created_at: type: string description: 作成日時 updated_at: type: string description: 更新日時 additionalProperties: true PaginationMeta: type: object properties: current_page: type: integer description: 現在のページ番号 per_page: type: integer description: 1ページあたりの件数 total: type: integer description: 全件数 ErrorResponse: type: object properties: error: type: object properties: code: type: string description: エラーコード message: type: string description: エラーメッセージ details: type: object nullable: true description: エラーの補足情報（retry_afterやフィールド別エラー等）。エラー種別により含まれる場合があります。 responses: Unauthorized: description: 認証エラー。APIキーが無効または未指定。 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: code: unauthorized message: 認証に失敗しました NotFound: description: 指定されたリソースが見つかりません。 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: code: not_found message: リソースが見つかりません RateLimitExceeded: description: レート制限超過。時間を空けて再試行してください。 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: code: rate_limit_exceeded message: リクエスト上限を超えました。しばらく時間を空けて再試行してください securitySchemes: BearerAuth: type: http scheme: bearer description: APIキーをBearerトークンとして指定 ````