跳轉到主要內容
POST
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])?$

主體

application/json
message
string
必填

電信抬頭、署名前綴、變數代入與最終短網址都計入電信分段上限。請求欄位的 2000 字元上限不代表電信可發送的容量。

Required string length: 1 - 2000
recipients
object[]
必填
Required array length: 1 - 1000 elements
metadata
object
reference_id
string
Required string length: 1 - 255
external_id
string
Required string length: 1 - 255
webhook
object
schedule
object
test_mode
boolean
expires_at
string
Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\.\d+)?(?:Z|[+-]\d{2}:\d{2})$

回應

已傳回結果。

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)$
status
enum<string>
必填
可用選項:
scheduled,
processing,
completed
total_recipients
integer
必填
必填範圍: 0 <= x <= 9007199254740991
completed_recipients
integer
必填
必填範圍: 0 <= x <= 9007199254740991
messages
object[]
必填
Maximum array length: 1000
metadata
object
必填
reference_id
string | null
必填
external_id
string | null
必填
test_mode
boolean
必填
created_at
string
必填
Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\.\d+)?(?:Z|[+-]\d{2}:\d{2})$