im.v2.File.download
Получить ссылку для скачивания файла
Описание
Метод im.v2.File.download возвращает ссылку для скачивания файла из чата.
Параметры
dialogId
string
обязательный
ID диалога. Для групповых чатов — chat{chatId}, для личных — {userId}
fileId
integer
обязательный
ID файла на Диске. Можно получить из ответа метода im.v2.File.upload
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"dialogId":"chat5","fileId":138}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.v2.File.download
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"dialogId":"chat5","fileId":138,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/im.v2.File.download
try {
const response = await $b24.callMethod('im.v2.File.download', {
dialogId: 'chat5',
fileId: 138,
});
const { result } = response.getData();
console.log('result:', result);
} catch (error) {
console.error('Error:', error);
}
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.im.v2.file.download(
dialog_id="chat5",
file_id=138,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'im.v2.File.download',
[
'dialogId' => 'chat5',
'fileId' => 138,
]
);
$result = $response
->getResponseData()
->getResult();
echo 'result: ' . print_r($result, true);
} catch (Throwable $exception) {
error_log($exception->getMessage());
echo 'Error: ' . $exception->getMessage();
}
BX24.callMethod(
'im.v2.File.download',
{
dialogId: 'chat5',
fileId: 138,
},
function(result) {
if (result.error()) {
console.error(result.error().ex);
} else {
const downloadUrl = result.data().downloadUrl;
window.open(downloadUrl);
}
}
);
require_once('crest.php');
$result = CRest::call(
'im.v2.File.download',
[
'dialogId' => 'chat5',
'fileId' => 138,
]
);
if (!empty($result['error'])) {
echo 'Error: ' . $result['error_description'];
} else {
echo 'Download URL: ' . $result['result']['downloadUrl'];
}
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "im.v2.File.download", b24.Params{
"dialogId": "chat5",
"fileId": 138,
})
if err != nil {
return fmt.Errorf("im.v2.File.download: %w", err)
}
var item struct {
DownloadUrl string `json:"downloadUrl"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.DownloadUrl)
Ответ
HTTP-статус: 200
{
"result": {
"downloadUrl": "https://**put_your_bitrix24_address**/rest/download.json?token=im%7CaW..."
},
"time": {
"start": 1728626400.123,
"finish": 1728626400.234,
"duration": 0.111,
"processing": 0.045,
"date_start": "2024-10-11T10:00:00+03:00",
"date_finish": "2024-10-11T10:00:00+03:00"
}
}
Возвращаемые данные
result
object
Результат операции
result.downloadUrl
string
Одноразовая ссылка для скачивания файла. Ссылка содержит авторизационный токен, повторное использование не гарантируется
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": "FILE_NOT_FOUND",
"error_description": "File not found"
}
| Код | Описание | Значение |
|---|---|---|
FILE_NOT_FOUND |
File not found | Файл с таким идентификатором не найден |
ACCESS_DENIED |
Access denied | Нет доступа к чату |

