ดู Status ของ Campaign

GEThttps://api.voice-agent.gowajee.ai/api/campaign/:id/status

ดึง status ของ campaign และจำนวน recipient แยกตาม status ของ call ล่าสุด ถ้าต้องการแสดงความคืบหน้าของ campaign endpoint นี้เร็วที่สุด

Path parameters

ชื่อ	คำอธิบาย
id	ID ของ campaign

Request

cURL

curl "https://api.voice-agent.gowajee.ai/api/campaign/eac2489c-672c-455e-ab8c-4e0ecd18d7dc/status" \
  -H "X-API-Key: $GOWAJEE_API_KEY"

JavaScript

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

Python

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

Response

200 OK

{
  "success": true,
  "message": "Get Campaign status successfully",
  "data": {
    "id": "eac2489c-672c-455e-ab8c-4e0ecd18d7dc",
    "status": "RUNNING",
    "statistics": {
      "completed": 812,
      "noAnswer": 120,
      "busy": 14,
      "failed": 3,
      "cancelled": 0,
      "queued": 6,
      "inProgress": 9,
      "scheduled": 230,
      "expired": 0,
      "notStarted": 4,
      "analyzing": 2,
      "analysisFailed": 0
    }
  }
}

404 Not Found

{
  "success": false,
  "statusCode": 404,
  "code": "CAMPAIGN_NOT_FOUND",
  "message": "Campaign not found",
  "errors": ["Campaign not found"]
}

ไม่มี campaign ID นี้ หรือ campaign นี้เป็นขององค์กรอื่น

Field	คำอธิบาย
data.status	status ของ campaign
data.statistics	จำนวน recipient (ไม่ใช่จำนวน call) แยกตาม status ของ call ล่าสุด ผลรวมทุกค่าเท่ากับจำนวน recipient ทั้งหมด

key ใน statistics	status ของ call ล่าสุด
completed	COMPLETED
noAnswer	NO_ANSWER recipient ที่รอ retry จะนับอยู่ที่นี่จนกว่าจะถึงเวลา retry
busy	BUSY
failed	FAILED
cancelled	CANCELLED
queued	QUEUED
inProgress	IN_PROGRESS
scheduled	SCHEDULED รอช่วงเวลาโทร หรือรอสายว่าง
expired	EXPIRED
analyzing	ANALYZING call จบแล้ว ระบบกำลังเตรียมผล
analysisFailed	ANALYSIS_FAILED
notStarted	ยังไม่เคยโทร หรือตอนนี้เป็น RINGING / INITIATED

Error

body ใช้รูปแบบ error ปกติ

Status	code	message	สาเหตุ
400	INVALID_ID	id must be a valid UUID	id ใน path ไม่ใช่ UUID
404	CAMPAIGN_NOT_FOUND	Campaign not found	id ผิด หรือ campaign นี้เป็นขององค์กรอื่น