Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Use a server-side Brightalk API key in the Authorization header.

Headers

Brightalk-Version
string
default:2026-07-16

Selects the date-based API version. Omission uses the organization’s pinned default.

Allowed value: "2026-07-16"
X-Request-Id
string

A caller-generated correlation value matching [A-Za-z0-9._:-]{1,64}. Invalid values are replaced.

Maximum string length: 64
Pattern: ^[A-Za-z0-9._:-]{1,64}$

Path Parameters

call_id
string
required

The opaque Call identifier. An opaque resource identifier.

Required string length: 1 - 255
Example:

"call_demo_001"

Response

Call returned.

id
string
required

An opaque resource identifier.

Required string length: 1 - 255
Example:

"call_demo_001"

status
enum<string>
required
Available options:
queued,
dialing,
in_progress,
completed,
failed,
cancelled
answer_status
enum<string>
required
Available options:
answered,
no_answer,
busy,
voicemail,
unknown
contact_id
string
required

An opaque resource identifier.

Required string length: 1 - 255
Example:

"con_demo_001"

agent_id
string
required

An opaque resource identifier.

Required string length: 1 - 255
Example:

"agt_demo_001"

queued_at
string<date-time>
required

When the call entered the durable queue.

Example:

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

created_at
string<date-time>
required

When the public Call resource was created.

Example:

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

updated_at
string<date-time>
required

When the Call resource was last updated.

Example:

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

batch_id
string

An opaque resource identifier.

Required string length: 1 - 255
Example:

"bat_demo_001"

automation_run_id
string

An opaque resource identifier.

Required string length: 1 - 255
Example:

"run_demo_001"

outcome
string

A normalized or configured business outcome.

Example:

"qualified"

outcome_reason
string

A concise reason for the outcome.

Example:

"Requested a follow-up."

summary
string

A concise call summary.

Example:

"Customer requested a follow-up next week."

duration_seconds
integer
Required range: x >= 0
Example:

92

dialing_at
string<date-time>

When dialing began.

Example:

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

connected_at
string<date-time>

When the call connected.

Example:

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

ended_at
string<date-time>

When the call ended.

Example:

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

cancel_requested_at
string<date-time>

When cancellation was requested.

Example:

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

cancelled_at
string<date-time>

When cancellation won the terminal-state race.

Example:

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