> ## 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.

# LINEテンプレート詳細取得

> LINEテンプレートの詳細（メッセージ内容・URL設定）を取得します。応答の `line` / `url_actions` はテンプレート更新APIにそのまま送り返せる形式です。

ボタンの `action_details` と `url_actions[].action_details` は、テンプレートの中で直接作成したアクション（管理画面の「新規にアクションを追加」、または作成・更新APIの `action_details`）が設定されているときだけ動作の配列になり、アクション一覧のアクションを参照しているとき・未設定のときは `null` です。配列のときの `action_id` はその設定箇所専用で、アクション取得APIでは取得できず、他のテンプレートや他のURLには指定できません。


`GET`

```
https://api.utage-system.com/v1/accounts/{account_id}/line/templates/{template_id}
```


## OpenAPI

````yaml GET /accounts/{account_id}/line/templates/{template_id}
openapi: 3.0.3
info:
  title: UTAGE API
  description: >
    UTAGEのパブリックAPIです。ファネル、メール・LINE配信、会員サイト、イベント・予約、決済、メディアなどのリソースをプログラムから操作できます。


    ## 認証

    すべてのリクエストにAPIキーによるBearer認証が必要です（要素タイプ・LINEメッセージタイプ・配信条件タイプの参照エンドポイントを除く）。


    ```

    Authorization: Bearer {api_key}

    ```


    APIキーはUTAGE管理画面から発行できます。APIキーが未指定・無効・無効化済みの場合、またはアカウントが利用停止中の場合は `401
    Unauthorized`（`error.code` は `unauthorized`）が返されます。


    ## レート制限

    リクエスト数には以下の制限があります。表の値は既定値で、契約内容により異なる場合があります。


    | 分間上限 | 日間上限 |

    |----------|----------|

    | 60リクエスト/分（APIキー単位・暦の1分ごと） | 10,000リクエスト/日（アカウント単位・暦日ごと） |


    レスポンスヘッダーで分間上限の窓が終わる時刻を確認できます（分間の残数と日間の残数はヘッダーに含まれません）。


    | ヘッダー | 説明 |

    |----------|------|

    | X-RateLimit-Limit | 接続元IP単位でAPI全体に掛かる制限の上限値（APIキー単位の分間上限ではありません） |

    | X-RateLimit-Remaining | 接続元IP単位の制限の残りリクエスト数（分間上限の残数ではありません） |

    | X-RateLimit-Reset | APIキー単位の分間上限で、現在の1分間の窓が終わる（次の分が始まる）UNIXタイムスタンプ |


    上限を超えた場合は `429 Too Many Requests`（`error.code` は
    `rate_limit_exceeded`）が返されます。日間上限の超過時は `X-RateLimit-Reset`
    が翌日0:00になります（`X-RateLimit-Limit` / `X-RateLimit-Remaining`
    は超過時も接続元IP単位の値です）。認証不要のエンドポイントと読者作成（`POST
    /accounts/{account_id}/scenarios/{scenario_id}/readers`、`POST
    /accounts/{account_id}/line/friends/{friend_id}/readers`）はレート制限の対象外で、`X-RateLimit-Reset`
    ヘッダーは付きません。


    データを作成するAPIには、これとは別にAPI経由の作成件数の上限があります。超過時は `429` で `total_limit_exceeded` /
    `hourly_limit_exceeded` / `monthly_limit_exceeded`
    が返され、`details.resource_type` に対象のリソース種別が含まれます。


    ## エラーレスポンス

    エラー時は以下の形式で返されます。


    ```json

    {
      "error": {
        "code": "error_code",
        "message": "エラーメッセージ"
      }
    }

    ```


    エラーの種類によっては `error.details`
    に補足情報（バリデーションの項目別エラー、`retry_after`、`resource_type` など）が含まれます。
  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: ラベル・共通読者・アクション・登録経路の操作
  - name: 登録経路
    description: ファネルの登録経路・登録経路グループの作成・取得・更新・削除
  - name: ファネルアクション
    description: ファネルアクション（管理画面「アクション設定」）の作成・取得・更新・削除とアクショングループの一覧取得
  - name: 登録フォーム・読者項目
    description: 読者項目と登録フォーム項目の作成・更新・取得・削除・並び替え
  - name: 連携
    description: Googleスプレッドシート連携アカウント・広告連携設定の一覧取得
  - name: 会員サイト
    description: 会員サイトの一覧取得・作成・取得・更新・削除・並び替え
  - name: コース
    description: 会員サイト配下のコースの一覧取得・作成・取得・更新・削除・並び替え
  - name: コースグループ
    description: コースグループの一覧取得・作成・取得・更新・削除
  - name: バンドル
    description: バンドル（受講生に開放するコース・コミュニティグループのセット）の一覧取得・作成・取得・更新・削除・並び替え
  - name: レッスン
    description: 会員サイトのレッスン・レッスングループの操作と、レッスンごと受講状況・受講完了者の取得
  - name: 受講生
    description: 会員サイトの受講生の作成・更新・取得・削除、受講状況・操作履歴の取得、コース・バンドルの登録受講生一覧
  - name: 登録コース・コミュニティ
    description: 受講生のバンドル・単一コース・コミュニティグループへの登録の追加・更新・解除・一覧取得
  - name: コミュニティグループ
    description: 会員サイトのコミュニティグループの一覧取得
  - name: イベント
    description: イベント（セミナー・説明会、個別相談・個別予約）の一覧取得・作成・取得・更新・削除
  - name: 日程
    description: イベントの日程の一覧取得・作成・取得・更新・削除
  - name: 日程設定
    description: 個別相談・個別予約タイプのイベントの日程設定（開催する曜日・時間帯・特定日の開催設定・担当者・日程の表示期間）の取得・更新
  - name: 申込フォーム・申込者項目
    description: イベントの申込フォームの基本項目・申込者項目の取得・更新
  - name: 申込者
    description: イベントの申込者の一覧取得・詳細取得・更新
  - name: イベントグループ
    description: イベントグループ（イベント一覧の「グループ管理」）の作成・更新・一覧取得・削除
  - name: 担当者
    description: 担当者（個別相談・個別予約の「担当者設定」）の作成・更新・一覧取得・削除と連携用リンクの発行・削除
  - name: 商品
    description: 商品の一覧取得・作成・取得・更新・削除・並び替え
  - name: 商品グループ
    description: 商品グループの一覧取得・作成・取得・更新・削除
  - name: 商品詳細
    description: 商品配下の商品詳細（価格・支払方法・決済代行会社・支払回数・購入後の動作・通知設定）の作成・更新・並び替え・取得・削除
  - name: 売上
    description: 売上の一覧・詳細取得、領収書・請求書設定の更新、銀行振込の入金反映、削除、月別・日別売上集計
paths:
  /accounts/{account_id}/line/templates/{template_id}:
    get:
      tags:
        - LINE
      summary: LINEテンプレート詳細取得
      description: >
        LINEテンプレートの詳細（メッセージ内容・URL設定）を取得します。応答の `line` / `url_actions`
        はテンプレート更新APIにそのまま送り返せる形式です。


        ボタンの `action_details` と `url_actions[].action_details`
        は、テンプレートの中で直接作成したアクション（管理画面の「新規にアクションを追加」、または作成・更新APIの
        `action_details`）が設定されているときだけ動作の配列になり、アクション一覧のアクションを参照しているとき・未設定のときは
        `null` です。配列のときの `action_id`
        はその設定箇所専用で、アクション取得APIでは取得できず、他のテンプレートや他のURLには指定できません。
      operationId: getLineTemplate
      parameters:
        - $ref: '#/components/parameters/AccountId'
        - name: template_id
          in: path
          required: true
          description: テンプレートID
          schema:
            type: string
      responses:
        '200':
          description: テンプレート詳細
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/LineTemplateDetail'
        '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
  schemas:
    LineTemplateDetail:
      type: object
      description: LINEテンプレートの詳細（作成・取得・更新で共通）
      properties:
        id:
          type: string
          description: テンプレートID
        name:
          type: string
          description: 管理名称
        template_group_id:
          type: string
          nullable: true
          description: テンプレートグループID（未分類は null）
        shorten_domain:
          type: string
          nullable: true
          description: URL置換ドメイン（デフォルトは null）
        line:
          type: object
          description: >
            LINE原稿。`messages` の各要素は配信メッセージ詳細の `line.messages[]` と同じ形式です（`seq` /
            `type` とタイプ別の項目。タイプ別の項目は LINEメッセージタイプ定義を参照）。

            ボタン（`type=message` / `nothing`）には `action_details`
            を含みます（テンプレートの中で直接作成したアクションが設定されているときは動作の配列、それ以外は null）。
          properties:
            sender_id:
              type: string
              nullable: true
              description: 送信者ID（先頭メッセージの送信者。デフォルト送信者は null。削除済みの送信者でもIDを返します）
            messages:
              type: array
              description: LINEメッセージの配列（表示順）
              items:
                type: object
        url_actions:
          type: array
          description: URL設定の配列（本文・ボタンに含まれるURLごとのクリック時のアクションとリンクの期限）
          items:
            $ref: '#/components/schemas/UrlAction'
        message_count:
          type: integer
          description: テンプレートに含まれるメッセージ数
        created_at:
          type: string
          description: 作成日時
        updated_at:
          type: string
          description: 更新日時（メッセージ・URL設定だけを更新したときも進みます）
    UrlAction:
      type: object
      description: >
        URLアクション（本文中の URL を読者が開いた際に実行するアクションと、リンクの期限設定）の1行。

        配信メッセージとLINEテンプレートで共通の形式で、作成・更新のリクエストと取得応答で同じ形式です（以下の「メッセージ」はLINEテンプレートにも当てはまります）。


        - `url` は本文中の URL と同じ文字列を指定します。同じ配列の中で重複できません。

        - リンクを開いた際に実行するアクションは、アクション管理のアクションを `action_id` で参照するか、`action_details`
        でこのメッセージ・テンプレートの中に直接作ります（両方の同時指定は `422`）。

        - 期限の種類（`expiration_type`）ごとの必須項目: `scheduled` は
        `expiration_day`・`expiration_hour`、`scheduled_addition` は
        `expiration_day` / `expiration_hour` / `expiration_min`
        のいずれか1つ以上、`datetime` は `expiration_date`・`expiration_hour`。

        - 期限の種類に関係しない項目は null で保存されます。`scheduled` / `datetime` で
        `expiration_min` を省略すると 0 になります。

        - 取得応答では、`expiration_type` が `none` 以外のときだけ `expiration_day` /
        `expiration_hour` / `expiration_min` / `expiration_date` /
        `expiration_redirect_url` が含まれます。
      required:
        - url
      properties:
        url:
          type: string
          maxLength: 2048
          description: 本文中の URL（2048文字以内。同じ配列の中で重複不可）
        action_id:
          type: string
          nullable: true
          description: |
            リンクを開いた際に実行するアクションのID（アクション管理のアクションを使う場合に指定。アクション一覧 API の `id`）。
            更新では、取得応答でこの行に現在設定されている ID もそのまま送り返せます。未設定は null。
        action_details:
          type: array
          nullable: true
          maxItems: 100
          description: >
            リンクを開いた際に実行するアクションを、このメッセージ・テンプレートの中で直接作る動作の配列（最大100件。要素の形式は配信アクションの
            `details` と同じ）。

            リクエストでは `action_id` と同時に指定できません（更新で、取得応答の同じ `url` の行の `action_id`
            を付けたまま指定した場合は、その動作を置換します）。

            `channel=action`
            のメッセージでは指定できません。取得応答では、この行の中で直接作ったアクションが設定されているときだけ配列になり、それ以外は null。
          items:
            $ref: '#/components/schemas/MessageActionDetail'
        expiration_type:
          type: string
          enum:
            - none
            - scheduled
            - scheduled_addition
            - datetime
          default: none
          description: >
            期限の種類。`none`: なし、`scheduled`: 配信から〇日後の〇時〇分、`scheduled_addition`:
            配信から〇日〇時間〇分後、`datetime`: 指定した日時。

            省略・null は `none`。
        expiration_day:
          type: integer
          minimum: 0
          maximum: 365
          nullable: true
          description: 期限の日（`scheduled` / `scheduled_addition` のとき。0〜365。`scheduled` では必須）
        expiration_hour:
          type: integer
          minimum: 0
          maximum: 23
          nullable: true
          description: 期限の時（0〜23。`scheduled` / `datetime` では必須）
        expiration_min:
          type: integer
          minimum: 0
          maximum: 59
          nullable: true
          description: 期限の分（0〜59。`scheduled` / `datetime` で省略すると 0）
        expiration_date:
          type: string
          format: date
          nullable: true
          description: 期限の日付（`datetime` のとき必須。YYYY-MM-DD の実在する日付）
        expiration_redirect_url:
          type: string
          maxLength: 2048
          nullable: true
          description: >-
            期限が切れた場合の遷移先URL（`http://` または `https://`
            で始まる2048文字以内。未指定の場合はリンクが無効であることを示すページに遷移）
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: エラーコード
            message:
              type: string
              description: エラーメッセージ
            details:
              type: object
              nullable: true
              description: >-
                エラーの補足情報（`retry_after` /
                `resource_type`、項目別のエラーメッセージ等）。エラー種別により含まれる場合があります。`422`
                の項目別エラーの値は通常はメッセージの配列ですが、会員サイト更新・コース更新の変更時だけ行う検証では文字列です。
    MessageActionDetail:
      type: object
      description: >
        アクションの動作1件。`type` で動作の種類を指定し、種類ごとに使う項目が異なります。種類に関係ない項目は無視されます。

        ID はすべて各一覧・取得 API が返す文字列の ID です。種類ごとの項目（**太字**は必須）:


        - `scenario`（シナリオ遷移）:
        **scenario_id**・**scenario_action**・scenario_registration_type・use_inheriting_partner・use_inheriting_phone

        - `scenario_another_account`（別配信アカウントのシナリオに登録・停止）:
        **account_id**・**scenario_id**・**scenario_action**・scenario_registration_type・use_inheriting_partner・use_inheriting_phone

        - `message`（LINEメッセージ送信）: **message**

        - `template`（LINEテンプレートを送信）: **line_template_id**

        - `richmenuswitch`（LINEリッチメニューを変更）: rich_menu_id

        - `label`（ラベルを変更）: add_label_id・delete_label_id（いずれか必須）

        - `label_another_account`（別配信アカウントのラベルを変更）:
        **account_id**・add_label_id・delete_label_id（いずれか必須）

        - `webhook`（webhook）: **url**・data

        - `bundle_course`（バンドルへ登録）/ `bundle_course_cancel`（バンドルを停止）:
        **bundle_course_id**

        - `subscription_cancel`（継続課金を停止）: **product_id**

        - `share_funnel`（ファネルの共有ライセンスを発行）/
        `share_funnel_cancel`（ファネルの共有ライセンスを停止）: **funnel_id**

        - `google_spreadsheet`（Googleスプレッドシートへ追記）:
        **spreadsheet_account_id**・**spreadsheet_url**・**spreadsheet_sheet_name**・**sheet**


        更新で取得応答の動作をそのまま送り返した場合、変更の無い動作は参照先の存在確認をせずに保持します。

        項目の検証エラーは 422 で、`details` のキーは `details.{動作の位置}.{項目}` です（配信メッセージ API では
        `action_details.{位置}.{項目}`）。
      required:
        - type
      properties:
        type:
          type: string
          enum:
            - webhook
            - scenario
            - scenario_another_account
            - label
            - label_another_account
            - message
            - template
            - richmenuswitch
            - share_funnel
            - share_funnel_cancel
            - bundle_course
            - bundle_course_cancel
            - subscription_cancel
            - google_spreadsheet
          example: scenario
          description: 動作の種類
        scenario_id:
          type: string
          nullable: true
          description: >-
            シナリオID（`scenario` は対象の配信アカウント、`scenario_another_account` は
            `account_id` の配信アカウントのシナリオ）
        scenario_action:
          type: string
          enum:
            - register
            - stop
          description: シナリオ動作。`register`=シナリオに登録、`stop`=シナリオを停止(配信解除)
        scenario_registration_type:
          type: string
          enum:
            - prohibit_multiple_registrations
            - allow_reregistration
            - allow_multiple_registrations
          default: prohibit_multiple_registrations
          description: >-
            重複登録。`prohibit_multiple_registrations`=禁止する(解除済みの場合でも再登録しない)、`allow_reregistration`=禁止する(解除済みの場合は再登録する)、`allow_multiple_registrations`=許可する。省略時は
            `prohibit_multiple_registrations`
        use_inheriting_partner:
          type: boolean
          default: false
          description: 紹介パートナー情報を引き継ぐか
        use_inheriting_phone:
          type: boolean
          default: false
          description: 電話番号を引き継ぐか
        account_id:
          type: string
          nullable: true
          description: 別の配信アカウントのID（同じ利用者の配信アカウント。対象の配信アカウント自身は指定できません）
        add_label_id:
          type: string
          nullable: true
          description: >-
            付けるラベルのID（`label` は対象の配信アカウント、`label_another_account` は `account_id`
            の配信アカウントのラベル）
        delete_label_id:
          type: string
          nullable: true
          description: 外すラベルのID
        message:
          type: string
          nullable: true
          description: LINEで送信するメッセージ本文。配信済みメッセージから取得した置換URLや `rid` パラメータ付きのURLは指定できません
        line_template_id:
          type: string
          nullable: true
          description: LINEテンプレートのID
        rich_menu_id:
          type: string
          nullable: true
          description: LINEリッチメニューのID。null のときはデフォルトメニューに変更します
        url:
          type: string
          maxLength: 1024
          description: webhook の送信先URL（`https://` で始まる1024文字以内。置き換え文字を含められます）
        data:
          type: array
          maxItems: 100
          description: webhook で送信するパラメータ（最大100件。`name`・`value` はそれぞれ必須・255文字以内）
          items:
            type: object
            properties:
              name:
                type: string
                maxLength: 255
                description: パラメータ名
              value:
                type: string
                maxLength: 255
                description: パラメータ値（置き換え文字を含められます）
        bundle_course_id:
          type: string
          nullable: true
          description: バンドルのID
        product_id:
          type: string
          nullable: true
          description: 商品ID（継続課金の商品詳細を持つ商品）
        funnel_id:
          type: string
          nullable: true
          description: >-
            ファネルID（共有元として設定しているファネル。`GET /funnels` の `share_source_only=true`
            で取得できます）
        spreadsheet_account_id:
          type: string
          nullable: true
          description: >-
            Googleアカウント（Googleスプレッドシート連携）のID（`GET /google-spreadsheet-accounts`
            で取得）
        spreadsheet_url:
          type: string
          maxLength: 255
          nullable: true
          description: >-
            スプレッドシートURL（255文字以内。`https://docs.google.com/spreadsheets/d/{スプレッドシートID}/edit`
            のようにIDの直後に `/` を含む形式）
        spreadsheet_sheet_name:
          type: string
          maxLength: 255
          nullable: true
          description: >-
            書き込み先シートのタブ名（255文字以内）。新しい動作では必須。更新で
            GoogleアカウントとスプレッドシートURLを変えない場合は省略でき、現在のシートを維持します。応答では保存しているシートのタブ名（Google
            から取得できない場合や連携が使えない環境では null）
        sheet:
          type: array
          minItems: 1
          maxItems: 100
          description: 書き込む列と値（1〜100件。`name`=列、`value`=値。各255文字以内）
          items:
            type: object
            properties:
              name:
                type: string
                maxLength: 255
                nullable: true
                description: 列
              value:
                type: string
                maxLength: 255
                nullable: true
                description: 値
  responses:
    Unauthorized:
      description: 認証エラー。APIキーが未指定・無効・無効化済み、またはアカウントが利用停止中。
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: unauthorized
              message: APIキーが無効です
    NotFound:
      description: 指定されたリソースが見つかりません（`error.code` は `not_found`。`message` は資源ごとに異なります）。
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: not_found
              message: ページが見つかりません
    RateLimitExceeded:
      description: >-
        レート制限超過（`rate_limit_exceeded`）。`X-RateLimit-Reset`
        の時刻（`details.retry_after` がある場合はその日時）以降に再試行してください。
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: rate_limit_exceeded
              message: レート制限を超過しました
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: APIキーをBearerトークンとして指定

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.