跳轉到主要內容
GET
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}$

路徑參數

sms_id
string<uuid>
必填

資源識別碼。

回應

已傳回結果。

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,
queued,
sent,
delivered,
failed,
unknown,
delivery_unknown,
test
phone_number
string
必填
message
string
必填
segments
integer
必填
必填範圍: 1 <= x <= 6
credits_reserved
number
必填
必填範圍: x >= 0
credits_deducted
number
必填
必填範圍: x >= 0
metadata
object
必填
reference_id
string | null
必填
external_id
string | null
必填
test_mode
boolean
必填
error_code
string | null
必填
created_at
string
必填
Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\.\d+)?(?:Z|[+-]\d{2}:\d{2})$
expires_at
string
必填
Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\.\d+)?(?:Z|[+-]\d{2}:\d{2})$