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<uuid>
required

The opaque Call identifier. An opaque resource identifier.

Required string length: 1 - 255
Example:

"11111111-1111-4111-8111-111111111111"

Response

Current call history or result returned.

object
string
required
Allowed value: "call_result"
schema_version
string
required
Allowed value: "2026-11-18"
call_id
required
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)$
revision
string
required

SHA-256 fingerprint of projected response content. Compare for equality; it is not monotonic.

Pattern: ^[a-f0-9]{64}$
classification_status
enum<string>
required

Availability of the retained classification: ready means a current result exists; processing means the call is ongoing or its post-call summary pipeline is pending, without certifying a running classifier job. unavailable means no current result, including after a failed summary, and can change after later classification.

Available options:
processing,
ready,
unavailable
classification_unavailable_reason
enum<string> | null
required
Available options:
not_recorded,
manually_corrected
poll_after_seconds
number | null
required
outcome
string | null
required
outcome_reason
string | null
required
conversation_result
object | null
required
voicemail
object
required