取消剩餘的批次工作

cURL

curl --request POST 'https://api.brightalk.ai/batches/bat_demo_001/cancel' \
  --header "Authorization: Bearer $BRIGHTALK_API_KEY" \
  --header "Brightalk-Version: 2026-07-16" \
  --header "Content-Type: application/json" \
  --data '{}'

const response = await fetch("https://api.brightalk.ai/batches/bat_demo_001/cancel", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGHTALK_API_KEY}`,
    "Brightalk-Version": "2026-07-16",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});
console.log(response.status, await response.json());

import os
import requests

response = requests.request(
    "POST",
    "https://api.brightalk.ai/batches/bat_demo_001/cancel",
    headers={
    "Authorization": f"Bearer {os.environ['BRIGHTALK_API_KEY']}",
    "Brightalk-Version": "2026-07-16",
    "Content-Type": "application/json",
    },
    json={},
)
print(response.status_code, response.json())

{
  "id": "bat_demo_001",
  "name": "Renewal reminders",
  "agent_id": "agt_demo_001",
  "total_recipients": 2,
  "pending_recipients": 2,
  "queued_recipients": 0,
  "in_progress_recipients": 0,
  "completed_recipients": 0,
  "failed_recipients": 0,
  "cancelled_recipients": 0,
  "answered_recipients": 0,
  "no_answer_recipients": 0,
  "busy_recipients": 0,
  "created_at": "2026-07-20T01:00:00Z",
  "updated_at": "2026-07-20T01:00:00Z",
  "scheduled_start_at": "2026-07-20T01:00:00Z",
  "calling_window": {
    "time_zone": "Asia/Taipei",
    "weekdays": [
      "monday",
      "tuesday",
      "wednesday",
      "thursday",
      "friday"
    ],
    "start_time": "09:00",
    "end_time": "18:00"
  },
  "started_at": "2026-07-20T01:00:00Z",
  "paused_at": "2026-07-20T01:00:00Z",
  "completed_at": "2026-07-20T01:00:00Z",
  "cancelled_at": "2026-07-20T01:00:00Z"
}

POST

batches

{batch_id}

cancel

cURL

curl --request POST 'https://api.brightalk.ai/batches/bat_demo_001/cancel' \
  --header "Authorization: Bearer $BRIGHTALK_API_KEY" \
  --header "Brightalk-Version: 2026-07-16" \
  --header "Content-Type: application/json" \
  --data '{}'

const response = await fetch("https://api.brightalk.ai/batches/bat_demo_001/cancel", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGHTALK_API_KEY}`,
    "Brightalk-Version": "2026-07-16",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});
console.log(response.status, await response.json());

import os
import requests

response = requests.request(
    "POST",
    "https://api.brightalk.ai/batches/bat_demo_001/cancel",
    headers={
    "Authorization": f"Bearer {os.environ['BRIGHTALK_API_KEY']}",
    "Brightalk-Version": "2026-07-16",
    "Content-Type": "application/json",
    },
    json={},
)
print(response.status_code, response.json())

{
  "id": "bat_demo_001",
  "name": "Renewal reminders",
  "agent_id": "agt_demo_001",
  "total_recipients": 2,
  "pending_recipients": 2,
  "queued_recipients": 0,
  "in_progress_recipients": 0,
  "completed_recipients": 0,
  "failed_recipients": 0,
  "cancelled_recipients": 0,
  "answered_recipients": 0,
  "no_answer_recipients": 0,
  "busy_recipients": 0,
  "created_at": "2026-07-20T01:00:00Z",
  "updated_at": "2026-07-20T01:00:00Z",
  "scheduled_start_at": "2026-07-20T01:00:00Z",
  "calling_window": {
    "time_zone": "Asia/Taipei",
    "weekdays": [
      "monday",
      "tuesday",
      "wednesday",
      "thursday",
      "friday"
    ],
    "start_time": "09:00",
    "end_time": "18:00"
  },
  "started_at": "2026-07-20T01:00:00Z",
  "paused_at": "2026-07-20T01:00:00Z",
  "completed_at": "2026-07-20T01:00:00Z",
  "cancelled_at": "2026-07-20T01:00:00Z"
}

授權

Authorization

string

header

必填

Use a private-beta server credential in the Authorization header.

標頭

Brightalk-Version

string

預設值:2026-07-16

選擇以日期為基礎的 API 版本。省略時會使用組織鎖定的私人測試版預設值。

Allowed value: "2026-07-16"

X-Request-Id

string

由呼叫端產生且符合 [A-Za-z0-9._:-]{1,64} 的關聯值。無效值會被取代。

Maximum string length: 64

Pattern: ^[A-Za-z0-9._:-]{1,64}$

Idempotency-Key

string

可選擇讓此狀態轉換在 24 小時內重播。

Required string length: 1 - 255

Pattern: ^(?=.{1,255}$)[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$

路徑參數

batch_id

string

必填

不透明的 Batch 識別碼。不透明的資源識別碼。

Required string length: 1 - 255

範例:

"bat_demo_001"

主體

application/json

JSON request body. The raw encoded body is limited to 1 MiB and unknown fields are rejected.

The body is of type object.

回應

已傳回目前的 Batch 資源。

string

必填

不透明的資源識別碼。

Required string length: 1 - 255

範例:

"bat_demo_001"

status

enum<string>

必填

可用選項:

draft,

scheduled,

queued,

in_progress,

paused,

completed,

failed,

cancelled

name

string

必填

範例:

"Renewal reminders"

agent_id

string

必填

不透明的資源識別碼。

Required string length: 1 - 255

範例:

"agt_demo_001"

total_recipients

integer

必填

必填範圍: x >= 0

範例:

2

pending_recipients

integer

必填

必填範圍: x >= 0

範例:

2

queued_recipients

integer

必填

必填範圍: x >= 0

範例:

0

in_progress_recipients

integer

必填

必填範圍: x >= 0

範例:

0

completed_recipients

integer

必填

必填範圍: x >= 0

範例:

0

failed_recipients

integer

必填

必填範圍: x >= 0

範例:

0

cancelled_recipients

integer

必填

必填範圍: x >= 0

範例:

0

answered_recipients

integer

必填

必填範圍: x >= 0

範例:

0

no_answer_recipients

integer

必填

必填範圍: x >= 0

範例:

0

busy_recipients

integer

必填

必填範圍: x >= 0

範例:

0

created_at

string<date-time>

必填

批次建立的時間。

範例:

"2026-07-20T01:00:00Z"

updated_at

string<date-time>

必填

批次上次更新的時間。

範例:

"2026-07-20T01:00:00Z"

scheduled_start_at

string<date-time>

設定的最早開始時間點。

範例:

"2026-07-20T01:00:00Z"

calling_window

object

一段連續的每日撥號時段。執行階段要求 end_time 晚於 start_time；由於標準 JSON Schema 無法比較兩個時間字串，x-brightalk-end-after-start 會記錄僅供檢查器使用的跨欄位規則。

Show child attributes

started_at

string<date-time>

開始派送的時間。

範例:

"2026-07-20T01:00:00Z"

paused_at

string<date-time>

批次暫停的時間。

範例:

"2026-07-20T01:00:00Z"

completed_at

string<date-time>

批次完成的時間。

範例:

"2026-07-20T01:00:00Z"

cancelled_at

string<date-time>

批次取消的時間。

範例:

"2026-07-20T01:00:00Z"

繼續批次派送列出由 API 啟動的 Automation 執行

⌘I

開始使用

API 基礎

核心概念

操作指南

發布資訊

API 參考

授權

標頭

路徑參數

主體

回應