VRM生成完了通知¶
概要¶
VRM生成 API をリクエストした後、VRMの生成が完了すると通知します。
Info
本機能はβ版のため、将来仕様が変更する可能性があります。
仕様¶
ペイロードの仕様¶
クエリパラメータ形式の以下のパラメータが含まれています。
パラメータ | 内容 |
---|---|
avatarId | VRM生成APIで指定したアバターID |
event | イベント名。「vrm_exported」で固定。 |
vrmUrl | VRMファイルのダウンロード先URL。有効期限は10分です。 |
timestamp | Webhook を通知した日時のUNIXタイムスタンプ |
Warning
vrmUrl
は、署名付きURLですが、URLを知っている人なら誰でもアクセスできてしまいます。自社サーバ以外に漏洩しないよう注意してください。
ペイロードのサンプル¶
avatarId=5669311184109568&vrmUrl=https%3A%2F%2Fvrm.avatarplay3d.com%2Favatarplay%2F5669311184109568%2Favatarplay-5669311184109568-20230202_141108.vrm%3FExpires%3D1675318291%26KeyName%3Dvrm%26Signature%3Dt3tPrR_41jwHvxf5UjynUkg0nSA%3D&event=vrm_exported×tamp=1675314691
ユースケース¶
自社ストレージのアバター3Dデータを更新する¶
vrmUrl
に設定されたURLからアバターVRMファイルをダウンロードし、自社ストレージに保存して3Dアバターとして利用できるようにします。着せ替え完了通知と併用することで、着せ替え完了後にアバターを更新してアバターを最新に保つことが出来ます。
最終更新日: 2023-03-07