Skip to main content
GET
Get a call

Authorizations

X-Api-Key
string
header
required

Your API key.

Path Parameters

id
string<uuid>
required

Unique identifier of the call

Response

OK

id
string<uuid>

Unique identifier of the call

agentId
string<uuid>

Unique identifier of the agent

phone
string

Phone number of the other party, in the E.164 international standard format

Example:

"+33612345678"

type
enum<string>

Type of the call

Available options:
INBOUND,
OUTBOUND
duration
integer<int64>

Duration of the call in seconds

Example:

360

startTime
string<date-time>

Start time of the call.

Format: UTC time - yyyy-MM-dd'T'HH:mm:ss'Z'

Example:

"2024-07-30T14:35:00Z"

endTime
string<date-time>

End time of the call.

Format: UTC time - yyyy-MM-dd'T'HH:mm:ss'Z'

Example:

"2024-07-30T14:41:00Z"

anonymous
boolean

If the call was anonymous

status
enum<string>

Status of the call

Available options:
IN_PROGRESS,
CANCELED,
COMPLETED,
NO_ANSWER,
VOICE_BOX,
UNREACHABLE,
FAILED,
TRANSFERRED,
REJECTED,
FAILOVER,
REJECTED_LIMIT_REACHED,
REJECTED_MAX_CONCURRENCY
extractors
object[]

Result of the extractors. Each extractor is represented by an object with 'name' and 'value' fields.

Example:
extractedData
object

Flattened result of the extractors. Extractors are represented by a { "key": "value" } object.

Example:
classifiers
object[]

Result of the classifiers. Each classifier is represented by an object with 'name' and 'value' fields. The 'name' indicates the classification category, and the 'value' is the determined classification.

Example:
classificationData
object

Flattened result of the classifiers. Classifiers are represented by a { "key": "value" } object.

Example:
context
object

Custom object for dynamic content injection into the agent prompt. Keys in this map correspond to placeholders in the prompt template: e.g {{ firstName }}. At runtime, each placeholder was replaced with its corresponding value.

System prefixed variables are reserved and automatically injected by Volubile system e.g. recipient phone, instant time of the call, etc.

Example:
recorded
boolean

If the call was recorded

summary
string

Summary of what happened during the call

Example:

"Discussed project requirements and next steps."

tags
string[]

Tags associated with the call

Tags associated with the call

Example:
created
string<date-time>

Timestamp when the call record was created.

Format: UTC time - yyyy-MM-dd'T'HH:mm:ss'Z'

Example:

"2024-07-30T14:45:00Z"