ดูรายการ Agent

GEThttps://api.voice-agent.gowajee.ai/api/agent/list

ดึง agent ทั้งหมดในองค์กร เรียงจากตัวที่สร้างล่าสุดก่อน ใช้ id ของ agent ตอนสร้าง campaign และดู paramsSchema ว่าต้องเตรียม agentParams ของ recipient แต่ละคนอย่างไร

Request

ไม่มี parameter

curl "https://api.voice-agent.gowajee.ai/api/agent/list" \
  -H "X-API-Key: $GOWAJEE_API_KEY"

const res = await fetch('https://api.voice-agent.gowajee.ai/api/agent/list', {
  headers: { 'X-API-Key': process.env.GOWAJEE_API_KEY },
});
const { data: agents } = await res.json();

res = requests.get(
    "https://api.voice-agent.gowajee.ai/api/agent/list",
    headers={"X-API-Key": os.environ["GOWAJEE_API_KEY"]},
    timeout=30,
)
agents = res.json()["data"]

Response

200 OK

{
  "success": true,
  "message": "Get Agent list successfully",
  "data": [
    {
      "id": "33ea7a25-03b2-4614-a004-fa3bf9984bd1",
      "name": "Payment reminder",
      "paramsSchema": {
        "customer_name": {
          "type": "text",
          "required": true,
          "description": "Customer first name"
        },
        "amount_due": {
          "type": "number",
          "required": true,
          "description": "Outstanding amount in baht"
        },
        "is_vip": {
          "type": "boolean",
          "required": false
        }
      }
    }
  ]
}

Field	Type	คำอธิบาย
`data[].id`	string (UUID)	ID ของ agent
`data[].name`	string	ชื่อ agent ที่แสดงใน dashboard
`data[].paramsSchema`	object หรือ `null`	key คือชื่อ parameter และ value คือ `{ type, required, description? }` `type` เป็น `text`, `number` หรือ `boolean` ค่านี้มาจาก version ที่ publish แล้วของ agent ถ้าแก้ draft ใน dashboard ไว้แต่ยังไม่ publish จะยังไม่เห็นที่นี่ ดู paramsSchema

แต่ละ parameter ใน paramsSchema อาจมี key อื่นด้วย

default: ค่าที่ agent ใช้เมื่อ agentParams ของ recipient ไม่มี key นี้
spell และ pronunciation_map: ใช้กำหนดว่า agent ออกเสียงค่านั้นอย่างไร ไม่ต้องสนใจก็ได้