cURL
curl --request GET 'https://api.brightalk.ai/batches/bat_demo_001' \
--header "Authorization: Bearer $BRIGHTALK_API_KEY" \
--header "Brightalk-Version: 2026-07-16"const response = await fetch("https://api.brightalk.ai/batches/bat_demo_001", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.BRIGHTALK_API_KEY}`,
"Brightalk-Version": "2026-07-16",
},
});
console.log(response.status, await response.json());import os
import requests
response = requests.request(
"GET",
"https://api.brightalk.ai/batches/bat_demo_001",
headers={
"Authorization": f"Bearer {os.environ['BRIGHTALK_API_KEY']}",
"Brightalk-Version": "2026-07-16",
},
)
print(response.status_code, response.json()){
"id": "bat_demo_001",
"status": "draft",
"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"
}批次撥號
取得批次
傳回一個由 API 建立的批次，以及彙總收話人數量與時間資訊。每個回應都包含 Brightalk-Version 與 X-Request-Id；受到速率限制的回應還會提供實際套用之配額群組的計數器。
GET
/
batches
/
{batch_id}
cURL
curl --request GET 'https://api.brightalk.ai/batches/bat_demo_001' \
--header "Authorization: Bearer $BRIGHTALK_API_KEY" \
--header "Brightalk-Version: 2026-07-16"const response = await fetch("https://api.brightalk.ai/batches/bat_demo_001", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.BRIGHTALK_API_KEY}`,
"Brightalk-Version": "2026-07-16",
},
});
console.log(response.status, await response.json());import os
import requests
response = requests.request(
"GET",
"https://api.brightalk.ai/batches/bat_demo_001",
headers={
"Authorization": f"Bearer {os.environ['BRIGHTALK_API_KEY']}",
"Brightalk-Version": "2026-07-16",
},
)
print(response.status_code, response.json()){
"id": "bat_demo_001",
"status": "draft",
"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"
}授權
Use a server-side Brightalk API key in the Authorization header.
標頭
選擇以日期為基礎的 API 版本。省略時會使用組織固定的預設版本。
Allowed value:
"2026-07-16"由呼叫端產生且符合 [A-Za-z0-9._:-]{1,64} 的關聯值。無效值會被取代。
Maximum string length:
64Pattern:
^[A-Za-z0-9._:-]{1,64}$路徑參數
不透明的批次識別碼。 不透明的資源識別碼。
Required string length:
1 - 255範例:
"bat_demo_001"
回應
已傳回批次。
不透明的資源識別碼。
Required string length:
1 - 255範例:
"bat_demo_001"
可用選項:
draft, scheduled, queued, in_progress, paused, completed, failed, cancelled 範例:
"Renewal reminders"
不透明的資源識別碼。
Required string length:
1 - 255範例:
"agt_demo_001"
必填範圍:
x >= 0範例:
2
必填範圍:
x >= 0範例:
2
必填範圍:
x >= 0範例:
0
必填範圍:
x >= 0範例:
0
必填範圍:
x >= 0範例:
0
必填範圍:
x >= 0範例:
0
必填範圍:
x >= 0範例:
0
必填範圍:
x >= 0範例:
0
必填範圍:
x >= 0範例:
0
必填範圍:
x >= 0範例:
0
批次建立的時間。
範例:
"2026-07-20T01:00:00Z"
批次上次更新的時間。
範例:
"2026-07-20T01:00:00Z"
設定的最早開始時間點。
範例:
"2026-07-20T01:00:00Z"
一段連續的每日撥號時段。執行階段要求 end_time 晚於 start_time；由於標準 JSON Schema 無法比較兩個時間字串，x-brightalk-end-after-start 會記錄僅供檢查器使用的跨欄位規則。此時段只能「縮小」應用程式中設定的公司外撥時段政策：實際撥號時間是兩者的交集，因此超出公司政策的時段仍只會在公司允許的時間內撥打。
Show child attributes
Show child attributes
開始派送的時間。
範例:
"2026-07-20T01:00:00Z"
批次暫停的時間。
範例:
"2026-07-20T01:00:00Z"
批次完成的時間。
範例:
"2026-07-20T01:00:00Z"
批次取消的時間。
範例:
"2026-07-20T01:00:00Z"