跳轉到主要內容
POST
cURL

授權

Authorization
string
header
必填

Use a private-beta server credential 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.

agent_id
string
必填

不透明的資源識別碼。

Required string length: 1 - 255
範例:

"agt_demo_001"

contact_id
string
必填

不透明的資源識別碼。

Required string length: 1 - 255
範例:

"con_demo_001"

回應

通話已由持久佇列接受。

id
string
必填

不透明的資源識別碼。

Required string length: 1 - 255
範例:

"call_demo_001"

status
enum<string>
必填
可用選項:
queued,
dialing,
in_progress,
completed,
failed,
cancelled
answer_status
enum<string>
必填
可用選項:
answered,
no_answer,
busy,
voicemail,
unknown
contact_id
string
必填

不透明的資源識別碼。

Required string length: 1 - 255
範例:

"con_demo_001"

agent_id
string
必填

不透明的資源識別碼。

Required string length: 1 - 255
範例:

"agt_demo_001"

queued_at
string<date-time>
必填

通話進入持久佇列的時間。

範例:

"2026-07-20T01:00:00Z"

created_at
string<date-time>
必填

公開 Call 資源的建立時間。

範例:

"2026-07-20T01:00:00Z"

updated_at
string<date-time>
必填

Call 資源上次更新的時間。

範例:

"2026-07-20T01:00:00Z"

batch_id
string

不透明的資源識別碼。

Required string length: 1 - 255
範例:

"bat_demo_001"

automation_run_id
string

不透明的資源識別碼。

Required string length: 1 - 255
範例:

"run_demo_001"

outcome
string

標準化或設定的業務結果。

範例:

"qualified"

outcome_reason
string

結果的簡短原因。

範例:

"Requested a follow-up."

summary
string

簡短的通話摘要。

範例:

"Customer requested a follow-up next week."

duration_seconds
integer
必填範圍: x >= 0
範例:

92

dialing_at
string<date-time>

開始撥號的時間。

範例:

"2026-07-20T01:00:00Z"

connected_at
string<date-time>

通話接通的時間。

範例:

"2026-07-20T01:00:00Z"

ended_at
string<date-time>

通話結束的時間。

範例:

"2026-07-20T01:00:00Z"

cancel_requested_at
string<date-time>

要求取消的時間。

範例:

"2026-07-20T01:00:00Z"

cancelled_at
string<date-time>

取消在終止狀態競爭中勝出的時間。

範例:

"2026-07-20T01:00:00Z"