สอบถามรายการ Skill

สอบถามรายการ Skill

รองรับการสอบถามรายการ Skill ภายใต้องค์กรที่ระบุ

คุณสามารถใช้อินเทอร์เฟซนี้เพื่อสอบถามรายการ Skill ภายใต้องค์กรที่ระบุ

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

GET

URL สำหรับร้องขอ

https://api.${endpoint}/v1/org/skill/list

การยืนยันตัวตนในการร้องขอ

ใช้การยืนยันตัวตนแบบ Basic ด้วย DevKey / DevSecret ระดับบัญชี

การร้องขอ

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

curl -X GET 'https://api.${endpoint}/v1/org/skill/list?org_id=p-xxxx&keyword=refund&owner_type=ORGANIZATION&enable=true' \ -H 'Authorization: Basic ${BASIC_TOKEN}'
                      
                      curl -X GET 'https://api.${endpoint}/v1/org/skill/list?org_id=p-xxxx&keyword=refund&owner_type=ORGANIZATION&enable=true' \
  -H 'Authorization: Basic ${BASIC_TOKEN}'

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

Header สำหรับร้องขอ

ฟิลด์ ประเภท คำอธิบาย
Authorization Basic ${BASIC_TOKEN} Basic Token ที่ได้จากการเข้ารหัส Base64 ของ DevKey:DevSecret
Locale String ไม่บังคับ ภาษาของข้อความตอบกลับ ค่าเริ่มต้นคือ en_US

พารามิเตอร์การร้องขอ (Query Parameters)

พารามิเตอร์ ประเภท คำอธิบาย required
org_id String ID ขององค์กร true
keyword String คำสำคัญ false
category_id String ID หมวดหมู่ Skill false
owner_type String ประเภทเจ้าของ Skill เช่น ORGANIZATION false
owner_agent_id String ID ของ Agent ที่เป็นเจ้าของ Skill ส่วนตัว false
enable Boolean จะคืนเฉพาะ Skill ที่เปิดหรือปิดใช้งานเท่านั้นหรือไม่ false

การตอบกลับ

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

{ "code": 0, "message": "OK", "data": [ { "id": "skill-xxxx", "name": "refund-policy", "display_name": "退款政策", "owner_type": "ORGANIZATION", "enable": true } ] }
                      
                      {
  "code": 0,
  "message": "OK",
  "data": [
    {
      "id": "skill-xxxx",
      "name": "refund-policy",
      "display_name": "退款政策",
      "owner_type": "ORGANIZATION",
      "enable": true
    }
  ]
}

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

การตอบกลับเมื่อสำเร็จ

รายการในการตอบกลับใช้ฟิลด์เดียวกับรายการ Skill ในคอนโซล ประกอบด้วยข้อมูล Skill ID, ชื่อ, คำอธิบาย, เจ้าของ, หมวดหมู่, เวอร์ชัน, สถานะการเปิดใช้งาน และอื่น ๆ

การตอบกลับเมื่อผิดพลาด

ฟิลด์ ประเภท คำอธิบาย
code Integer รหัสข้อผิดพลาด
message String รายละเอียดข้อผิดพลาด

รหัสสถานะ

รหัสสถานะ คำอธิบาย
200 สำเร็จ
400 พารามิเตอร์ไม่ถูกต้อง
401 ไม่ได้รับอนุญาต
403 สิทธิ์ไม่เพียงพอ
429 คำขอถี่เกินไป
500 ข้อผิดพลาดของเซิร์ฟเวอร์