زیرساخت API

گوگل میت پریمیوم، داخل محصول شما. با چند درخواست ساده API.

اتاق جلسه را از داخل نرم‌افزارتان بسازید، میزبان‌ها و مهمان‌ها را مدیریت کنید و بعد از هر جلسه ضبط، گزارش حضور و رویدادها را با وب‌هوک تحویل بگیرید؛ کاربران شما هیچ‌وقت از محصولتان خارج نمی‌شوند.

کلید، مصرف و صورت‌حساب مستقل برای هر لایسنس API.

درخواست
curl -X POST https://iroom.live/api/v1/licences/{licence}/rooms \
  -H "Authorization: Bearer $IROOM_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Math 10 — Week 3",
    "client_reference": "course_1042",
    "access_type": "restricted",
    "admins": ["teacher@school.com"],
    "artifacts": { "recording": true, "attendance_report": true }
  }'
201 Created پاسخ
{
  "object": "room",
  "title": "Math 10 — Week 3",
  "client_reference": "course_1042",
  "join_url": "https://meet.google.com/ird-clas-s10",
  "access_type": "restricted",
  "member_counts": { "admins": 1, "guests": 0 }
}
مناسب برای
  • پلتفرم‌های آموزش آنلاین
  • نرم‌افزارهای CRM و فروش
  • پلتفرم‌های مشاوره
  • سامانه‌های استخدام
  • مارکت‌پلیس خدمات
چه چیزی می‌سازید؟

هر جا محصول شما به جلسه آنلاین نیاز دارد.

جلسه را به بخشی از جریان کاری محصولتان تبدیل کنید؛ ساخت اتاق، دعوت افراد و دریافت خروجی‌ها همه با API انجام می‌شود.

پلتفرم آموزش آنلاین

برای هر دوره یا جلسه کلاس به‌طور خودکار اتاق بسازید و ضبط و حضور را کنار همان دوره نمایش دهید.

CRM و نرم‌افزار فروش

برای هر معامله یا جلسه دمو اتاق جدا بسازید و خروجی جلسه را به پرونده مشتری وصل کنید.

مشاوره و نوبت‌دهی

با هر نوبت رزروشده یک اتاق خصوصی بسازید و مدت واقعی جلسه را برای تسویه ثبت کنید.

سامانه استخدام

اتاق مصاحبه با میزبان‌های مشخص و ضبط جلسه، و دسترسی به فایل‌ها فقط برای کمیته استخدام.

مارکت‌پلیس خدمات

ارائه‌دهنده و مشتری را در یک اتاق امن کنار هم بیاورید، بدون اینکه لینک شخصی کسی رد و بدل شود.

ابزارها و اتوماسیون داخلی

جلسات تکرارشونده و دعوت اعضا را از سامانه‌های داخلی سازمان مدیریت کنید.

شروع کار در سه قدم

از کلید API تا اولین جلسه در چند دقیقه.

API آی‌روم مستقیم و قابل پیش‌بینی است: یک توکن، چند درخواست JSON و وب‌هوک برای رویدادهای بعد از جلسه.

مطالعه راهنمای شروع
  1. قدم اول

    لایسنس API بگیرید و توکن بسازید

    پلن API را فعال کنید و از پنل توسعه‌دهنده توکن دسترسی بسازید. هر لایسنس کلید، سهمیه و صورت‌حساب خودش را دارد.

    • توکن Bearer
    • لایسنس مستقل برای هر محصول
    • مستندات OpenAPI
  2. قدم دوم

    اتاق بسازید و افراد را اضافه کنید

    با یک درخواست POST اتاق بسازید، نوع دسترسی، میزبان‌ها و ضبط خودکار را تعیین کنید و لینک join_url را به کاربرانتان بدهید.

    • تعیین میزبان و مهمان
    • ضبط و گزارش حضور خودکار
    • شناسه اختصاصی client_reference
  3. قدم سوم

    خروجی جلسه را تحویل بگیرید

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

    • وب‌هوک رویدادها
    • گزارش حضور هر جلسه
    • مدیریت دسترسی فایل‌ها
امکانات API

هر آنچه برای مدیریت جلسه لازم دارید.

همه منابع زیر لایسنس شما قرار دارند؛ بنابراین مصرف و صورت‌حساب هر محصول کاملاً جداست.

  • احراز هویت با توکن Bearer
  • پاسخ‌های JSON با کد خطای مشخص
  • محدودیت نرخ درخواست با هدرهای استاندارد
  • مستندات OpenAPI و محیط آزمایش درخواست‌ها
مشاهده مستندات کامل API

لایسنس‌ها

فهرست لایسنس‌ها، وضعیت و مصرف

  • GET/licences
  • GET/licences/{licence}

اتاق‌ها

ساخت، ویرایش و پایان جلسه فعال

  • POST/rooms
  • PATCH/rooms/{room}
  • POST/rooms/{room}/end-active-conference

اعضا

افزودن مهمان و میزبان، تغییر نقش و حذف

  • POST/rooms/{room}/members
  • POST/rooms/{room}/admins
  • PATCH/members/{member}

جلسات و حضور

فهرست جلسات، حضور و رویدادهای هر جلسه

  • GET/rooms/{room}/conferences
  • GET/conferences/{conference}/attendance
  • GET/conferences/{conference}/audit-events

فایل‌ها و دسترسی

ضبط و گزارش‌ها، و اشتراک‌گذاری کنترل‌شده

  • GET/rooms/{room}/artifacts
  • POST/artifacts/{artifact}/permissions
  • DELETE/artifacts/{artifact}
وب‌هوک‌ها

لازم نیست مدام وضعیت را بپرسید.

به‌جای درخواست‌های پشت‌سرهم، یک آدرس وب‌هوک ثبت کنید تا هر وقت فایلی آماده شد، گزارشی به‌روز شد یا عضوی تغییر کرد، آی‌روم خبرتان کند.

artifact.available
ضبط یا فایل جلسه آماده شد
artifact.updated
وضعیت یک فایل تغییر کرد
report.updated
گزارش حضور جلسه به‌روز شد
room.member.updated
عضو اتاق اضافه، ویرایش یا حذف شد
  • شناسه یکتای رویداد و هدر Idempotency-Key
  • تلاش دوباره خودکار در صورت خطای سرور شما
  • تاریخچه ارسال‌ها و نتیجه هر تلاش در پنل
نمونه یکپارچه‌سازی

محصولات مختلف، API آی‌روم را این‌طور به کار می‌برند.

چند جریان رایج برای الهام گرفتن؛ هر مرحله را می‌توانید با منطق محصول خودتان ترکیب کنید.

پلتفرم آموزش آنلاین

کلاس خودکار برای هر دوره

جریان کار
  1. مدرس دوره جدید می‌سازد

    POST/rooms
  2. دانشجو در دوره ثبت‌نام می‌کند

    POST/rooms/{room}/members
  3. ضبط جلسه آماده می‌شود

    WEBHOOKartifact.available
نتیجه برای کاربران

لینک کلاس، ضبط و گزارش حضور داخل صفحه همان دوره؛ دانشجو از پلتفرم خارج نمی‌شود.

پلتفرم مشاوره آنلاین

اتاق خصوصی برای هر نوبت

جریان کار
  1. مراجع نوبت رزرو می‌کند

    POST/rooms
  2. مشاور به‌عنوان میزبان اضافه می‌شود

    POST/rooms/{room}/admins
  3. بعد از جلسه، مدت حضور خوانده می‌شود

    GET/conferences/{conference}/attendance
نتیجه برای کاربران

هر نوبت اتاق جدای خودش را دارد و مدت واقعی جلسه برای تسویه با مشاور ثبت می‌شود.

سامانه استخدام (ATS)

مصاحبه ضبط‌شده در پرونده کاندیدا

جریان کار
  1. مصاحبه زمان‌بندی می‌شود

    POST/rooms
  2. ضبط مصاحبه آماده می‌شود

    WEBHOOKartifact.available
  3. دسترسی به کمیته استخدام داده می‌شود

    POST/artifacts/{artifact}/permissions
نتیجه برای کاربران

ضبط هر مصاحبه در پرونده کاندیدا و فقط در دسترس کمیته استخدام.

از کجا شروع کنید؟

از اولین نمونه تا بار کامل محصول.

با پلن API شروع کنید و هر زمان مصرفتان بیشتر شد، با تیم آی‌روم درباره حجم بالاتر صحبت کنید.

مستندات و محیط آزمایش

پیش از خرید، مستندات را بخوانید و ساختار درخواست‌ها را ببینید.

  • راهنمای شروع
  • مرجع OpenAPI
  • محیط آزمایش درخواست‌ها
مطالعه مستندات

پلن‌های API

لایسنس مستقل با کلید و صورت‌حساب جدا برای هر محصول.

  • کلید API مستقل
  • مصرف و صورت‌حساب شفاف
  • فعال‌سازی فوری
مشاهده پلن‌های API
پرسش‌های رایج

پیش از یکپارچه‌سازی، بدانید.

پاسخ پرسش‌هایی که تیم‌های فنی بیشتر از همه می‌پرسند.

احراز هویت API چطور انجام می‌شود؟

هر درخواست با توکن Bearer ارسال می‌شود که از پنل توسعه‌دهنده می‌سازید. توکن را هر زمان لازم شد می‌توانید باطل کنید و توکن جدید بسازید.

کاربران من به حساب آی‌روم نیاز دارند؟

خیر. کاربران شما با join_url وارد گوگل میت می‌شوند. اینکه ورود نیاز به تأیید میزبان داشته باشد، با access_type اتاق تعیین می‌شود.

هزینه API چطور محاسبه می‌شود؟

هر لایسنس API صورت‌حساب جدای خودش را دارد و مصرف هر اتاق، از جمله دقایق جلسه، در پاسخ API و پنل قابل مشاهده است. جزئیات هر پلن در صفحه قیمت‌ها آمده است.

محدودیت تعداد درخواست دارد؟

بله. برای پایداری سرویس، تعداد درخواست‌ها در دقیقه محدود است و ساخت اتاق محدودیت جداگانه دارد. در صورت عبور از سقف، پاسخ 429 همراه با زمان انتظار برمی‌گردد.

اگر سرور من وب‌هوک را دریافت نکند چه می‌شود؟

ارسال وب‌هوک در صورت خطا دوباره تلاش می‌شود. هر رویداد شناسه یکتا و هدر Idempotency-Key دارد تا پردازش تکراری رخ ندهد.

می‌توانم پیش از خرید API را بررسی کنم؟

بله. راهنمای شروع، مرجع OpenAPI و محیط آزمایش درخواست‌ها بدون خرید در دسترس است.

یکپارچه‌سازی را شروع کنیم؟

جلسه آنلاین را به بخشی از محصولتان تبدیل کنید.

درباره محصول، حجم جلسات و جریان کاری‌تان با تیم فنی آی‌روم صحبت کنید تا بهترین مسیر یکپارچه‌سازی را پیشنهاد کنیم.

  • نوع محصول و کاربران
  • تعداد تقریبی جلسات در ماه
  • نیاز به ضبط، گزارش یا وب‌هوک
مشاهده پلن‌های API
مشاوره فنی با تیم آی‌روم 021-9103-1640