ข้อมูลพื้นฐาน
ส่วนนี้อธิบายข้อมูลพื้นฐานที่คุณต้องรู้ก่อนที่จะใช้ Chat API
ข้อกำหนดเบื้องต้น
ในการใช้ Chat API คุณต้องมีรายการดังต่อไปนี้:
- Hive certification key: โทเค็นการตรวจสอบสิทธิ์สำหรับการเรียก API
- สามารถพบได้ที่ Hive Console > App Center > Project management > Game details > Basic information
- Game index: ดัชนีของเกมที่สร้างขึ้นใน Hive Console > App Center > Project management
Warning
- คีย์การรับรอง Hive เป็นข้อมูลความปลอดภัยที่ละเอียดอ่อนและไม่ควรเปิดเผยต่อสาธารณะ สำหรับความปลอดภัย ควรหลีกเลี่ยงการรวมมันโดยตรงในโค้ดต้นฉบับของคุณ หากคุณต้องการนำฟีเจอร์ไปใช้ในสภาพแวดล้อมของลูกค้า โปรดใช้ Hive SDK
- API แชททั้งหมดทำงานในลักษณะการสื่อสารแบบ เซิร์ฟเวอร์ต่อเซิร์ฟเวอร์ หากคุณเรียก API โดยตรงจากไคลเอนต์เกม จะมีความเสี่ยงในการรั่วไหลของโทเค็นการรับรองและปัญหาที่ไม่คาดคิด ดังนั้นโปรดใช้ด้วยความระมัดระวัง
หัวข้อทั่วไป
| ชื่อฟิลด์ | คำอธิบาย | ประเภท | จำเป็น |
| Authorization | โทเค็นการตรวจสอบสิทธิ์สำหรับการเรียก API (Bearer) | string | Y |
| Content-Type | ประเภทของข้อมูลคำขอ (application/json) | string | Y |
รหัสการตอบกลับ
| รหัสสถานะ HTTP | รหัส | ข้อความ | คำอธิบาย |
| 200 | 0 | สำเร็จ. | สำเร็จ |
| 400 | 100 | การร้องขอไม่ถูกต้อง. | การร้องขอไม่ถูกต้อง |
| 401 | 101 | โทเค็นไม่ถูกต้อง. | โทเค็นไม่ถูกต้อง |
| 403 | 102 | ห้ามเข้าถึง. | ไม่มีสิทธิ์ |
| 404 | 103 | ไม่พบ. | ไม่พบ |
| 405 | 104 | วิธีการไม่อนุญาต. | วิธีการไม่อนุญาต |
| 500 | 105 | ข้อผิดพลาดของเซิร์ฟเวอร์ภายใน. | ข้อผิดพลาดของเซิร์ฟเวอร์ภายใน |
| 503 | 108 | เซิร์ฟเวอร์ยุ่งอยู่ โปรดร้องขอภายหลัง. | เซิร์ฟเวอร์เกินกำลัง |
| รหัสสถานะ HTTP | รหัส | ข้อความ | คำอธิบาย |
| 400 | 200 | รหัสช่องซ้ำกัน. | รหัสช่องซ้ำกัน |
| 400 | 201 | ไม่พบช่องหรือถูกลบ. | ไม่พบช่องหรือถูกลบ |
| 400 | 202 | ช่องเต็ม. | ไม่สามารถเข้าช่องได้เนื่องจากเกินขีดจำกัดผู้เข้าร่วม |
| 400 | 203 | รหัสผ่านช่องไม่ถูกต้อง. | รหัสผ่านช่องไม่ถูกต้อง |
| 400 | 204 | ขนาดข้อความเกิน. ขนาดสูงสุดคือ 200. | ขนาดข้อความเกิน (สูงสุด 200 ตัวอักษร) |
| 400 | 300 | ผู้ใช้ไม่ได้อยู่ในเซสชัน. | ผู้ใช้ไม่ได้อยู่ในเซสชัน (ไม่ได้เชื่อมต่อกับเซิร์ฟเวอร์ซ็อกเก็ต) |
| 400 | 301 | ผู้ใช้ไม่ได้อยู่ในช่อง. | ผู้ใช้ไม่ได้อยู่ในช่อง |
| 400 | 302 | ผู้ใช้已经อยู่ในช่อง. | ผู้ใช้已经อยู่ในช่อง |
| 400 | 303 | ผู้ใช้ถูกบล็อกแล้ว. | ผู้ใช้ถูกบล็อกแล้ว |
| 400 | 304 | รายการบล็อกเต็ม. ขนาดสูงสุดคือ 100. | รายการบล็อกเต็ม (สูงสุด 100 ผู้ใช้) |
| 400 | 305 | ผู้ใช้ไม่ได้อยู่ในรายการบล็อก. | ผู้ใช้ไม่ได้อยู่ในรายการบล็อก |
| 400 | 306 | ผู้ใช้ถูกบล็อก. | ผู้ใช้ถูกบล็อก |
| 400 | 307 | จำนวนช่องสูงสุดที่ผู้ใช้สามารถเข้าถึงได้ถูกเกิน. | เกินจำนวนช่องที่ผู้ใช้สามารถเข้าถึงได้ |
| 403 | 308 | ผู้ใช้不是ช่องเจ้าของ. | ผู้ใช้不是ช่องเจ้าของ |
| 400 | 400 | ขนาดข้อความที่กำหนดเองเกินขนาด ขนาดสูงสุดคือ 8,000 ไบต์. | ขนาดข้อความที่กำหนดเองเกิน (สูงสุด 8,000 ไบต์) |