ویدیوکلیک مرکز توسعه‌دهندگان • راهنمای اتصال
API نسخهٔ ۲ · groups.read / groups.write

دوره‌ها و گروه‌های ویدیو

در API قدیمی دوره و سرفصل هر دو با مدل گروه و رابطهٔ والد/فرزند ساخته می‌شدند. این ساختار در نسخهٔ ۲ با parentId حفظ شده است.

دریافت گروه‌های حساب

گروه‌ها با API نسخهٔ ۲ یا پنل استریم ساخته و مدیریت می‌شوند. این درخواست فقط گروه‌های حساب صاحب توکن را برمی‌گرداند و به نشست آپلود یا فایل‌های پخش دست نمی‌زند.

GET https://videoclick.ir/api/v2/groups
Authorization: Bearer vct_YOUR_ACCESS_TOKEN
200 OK
{"success":true,"groups":[
  {"groupId":123,"title":"آموزش برنامه‌نویسی","parentGroupId":null},
  {"groupId":124,"title":"بخش اول","parentGroupId":123}
]}

یکی از groupIdها را در درخواست ساخت نشست تکی یا گروهی قرار دهید. اگر فهرست خالی است، با API یا پنل استریم گروه ویدیویی بسازید.

ساخت دوره و سرفصل

برای ساخت گروه ریشه، فقط title را بفرستید. برای سرفصل، parentId گروه مادرِ متعلق به همان حساب را هم بفرستید. پاسخ 201 شناسهٔ گروه جدید را می‌دهد.

POST https://videoclick.ir/api/v2/groups
Authorization: Bearer vct_YOUR_ACCESS_TOKEN
Content-Type: application/json; charset=utf-8

{"title":"سرفصل اول","parentId":123}

دریافت، ویرایش و حذف

روش و مسیرکاربردمجوز
GET /api/v2/groups/{groupId}عنوان، والد، تعداد ویدیو و فرزندانgroups.read
PUT /api/v2/groups/{groupId}تغییر عنوان با بدنهٔ {"title":"عنوان جدید"}groups.write
DELETE /api/v2/groups/{groupId}حذف گروه خالیgroups.write

حذف گروه دارای ویدیو یا زیرگروه 409 group_in_use می‌دهد؛ شناسهٔ حساب دیگر با 404 پنهان می‌ماند. تغییر والد در متد ویرایش فعلی انجام نمی‌شود.

نمونهٔ پاسخ جزئیات

GET /api/v2/groups/124

{"success":true,"group":{"id":124,"title":"سرفصل اول","parentId":123},
 "videoCount":3,"childCount":0}
مرکز توسعه‌دهندگان ویدیوکلیکمرجع اتصال و مدیریت رسانه · API نسخهٔ ۲