メッセージ送信(Carousel)

    複数のカラムオブジェクトをスクロールして閲覧できるカルーセルメッセージを送信します。

    カルーセルは多言語に対応しており、メンバーの言語設定に合わせて表示を切り替えることができます。

    カルーセルの構造は下記の通りです。

    参考

    • すべてのカラムに対して Action 数は同一に設定してください。
    • 画像またはタイトルを設定する場合、すべてのカラムで一律に設定してください。

    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

    common

    パラメータ タイプ 必須 説明
    type string Y "carousel"
    imageAspectRatio string N 画像の比率。すべてのカラムに適用。
    ● "rectangle": 1.51:1(既定値)
    ● "square": 1:1
    imageSize string N 画像のサイズ。すべてのカラムに適用。
    ● "cover": 画像領域全体に画像を表示。画像領域に収まらない部分は切り詰められる。
    ● "contain": 画像領域に画像全体を表示。縦長の画像では左右に、横長の画像では上下に余白を表示。
    columns array Y カルーセルのオブジェクトリスト
    最大:10 個
    columns[].thumbnailImageUrl string N 画像 URL(PNG 形式、HTTPS のみ)
    thumbnailImageUrl、thumbnailImageResourceId のいずれか一方を選択。
    最大サイズ:1MB
    最大 1,000 文字
    columns[].thumbnailImageResourceId string N 画像のリソース ID
    thumbnailImageUrl、thumbnailImageResourceId のいずれか一方を選択。
    最大サイズ:1MB
    columns[].title string N タイトル
    最大 40 文字
    columns[].text string Y テキスト
    - 画像とタイトルがない場合、最長:4 行、120 文字
    - 画像またはタイトルがある場合、最長:2 行、60 文字
    columns[].defaultAction Action Object N image、title、text エリアを押した時の動作
    columns[].actions array<Action Object> Y Actionが定義されたボタン
    最大:3 個

    参考

    • カルーセル本文の最大文字数を超過していない場合であっても、最大行数を超過した場合には超過分の文字列が表示されません。
    • そのため、デバイスの画面サイズ、文字タイプ等によってカルーセル本文に表示される文字数が減少することがあります。

    multi language

    パラメータ タイプ 必須 説明
    columns[].i18nThumbnailImageUrls[] array N 多言語の画像 URL リスト
    columns[].i18nThumbnailImageUrls[].language string Y 言語コード
    ●ja_JP
    ●ko_KR
    ●zh_CN
    ●zh_TW
    ●en_US
    columns[].i18nThumbnailImageUrls[].thumbnailImageUrl string Y 画像 URL(PNG形式、HTTPSのみ)
    最大サイズ:1MB
    最大 1,000 文字
    columns[].i18nThumbnailImageResourceIds[] array N 多言語の画像のリソース ID リスト
    columns[].i18nThumbnailImageResourceIds[].language string Y 言語コード
    ●ja_JP
    ●ko_KR
    ●zh_CN
    ●zh_TW
    ●en_US
    columns[].i18nThumbnailImageResourceIds[].thumbnailImageResourceId string Y 画像のリソース ID
    最大サイズ:1MB

    Request Example

    simple

    
    {
      "accountId": "admin@example.com",
      "content": {
        "type": "carousel",
        "columns": [{
          "thumbnailImageUrl": "https://~~~",
          "title": "Works Mobile",
          "text": "Press the button to visit",
          "defaultAction": {
            "type":"uri",
            "uri":"https://www.naver.com"
          },
          "actions": [{
            "type":"uri",
            "label":"Visit",
            "uri":"https://www.naver.com"
          }]
        }, {
          "thumbnailImageUrl": "https://~~~.png",
          "title": "LINE WORKS",
          "text": "New way of working",
          "defaultAction": {
            "type":"uri",
            "uri":"https://www.naver.com"
          },
          "actions": [{
            "type":"uri",
            "label":"Talk",
            "uri":"https://www.naver.com"
          }]
        }]
      }
    }
    

    Response

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

    Error Code

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