カルーセル

    カルーセルは、子要素として1つ以上のバブルを持つコンテナです。カルーセル内のバブルは、横にスクロールして確認できます。

    カルーセルを定義する JSON データの最大サイズは 15KB です。

    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 "carousel"
    contents string Y カルーセル内に含まれるバブル。最大数:10個

    参考

    • バブルの幅
      • 1つのカルーセルに、幅(sizeプロパティ)が異なるバブルを入れることはできません。同じカルーセル内のバブルの幅はすべて同じにしてください。
    • 吹き出しの高さ
      • 同じカルーセルに含まれるバブルの高さはすべて、最高の高さのバブルのに合わせて調整されます。ただし、ボディがないバブルの場合、サイズが変わりません。

    Request Example

    
    {
      "type": "carousel",
      "contents": [
        {
          "type": "bubble",
          "body": {
            "type": "box",
            "layout": "horizontal",
            "contents": [
              {
                "type": "text",
                "text": "The Message Bot API enables the client to interact with individual users, by using a message bot account.",
                "wrap": true
              }
            ]
          },
          "footer": {
            "type": "box",
            "layout": "horizontal",
            "contents": [
              {
                "type": "button",
                "style": "primary",
                "action": {
                  "type": "uri",
                  "label": "See more",
                  "uri": "http://worksmobile.com"
                },
                "height": "sm"
              }
            ]
          }
        },
        {
          "type": "bubble",
          "body": {
            "type": "box",
            "layout": "horizontal",
            "contents": [
              {
                "type": "text",
                "text": "Hello, World!",
                "wrap": true
              }
            ]
          },
          "footer": {
            "type": "box",
            "layout": "horizontal",
            "contents": [
              {
                "type": "button",
                "style": "primary",
                "action": {
                  "type": "uri",
                  "label": "See more",
                  "uri": "http://worksmobile.com"
                },
                "height": "sm"
              }
            ]
          }
        }
      ]
    }
    

    Response

    呼び出しに成功すると HTTP 200 コードを返します。

    Error Code

    呼び出しに失敗するとエラーコードとエラーメッセージを返します。
    エラーコードはトーク Bot REST API エラーコードを参照してください。