アイコン

    隣接したテキストを装飾するためのアイコンを表示するコンポーネントです。このコンポーネントは、ベースラインボックス内でのみ使用できます。

    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 "icon"
    url string N 画像のURL(PNG形式、HTTPSのみ可能)。

    最大文字数:1000文字
    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 です。
    aspectRatio string N アイコンのアスペクト比。{width}:{height} の形で指定します。
    1から100000の範囲で {width} および {height} の値を指定します。
    ただし、{height} 値は {width} 値の3倍を超えることはできません。

    デフォルト値は 1:1 です。

    ※ アイコンのflexプロパティの値は 0 に固定されます。

    Request Example

    
    {
      "type": "bubble",
      "body": {
        "type": "box",
        "layout": "vertical",
        "contents": [
          {
            "type": "box",
            "layout": "baseline",
            "contents": [
              {
                "type": "icon",
                "url": "https://i.ibb.co/Gv6ys3z/icon.png",
                "size": "md"
              },
              {
                "type": "text",
                "text": "How may I help you?",
                "size": "md",
                "margin": "sm"
              }
            ]
          },
          {
            "type": "box",
            "layout": "baseline",
            "contents": [
              {
                "type": "icon",
                "url": "https://i.ibb.co/Gv6ys3z/icon.png",
                "size": "lg"
              },
              {
                "type": "text",
                "text": "How may I help you?",
                "size": "lg",
                "margin": "sm"
              }
            ]
          },
          {
            "type": "box",
            "layout": "baseline",
            "contents": [
              {
                "type": "icon",
                "url": "https://i.ibb.co/Gv6ys3z/icon.png",
                "size": "xl"
              },
              {
                "type": "text",
                "text": "How may I help you?",
                "size": "xl",
                "margin": "sm"
              }
            ]
          },
          {
            "type": "box",
            "layout": "baseline",
            "contents": [
              {
                "type": "icon",
                "url": "https://i.ibb.co/Gv6ys3z/icon.png",
                "size": "xxl"
              },
              {
                "type": "text",
                "text": "How may I help you?",
                "size": "xxl",
                "margin": "sm"
              }
            ]
          },
          {
            "type": "box",
            "layout": "baseline",
            "contents": [
              {
                "type": "icon",
                "url": "https://i.ibb.co/Gv6ys3z/icon.png",
                "size": "3xl"
              },
              {
                "type": "text",
                "text": "How may I help you?",
                "size": "3xl",
                "margin": "sm"
              }
            ]
          }
        ]
      }
    }