ดูรายการ Campaign

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

ดึง campaign ทั้งหมดในองค์กร เรียงจากใหม่ไปเก่า endpoint นี้ไม่แบ่ง page

Request

cURL

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

JavaScript

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

Python

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

Response

200 OK

{
  "success": true,
  "message": "Get Campaign list successfully",
  "data": [
    {
      "id": "eac2489c-672c-455e-ab8c-4e0ecd18d7dc",
      "name": "October payment reminder",
      "agentName": "Payment reminder",
      "status": "RUNNING",
      "numberOfRecipients": 1200,
      "numberOfCalledRecipients": 815,
      "numberOfCallingRecipients": 15,
      "numberOfNotStartedRecipients": 370,
      "createdAt": "2026-09-30T08:12:44.120Z",
      "updatedAt": "2026-10-01T02:00:05.310Z"
    }
  ]
}

data เป็น array ของ campaign

recipient แต่ละคนนับอยู่ใน counter ทั้งสามตัวตัวเดียวเท่านั้น ผลรวมของ called + calling + not started จึงเท่ากับ numberOfRecipients เสมอ จากตัวอย่าง 815 + 15 + 370 = 1200

Field	Type	คำอธิบาย
id	string (UUID)	ID ของ campaign
name	string	ชื่อ campaign
agentName	string	ชื่อ agent ที่ใช้โทร เป็น "" ถ้าลบ agent ไปแล้ว
status	string	ดู status ของ campaign
numberOfRecipients	integer	จำนวน recipient ทั้งหมด
numberOfCalledRecipients	integer	recipient ที่มี call จบแล้วหรือกำลังวิเคราะห์ผลอย่างน้อยหนึ่ง call และตอนนี้ไม่มี call ที่กำลังโทรอยู่ คนที่รอ retry ก็นับอยู่ในกลุ่มนี้ รวมถึง call ที่กลายเป็น EXPIRED หรือ CANCELLED โดยยังไม่ได้โทรออกด้วย
numberOfCallingRecipients	integer	recipient ที่ตอนนี้มี call เป็น QUEUED, INITIATED, RINGING หรือ IN_PROGRESS
numberOfNotStartedRecipients	integer	recipient ที่มีแค่ call ที่เป็น SCHEDULED หรือยังไม่มี call เลย
createdAt / updatedAt	string (UTC)	timestamp