ข้ามไปยังเนื้อหา

การตรวจสอบสิทธิ์

ทุกคำขอไปยัง 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ข้อผิดพลาดฝั่งเซิร์ฟเวอร์