ยกเลิก Campaign

POSThttps://api.voice-agent.gowajee.ai/api/campaign/:id/cancel

เปลี่ยน campaign เป็น CANCELLED ย้อนกลับไม่ได้ ยกเลิกได้เมื่อ campaign เป็น DRAFT, SCHEDULED, RUNNING หรือ PAUSED

• call ที่รอโทรอยู่จะเป็น CANCELLED และระบบไม่ส่ง webhook ของ call เหล่านี้
• call ที่กำลังเรียกสายหรือกำลังคุยอยู่จะคุยต่อจนจบตามปกติ และระบบยังส่งผลของ call เหล่านี้ให้เหมือนเดิม
• ถ้าต้องการหยุดแค่ชั่วคราว ให้ใช้ pause แทน

Path parameters

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

ไม่ต้องส่ง body

Request

cURL

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

JavaScript

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

Python

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

Response

200 OK

{
  "success": true,
  "message": "Campaign status updated to CANCELLED successfully",
  "data": {
    "id": "eac2489c-672c-455e-ab8c-4e0ecd18d7dc",
    "status": "CANCELLED"
  }
}

data.status คือ status ของ campaign หลังจาก request นี้

200 Already CANCELLED

{
  "success": true,
  "message": "Campaign is already CANCELLED",
  "data": {
    "id": "eac2489c-672c-455e-ab8c-4e0ecd18d7dc",
    "status": "CANCELLED"
  }
}

ถ้า campaign เป็น CANCELLED อยู่แล้ว request จะสำเร็จโดยไม่มีอะไรเปลี่ยน ส่งซ้ำได้อย่างปลอดภัย

409 Conflict

{
  "success": false,
  "statusCode": 409,
  "code": "INVALID_CAMPAIGN_STATE",
  "message": "Cannot cancel a COMPLETED campaign",
  "errors": ["Cannot cancel a COMPLETED campaign"]
}

404 Not Found

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

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 นี้เป็นขององค์กรอื่น
409	INVALID_CAMPAIGN_STATE	Cannot cancel a <STATUS> campaign	campaign ที่เป็น COMPLETED หรือ EXPIRED ยกเลิกไม่ได้ เพราะจบไปแล้ว ดูเงื่อนไขการเปลี่ยน status