メディア

/v1/media

メディアのアップロード、取得、削除を行うには、mediaノードを使用します。

エッジ

このノードには次のエッジが接続されています。

開始する前に

メディアメッセージが送信されると、メディアはWhatsAppサーバーに14日間保存されます。14日を過ぎてからユーザーがメディアのダウンロードをリクエストした場合、WhatsAppサーバーは、同じメディアファイルをWhatsApp Businessオンプレミスクライアントにリクエストします。メディアが削除されている場合、そのメディアを利用できないことがユーザーに通知されます。

配信と読み取りの受信通知のみに基づいてメディアがダウンロードされたと想定するのは危険です。一般的には、送信から30日経過したメディアは削除しても安全ですが、ビジネスに最適な戦略を取るようにしてください。

制約

• メディアURLにリンクするのではなく、メディアをアップロードするプロセスを使う場合は、ファイルをメディアボリュームにアップロードする必要があります。アップロードが完了したら、メディアIDを使用してメッセージを送信できます。
• アプリは、アップロードするメディアをサーバーに送信する前に加工します。mediaノードにアップロードできるメディアの最大ファイルサイズは100MBですが、下記の加工後のメディアサイズの表に示されているように、各種のメディアタイプに対して加工後の制限があります。
• メディアストレージは事業者が処理する必要があります。メディアボリュームが一杯になると、それ以降のメッセージ送信は失敗します。
• 次の操作はサポートされていません。

  • バイトストリームでメディアを送信する。
  • アニメーション化されたスタンプでメッセージを送信する。

アップロード

メディアをアップロードするには、/v1/mediaにPOSTリクエストを送信します。オンプレミスリクエストの本文にはバイナリメディアデータが含まれていなくてはなりません。Content-Typeヘッダーは、アップロードするメディアのタイプに設定する必要があります。サポートされるオプションについては、サポートされるコンテンツタイプのセクションをご覧ください。

バイナリデータをアップロードする標準的な方法は、POST HTTPリクエストによるバイナリデータの送信です。例えば、画像をアップロードする場合は、ペイロードに実際の画像バイトを指定してPOSTリクエストを発行します。または、cURLで--data-binaryを指定すると、指定されたバイナリ形式のファイルをそのまま正確に読み取って使用できます。

例

メディアをアップロードする場合。

POST /v1/media
Content-Type: image/jpeg or other appropriate media type

your-binary-media-data

cURLでメディアをアップロードする場合。

curl -X POST \
https://your-webapp-hostname:your-webapp-port/v1/media \
-H 'Authorization: Bearer your-auth-token' \ 
-H 'Content-Type: image/jpeg'  \ # or other appropriate media type
--data-binary @your-file-path

どちらの場合も、成功すると応idフィールドが返されます。この情報は、メディアを取得するとき、またはメディアメッセージをカスタマーに送信するときに必要です。

{
    "media": [
        {
            "id": "f043afd0-f0ae-4b9c-ab3d-696fb4c8cd68"
        }
    ]
}

エラーメッセージを受け取った場合は、エラーおよびステータスメッセージで詳細を確認してください。

サポートされるコンテンツタイプ

加工後のメディアサイズ

これは、圧縮と暗号化をした後のメディアファイルのサイズとして可能な最大値です。

よくある質問

docker volume inspect whatsappMedia

[
    {
        "Driver": "local",
        "Labels": {},
        "Mountpoint": "/var/lib/docker/volumes/whatsappMedia/_data",
        "Name": "whatsappMedia",
        "Options": {},
        "Scope": "local"
    }
]

ls /var/lib/docker/volumes/whatsappMedia/_data/

詳しくはこちら

• ベストプラクティス
• メッセージ
• リファレンス