Skip to content

Latest commit

 

History

History
77 lines (58 loc) · 4.42 KB

File metadata and controls

77 lines (58 loc) · 4.42 KB

UploadFile

dev.max.ru/docs-api/methods/POST/uploads

Загружает файл на сервер MAX.

Запрос {#request}

Поля запроса {#request-parameters}

Поле Тип Обязательный Описание
type string Да Тип вложения. Допустимые значения:
image - JPG, JPEG, PNG, GIF, TIFF, BMP, HEIC
video - MP4, MOV, MKV, WEBM, MATROSKA
audio - MP3, WAV, M4A и другие
file - любые типы файлов
file_path string Да Абсолютный или относительный путь к файлу на локальном диске.
upload_url string Нет Используется только для прямой загрузки, если URL уже получен. При вызове UploadFile заполняется автоматически.

Пример запроса {#request-example}

Синхронный запрос:

response = bot.uploads.UploadFile(UploadFileReq(
    type=UploadType.IMAGE,
    file_path="./photos/cat.png"
))

Асинхронный запрос:

response = await bot.uploads.UploadFileAsync(UploadFileReq(
    type=UploadType.IMAGE,
    file_path="./photos/cat.png"
))

Ответ {#response}

Поля ответа {#response-parameters}

Поле Тип Описание
file_id integer Уникальный числовой идентификатор файла на сервере.
Возвращается для типов file, video и audio
token string Строковый токен доступа, необходимый для прикрепления файла к сообщению.
Возвращается для типов file, video и audio
photos array Словарь версий изображений. Ключ — уникальный хеш-идентификатор версии.
Возвращается для типа image

Поля объекта PhotoData {#PhotoData}

Поле Тип Описание
token string Токен загруженного изображения для отправки

Пример тела ответа {#response-example-body}

Пример ответа на загрузку изображения:

{
  "photos": {
    "3JJvlQgoPpDgwtDEnxfLhI9pXye9WNfuMYfhNsaldssWmWt+o4h5tQ==": {
      "token": "9+eyCStTAIyomEW0h0PzC3/2FMn6jnei4sbeAHAHzEAQPw5R+QRmK6fI2i8m2g385JIOot9+dE50Zpu2C8rWpdL3lqBMBwKZg1LgN6LAi+L7RMzvuMlRQBGMRVsHIM3qCYjJVz9rZ3bJC2BKsTpwGFT2zeZD65ubBd8t+paTYZFhHQTAHjP3XMxDQF5b201h1MnTVAJwIbBOQi3emv+C4/zX+iKFArgxeFJdUr/8UEo="
    }
  }
}

Пример ответа на загрузку файла:

{
  "file_id": 2947318223,
  "token": "f9LHodD0cOKN7LWyX9hfc2icprCO5CThP_QcGNvMN5wvpD7BvhUOjNkvsdVTR5qxMvgJwgwwvqLLqXcnEGSE"
}