สร้างลิงก์แชร์

สร้างลิงก์แชร์สำหรับ Agent นั้นผ่าน API Key ของ Agent ผู้ใช้ปลายทางสามารถเปิดลิงก์เพื่อสนทนากับ Agent ได้โดยตรง สามารถตั้งค่าระยะเวลาที่ลิงก์มีผล จำนวนผู้ใช้สูงสุด จำนวนข้อความสูงสุดต่อผู้ใช้ รหัสผ่านสำหรับเข้าถึง และการเปิดใช้งานข้อเสนอแนะ ผลลัพธ์จะเหมือนกับการสร้างลิงก์แชร์ด้วยตนเองบนหน้า "แชร์" โดยสิ้นเชิง

ลิงก์แชร์ที่สร้างขึ้นจะปรากฏในรายการลิงก์แชร์ของ Agent ในเวลาเดียวกัน สามารถดูจำนวนผู้ใช้และการใช้เครดิตในคอนโซล รวมทั้งสามารถแก้ไขหรือลบลิงก์ได้ สมาชิกในองค์กรที่มีสิทธิ์แก้ไข/ลบลิงก์แชร์สามารถดำเนินการกับลิงก์ที่สร้างผ่าน API ได้
การใช้เครดิตจากลิงก์แชร์จะถูกนับรวมในองค์กรของ Agent
หากองค์กรผูกโดเมนที่กำหนดเอง ลิงก์แชร์ที่ส่งกลับจะใช้โดเมนที่กำหนดเอง
รองรับเฉพาะ Agent เท่านั้น หากใช้ API Key ของ Workflow จะส่งคืนประเภท Bot ไม่ถูกต้อง
หากไซต์ปัจจุบันไม่ได้เปิดช่องทางการรวม "แชร์" การเรียกใช้งานจะส่งคืนว่าการดำเนินการไม่รองรับ

วิธีการร้องขอ

POST

ที่อยู่การเรียกใช้งาน

https://api-${endpoint}.gptbots.ai/v1/agent/share/create

การตรวจสอบการเรียกใช้งาน

ดูรายละเอียดได้ที่ ภาพรวม API ในส่วนวิธีการยืนยันตัวตน โปรดใช้ API Key ของ Agent เป้าหมายเป็น token

การร้องขอ

ตัวอย่างการร้องขอ

curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/agent/share/create' \ -H 'Authorization: Bearer ${API Key}' \ -H 'Content-Type: application/json' \ -d '{ "name": "官网试用链接", "valid_days": 7, "user_limit": 10, "user_question_limit": 9999, "password": "Vc3h", "feedback_enabled": true }'

                      
                      curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/agent/share/create' \
-H 'Authorization: Bearer ${API Key}' \
-H 'Content-Type: application/json' \
-d '{
        "name": "官网试用链接",
        "valid_days": 7,
        "user_limit": 10,
        "user_question_limit": 9999,
        "password": "Vc3h",
        "feedback_enabled": true
}'

บล็อกโค้ดนี้ในหน้าต่างลอย

พารามิเตอร์ทั้งหมดเป็นตัวเลือก เมื่อส่ง {} ในตัวเนื้อหาของคำขอ ระบบจะสร้างลิงก์แชร์ที่มีอายุถาวร, ไม่ต้องใช้รหัสผ่าน, รองรับผู้ใช้สูงสุด 10 คน, ผู้ใช้แต่ละคนสูงสุด 9999 ข้อความ, และยังไม่เปิดใช้งานข้อเสนอแนะ หากต้องการจำกัดการเข้าถึง กรุณาส่ง valid_days และ password อย่างชัดเจน

ชื่อฟิลด์ทั้งหมดใช้รูปแบบ underscore (snake_case) หากในตัวเนื้อหาของคำขอมีฟิลด์ที่ไม่สามารถระบุได้ (เช่น เขียนเป็นรูปแบบ camel case validDays) ระบบจะส่งกลับ 40000 และแสดงรายการฟิลด์เหล่านี้ในข้อความข้อผิดพลาด โดยจะไม่สร้างลิงก์

ส่วนหัวของคำขอ

ฟิลด์	ประเภท	คำอธิบาย
Authorization	Bearer ${API Key}	ใช้ `Authorization: Bearer ${API Key}` สำหรับการตรวจสอบการเรียกใช้งาน กรุณารับรหัสจากหน้าคีย์ API เป็น `API Key`
Content-Type	application/json	ประเภทข้อมูล ค่าใช้ได้คือ application/json

พารามิเตอร์ของคำขอ

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
name	string	ไม่จำเป็น	ชื่อของลิงก์แชร์ ความยาวสูงสุด 20 ตัวอักษร เมื่อแก้ไขลิงก์นี้ในคอนโซล ชื่อนี้เป็นฟิลด์จำเป็น แนะนำให้ส่งค่าเมื่อสร้าง
valid_days	int	ไม่จำเป็น	อายุการใช้งานของลิงก์แชร์ หน่วยเป็นวัน ค่าที่อนุญาต 1 ~ 3650 นับจากเวลาสร้าง ถ้าไม่ส่งหมายถึงไม่จำกัด
user_limit	int	ไม่จำเป็น	จำนวนผู้ใช้สูงสุด ค่าที่อนุญาต 1 ~ 99999 ค่าเริ่มต้นคือ 10
user_question_limit	int	ไม่จำเป็น	จำนวนข้อความสูงสุดต่อผู้ใช้ ค่าที่อนุญาต 1 ~ 99999 ค่าเริ่มต้นคือ 9999
password	string	ไม่จำเป็น	รหัสผ่านสำหรับเข้าถึง ต้องเป็นตัวอักษรหรือเลข 4 หลัก หากไม่ส่งหรือส่งเป็นสตริงว่าง แสดงว่าไม่ต้องใช้รหัสผ่าน
feedback_enabled	boolean	ไม่	เปิดหรือไม่เปิดข้อเสนอแนะ ค่าปริยาย `false`.

การตอบกลับ

ตัวอย่างการตอบกลับ

{ "code": 0, "message": "OK", "data": { "share_id": "66f8c2a1e4b0a93c5d7f1a20", "link": "https://www.gptbots.ai/s/csAbC123", "expire_time": 1760112000000 } }

                      
                      {
  "code": 0,
  "message": "OK",
  "data": {
    "share_id": "66f8c2a1e4b0a93c5d7f1a20",
    "link": "https://www.gptbots.ai/s/csAbC123",
    "expire_time": 1760112000000
  }
}

บล็อกโค้ดนี้ในหน้าต่างลอย

การตอบสนองที่สำเร็จ

ฟิลด์	ประเภท	รายละเอียด
share_id	string	รหัสลิงก์สำหรับแชร์
link	string	ที่อยู่ลิงก์สำหรับแชร์ สามารถส่งตรงไปยังผู้ใช้ปลายทางเพื่อเข้าถึงได้
expire_time	long	เวลาหมดอายุของลิงก์แชร์ ในรูปแบบ timestamp มิลลิวินาที หากมีอายุการใช้งานไม่จำกัดจะเป็น `null`

การตอบสนองที่ล้มเหลว

ฟิลด์	ประเภท	รายละเอียด
code	int	รหัสข้อผิดพลาด
message	string	รายละเอียดข้อผิดพลาด

รหัสข้อผิดพลาด

Code	ข้อความ
40000	ข้อผิดพลาดของพารามิเตอร์ (รวมถึงค่าฟิลด์เกินขอบเขต, ประเภทของฟิลด์ผิดพลาด, มีฟิลด์ที่ไม่สามารถรู้จักได้)
40001	คำขอถี่เกินไป โปรดลองอีกครั้งในภายหลัง (Agent หนึ่งสามารถเรียกได้สูงสุด 30 ครั้งต่อนาที)
40008	คำขอถี่เกินไป โปรดลองอีกครั้งในภายหลัง (เกินขีดจำกัด RPM ของ API ตามแพ็กเกจ)
40010	การดำเนินการไม่รองรับ (ไซต์ปัจจุบันไม่ได้เปิดใช้งานการรวมลิงก์แชร์)
40101	Header Authorization ว่าง
40127	การตรวจสอบผู้พัฒนาไม่สำเร็จ
40378	Agent ถูกลบแล้ว
20055	ห้ามใช้ฟังก์ชัน API โปรดตรวจสอบว่าเปิดสวิตช์ API แล้ว
403171	ประเภท Bot ไม่ถูกต้อง