تخطَّ إلى المحتوى

المصادقة

كل طلب إلى واجهة Record Meeting API يحتاج إلى مفتاح API. تُنشئ المفاتيح في التطبيق ضمن الإعدادات ➤ مفاتيح API.

علامة تبويب مفاتيح API في الإعدادات مع زر إنشاء مفتاح

https://api.recordmeeting.com/v1

تُكتب مسارات نقاط النهاية في هذا المرجع مع البادئة /v1، على سبيل المثال GET /v1/recordings. أضِفها إلى https://api.recordmeeting.com.

أرسل مفتاح API الخاص بك في ترويسة Authorization. تبدأ المفاتيح بـ sk_rm_.

Authorization: Bearer sk_rm_your_key

لإنشاء مفتاح، راجع دليل المستخدم ➤ مفاتيح API. يمنح المفتاح نفس الوصول الذي يحصل عليه حسابك: تسجيلاتك الخاصة وتسجيلات المؤسسة المسموح لك بعرضها.

Terminal window
curl "https://api.recordmeeting.com/v1/recordings" \
-H "Authorization: Bearer sk_rm_your_key"

الاستجابات الناجحة بصيغة JSON مع النتيجة تحت data. نقاط النهاية الخاصة بالقوائم التي تُقسّم نتائجها إلى صفحات تضيف كائن pagination. تحمل بعض الاستجابات أيضًا "success": true.

تُجيب طلبات PATCH وDELETE بالرمز 204 No Content مع جسم فارغ عند نجاحها.

جميع الأخطاء بهذا التنسيق:

{
"error": {
"code": "ERROR_CODE",
"message": "Human readable description"
}
}

يحصل الطلب الذي لا يحتوي على ترويسة Authorization صالحة على 401.

الرمزحالة HTTPالمعنى
INVALID_API_KEY401المفتاح غير موجود أو تم إبطاله
API_KEY_EXPIRED401انتهت صلاحية المفتاح
USER_NOT_FOUND401الحساب الذي ينتمي إليه المفتاح لم يعد موجودًا
AUTH_ERROR401فشلت المصادقة
الرمزحالة HTTPالمعنى
VALIDATION_ERROR400معاملات طلب غير صالحة أو مفقودة
RECORDING_NOT_READY400لا يمكن مشاركة التسجيل بعد
ORGANIZATION_SUBSCRIPTION_EXPIRED402المؤسسة التي تملك التسجيل لم يعد لديها اشتراك Enterprise نشط
FORBIDDEN403أنت لست عضوًا في المؤسسة، أو قد لا يُسمح لك برؤية ما طلبته
RECORDING_LOCKED403التسجيل مقفل. قم بالترقية لفتحه
SUBSCRIPTION_REQUIRED403يتطلب هذا الإجراء خطة مدفوعة
TRANSCRIPT_NOT_AVAILABLE403النسخ النصي معطّل للمؤسسة أو للعضو
SHARING_DISABLED403المشاركة معطّلة للمؤسسة أو للعضو
RECORDING_NOT_FOUND404التسجيل غير موجود أو لا يمكنك الوصول إليه
INTERNAL_ERROR500خطأ من جانب الخادم