دانلودها

تلاش مجدد برای دانلود

POSThttps://api.parsget.com/api/v1/downloads/{download}/retry
OAuth یا Personal API Key

برای شروع دوباره دانلود، ابتدا can_retry را بررسی کنید. اگر true باشد، می‌توانید این درخواست را بفرستید. با شروع موفق تلاش جدید، شناسه دانلود ثابت می‌ماند و attempt افزایش می‌یابد.

برای پیگیری وضعیت، GET /downloads/{download} را فراخوانی کنید.

OAuth Scope: downloads:write

Parameters

download
string · pathrequired
شناسه یکتای دانلود

Response schema

200مشخصات دانلود پس از شروع تلاش جدید. وضعیت بعدی را با GET پیگیری کنید.
Payloadobject
id
string
—
client_reference
string
برچسب دلخواه برای ارتباط دانلود با داده‌های برنامه شما، مثلاً شناسه قسمت یک مجموعه. چند دانلود می‌توانند برچسب یکسان داشته باشند.
name
string
—
status
string
queuedprocessingdownloadingfinalizingcompletedblockedfailedcanceled
وضعیت دانلود. queued یعنی در صف، processing یعنی در حال بررسی و آماده‌سازی دانلود، downloading یعنی دریافت فایل و finalizing یعنی آماده‌سازی نهایی. completed یعنی تکمیل شده، blocked یعنی نیازمند پرداخت، failed یعنی ناموفق و canceled یعنی لغوشده.
activity
string
seedingwaiting_for_capacitynull
پس از تکمیل تورنت، ممکن است ارسال فایل به دیگر کاربران تورنت ادامه داشته باشد. در این حالت، activity برابر seeding و status برابر completed است. وقتی همه اکانت‌های سرویس موقتاً مشغول یا در محدودیت هستند، دانلود با status برابر queued و activity برابر waiting_for_capacity منتظر می‌ماند و با آزاد شدن ظرفیت خودکار ادامه پیدا می‌کند؛ اگر در مهلت تلاش مجدد ظرفیتی آزاد نشود، failed می‌شود.
source
object
type
string
urltorrentusenet
—
hash
string
هش تورنت (فقط برای دانلودهای تورنت مقدار دارد)
host
string
کد سرویس دانلود؛ برای اطلاعات سرویس آن را با code در GET /services تطبیق دهید.
file_id
string
شناسه فایل ایجادشده پس از تکمیل موفق دانلود
mime_type
string
—
size_bytes
integerint64
—
progress
object
percent
numberfloat
min 0max 100
درصد پیشرفت دانلود از ۰ تا ۱۰۰.
bytes_completed
integerint64
min 0
حجم دریافت‌شده بر حسب بایت.
speed_bytes_per_second
number
min 0
سرعت دریافت بر حسب بایت بر ثانیه؛ اگر مشخص نباشد null است.
eta_seconds
number
min 0
زمان تخمینی باقی‌مانده بر حسب ثانیه؛ اگر مشخص نباشد null است.
can_cancel
boolean
اگر true باشد، می‌توانید دانلود را لغو کنید. دکمه لغو را بر اساس این مقدار نمایش دهید.
can_retry
boolean
اگر true باشد، می‌توانید دانلود را دوباره شروع کنید. دکمه تلاش مجدد را بر اساس این مقدار نمایش دهید.
error
object | null
code
string
source_unavailabledownload_expiredquota_exceededdownload_failed
—
message
string
—
created_at
stringdate-time
—
updated_at
stringdate-time
—
completed_at
stringdate-time
—
attempt
integer
min 1
شماره تلاش دانلود، از ۱. با شروع موفق یک تلاش جدید از طریق endpoint retry افزایش می‌یابد.