メッセージ送信 (image)

    トーク Bot を使って画像を送信します。

    画像の送信には URL 方式とリソース ID 方式があります。

    • URL 方式の場合、resourceUrl, previewUrl パラメータは共に HTTPS のみ対応しています。
    • リソース ID 方式の場合、 コンテンツアップロード で取得するリソース ID を使って画像を送信します。

    参考

    • リソース ID 方式でメッセージを送信する場合、アップロードした画像は受信側の共有ストレージを消費します。

    API の種類

    サーバー API

    Request URL

    https://apis.worksmobile.com/{API ID}/message/sendMessage/v2

    HTTP Method

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

    Request content

    パラメーター タイプ 必須 説明
    type string Y "image" で固定。
    previewUrl string N プレビュー画像の URL (PNG 形式, HTTPS のみ可能)。
    最大 1,000 文字
    (previewUrl/resourceUrl, resourceId 중 하나는 입력되어야 함)
    resourceUrl string N 元画像の URL (PNG 形式, HTTPS のみ可能)。
    最大 1,000 文字
    (previewUrl/resourceUrl, resourceId のいずれかを入力)
    resourceId string N コンテンツアップロード時に取得した ID
    (previewUrl/resourceUrl の組み合わせ,もしくは resourceId のいずれかを選択)

    Request Example - URL 方式

    {
      "botNo": 123,
      "accountId": "admin@example.com",
      "content": {
        "type": "image",
        "previewUrl": "https://www.worksmobile.com/preview.png",
        "resourceUrl": "https://www.worksmobile.com/image.png"
      }
    }
    

    Request Example – リソース ID 方式

    {
      "botNo": 123,
      "accountId": "admin@example.com",
      "content": {
        "type": "image",
        "resourceId": "WAAAQPwBexX2HnseNvvM9Zyhvp2kIRF3Ul7L7/aMVti8="
      }
    }
    

    Response

    呼び出しに成功すると送信結果を返します。

    プロパティ タイプ 説明
    code number ● 200: 成功
    ● 400 番台: クライアントリクエストエラー
    ● 500 番台: 想定外のエラー / サーバー内部エラー
    message string コードについての詳細メッセージ。

    Response Example

    {"code": 200, "message": "OK"}