テキスト

    1行の文字列を表示するコンポーネントです。文字の色、サイズ、太さを指定できます。

    送信するテキストメッセージは複数の言語で作成することができ、クライアントのデバイスの設定言語と一致する言語で表示されます。

    詳しい内容はメッセージ送信(text)の多言語パラメータを参照してください。

    API の種類

    サーバー API

    Request URL

    https://apis.worksmobile.com/r/{API ID}/message/v1/bot/{botNo}/message/push

    HTTP Method

    POST(Content-Type: application/json; charset=UTF-8)

    Request Content

    パラメータ タイプ 必須 説明
    type string Y "text"
    text string Y 表示されるテキスト。
    textプロパティやcontentsプロパティの中から必ず一つを設定してください。
    contentsプロパティを設定すると、textプロパティは無視されます。
    contents array of objects N スパンの配列。
    textプロパティやcontentsプロパティのいずれかを必ず設定してください。
    contentsプロパティを設定すると、textプロパティは無視されます。
    flex number N 親要素内における、このコンポーネントの幅または高さの比率。詳しくは、『Flexible Template ドキュメント』の「レイアウト」の「コンポーネントの幅と高さ」を参照してください。
    margin string N 親要素内での、特定のコンポーネントとその前のコンポーネントとの間に挿入される余白の最小サイズ。詳しくは、『Flexible Template ドキュメント』の「レイアウト」の「コンポーネントの margin プロパティ」を参照してください。
    position string N offsetTop, offsetBottom, offsetStart, offsetEndの基準。以下のいずれかの値を指定します。

    relative : 直前のボックスを基準とします。
    absolute : 親要素の左上を基準とします。

    デフォルト値は relative です。 詳しくは、『Flexible Template ドキュメント』の「レイアウト」の「オフセット」を参照してください。
    offsetTop string N 上側のオフセット。詳しくは、『Flexible Template ドキュメント』の「レイアウト」の「オフセット」を参照してください。
    offsetBottom string N 下側のオフセット。詳しくは、『Flexible Template ドキュメント』の「レイアウト」の「オフセット」を参照してください。
    offsetStart string N 左側のオフセット。詳しくは、『Flexible Template ドキュメント』の「レイアウト」の「オフセット」を参照してください。
    offsetEnd string N 右側のオフセット。詳しくは、『Flexible Template ドキュメント』の「レイアウト」の「オフセット」を参照してください。
    size string N 文字サイズ。
    xxsxssmmdlgxlxxl3xl4xl5xl 以下のいずれかの値を指定します。
    列挙した順に文字のサイズが大きくなります。

    デフォルト値は md です。
    align string N 水平方向の配置方式。詳しくは、『Flexible Template ドキュメント』の「レイアウト」の「水平方向の配置」を参照してください。
    gravity string N 垂直方向の配置方式。詳しくは、『Flexible Template ドキュメント』の「レイアウト」の「垂直方向の配置」を参照してください。
    wrap boolean N true を指定すると文字列を折り返します。デフォルト値は false です。
    true に設定した場合、改行文字 (\n) を使って改行できます。

    詳しくは、『Flexible Template ドキュメント』の「要素」の「テキストの折り返し」を参照してください。
    maxLines number N 最大行数。

    テキストが指定された行数に収まりきらない場合、最後の行の最後に省略記号 (...) が表示されます。
    値を 0 ではすべてのテキストが表示されます。

    デフォルト値は 0 です。
    weight string N 文字の太さ。regular または bold のいずれかの値を指定できます。
    bold を指定すると太字になります。

    デフォルト値は regular です。
    color string N 文字の色。16進数カラーコードで設定します。
    action object N テキストをタップするとアクションが実行されます。Action Objectを指定します。
    style string N テキストを表示するスタイル。以下のいずれかの値を指定します。

    normal : 標準
    italic : イタリック体

    デフォルト値は normal です。
    decoration string N テキストの装飾。以下のいずれかの値を指定します。

    none : 装飾なし
    underline : 下線
    line-through : 取り消し線

    デフォルト値は none です。

    Request Example

    
    {
      "type": "bubble",
      "body": {
        "type": "box",
        "layout": "vertical",
        "contents": [
          {
            "type": "text",
            "text": "The work site begins to move.",
            "size": "sm",
            "align": "center",
            "color": "#ff0000"
          },
          {
            "type": "text",
            "text": "The work site begins to move.",
            "size": "md",
            "align": "center",
            "color": "#00ff00"
          },
          {
            "type": "text",
            "text": "The work site begins to move.",
            "size": "lg",
            "align": "center",
            "weight": "bold",
            "color": "#0000ff"
          }
        ]
      }
    }