Download an asset

$client->assets->download(string url): AssetDownloadResponse

POST/v1/assets/download

Download a Matrix asset using its mxc:// or localmxc:// URL to the device running Beeper Desktop and return the local file URL.

ParametersExpand Collapse

url: string

Matrix content URL (mxc:// or localmxc://) for the asset to download.

ReturnsExpand Collapse

AssetDownloadResponse

?string error

Error message if the download failed.

?string srcURL

Local file URL to the downloaded asset.

Download an asset

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

$client = new Client();

$response = $client->assets->download(
  url: 'mxc://example.org/Q4x9CqGz1pB3Oa6XgJ'
);

var_dump($response);

{
  "error": "error",
  "srcURL": "srcURL"
}

Returns Examples

{
  "error": "error",
  "srcURL": "srcURL"
}