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

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

contact_id
string
必填
Required string length: 1 - 255
message
string
必填

原樣傳送的文字,最多 5000 個 UTF-16 編碼單位;BMP 範圍外的表情符號計為兩個單位。不可只有空白。

Required string length: 1 - 5000
Pattern: \S

回應

已建立或讀回 LINE 發送紀錄。請檢查 status;建立紀錄不代表送達。

id
string
必填
Required string length: 1 - 255
contact_id
string
必填
Required string length: 1 - 255
status
enum<string>
必填

sent 代表服務商已接受,不代表送達或已讀。pending 與 unknown 不可觸發再次發送。

可用選項:
pending,
sent,
failed,
unknown
error_code
enum<string> | null
必填
可用選項:
null,
module_unavailable,
credentials_unavailable,
authorization_changed,
provider_rejected,
delivery_unconfirmed,
dispatch_not_started
created_at
string<date-time>
必填