メッセージ送信 (image)

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

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

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

    参考

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

    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 "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

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

    ResourceID

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

    Response

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

    Error Code

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