跳轉到主要內容
PUT
cURL

授權

Authorization
string
header
必填

Use a server-side Brightalk API key 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])?$

路徑參數

task_id
string<uuid>
必填

大型任務識別碼。

chunk_index
string
必填

從 0 開始的上傳分段編號。

Pattern: ^(?:0|[1-9][0-9]{0,4})$

主體

application/json
recipients
string<uuid> · object · object[]
必填
Required array length: 1 - 1000 elements
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

回應

已傳回任務狀態。已提交不代表已送達或執行完成。

id
string<uuid>
必填
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
kind
enum<string>
必填
可用選項:
calls,
sms
recipient_format
enum<string>
必填
可用選項:
contact_ids,
recipients
status
enum<string>
必填
可用選項:
uploading,
queued,
processing,
completed,
failed
total_recipients
integer
必填
必填範圍: 0 <= x <= 9007199254740991
uploaded_recipients
integer
必填
必填範圍: 0 <= x <= 9007199254740991
submitted_recipients
integer
必填
必填範圍: 0 <= x <= 9007199254740991
settled_recipients
integer
必填
必填範圍: 0 <= x <= 9007199254740991
failed_recipients
integer
必填
必填範圍: 0 <= x <= 9007199254740991
unknown_recipients
integer
必填
必填範圍: 0 <= x <= 9007199254740991
total_parts
integer
必填
必填範圍: 0 <= x <= 9007199254740991
submitted_parts
integer
必填
必填範圍: 0 <= x <= 9007199254740991
failed_parts
integer
必填
必填範圍: 0 <= x <= 9007199254740991
error_code
string | null
必填
upload_chunk_size
integer
必填
必填範圍: 1 <= x <= 1000
created_at
string
必填