GET
/
v1
/
calls
/
{id}
curl --request GET \
  --url https://api.eu.volubile.ai/v1/calls/{id} \
  --header 'X-Api-Key: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "phone": "+33612345678",
  "type": "INBOUND",
  "duration": 360,
  "startTime": "2024-07-30T14:35:00Z",
  "endTime": "2024-07-30T14:41:00Z",
  "anonymous": true,
  "status": "IN_PROGRESS",
  "extractors": [
    {
      "name": "customer",
      "value": [
        {
          "name": "firstname",
          "value": [
            "John"
          ]
        },
        {
          "name": "lastname",
          "value": [
            "Doe"
          ]
        },
        {
          "name": "address",
          "value": [
            "123 Main St"
          ]
        }
      ]
    },
    {
      "name": "example",
      "value": [
        "example1"
      ]
    }
  ],
  "extractedData": {
    "customer": {
      "firstname": "John",
      "lastname": "Doe",
      "address": "123 Main St"
    },
    "example": "example1"
  },
  "classifiers": [
    {
      "name": "Customer's request",
      "value": "Refund",
      "type": "PRIMARY"
    },
    {
      "name": "Sentiment",
      "value": "Positive",
      "type": "SECONDARY"
    }
  ],
  "classificationData": {
    "Customer's request": "Refund",
    "Sentiment": "Positive"
  },
  "context": {
    "firstName": "firstname",
    "lastName": "lastname",
    "orderNumber": "5HZ99FRT",
    "system": {
      "phone": "+33612345678"
    }
  },
  "recorded": true,
  "summary": "Discussed project requirements and next steps.",
  "created": "2024-07-30T14:45:00Z"
}

Authorizations

X-Api-Key
string
header
required

Your API key.

Path Parameters

id
string
required

Unique identifier of the call

Response

200
application/json
OK
id
string

Unique identifier of the call

agentId
string

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

Duration of the call in seconds

Example:

360

startTime
string

Start time of the call.

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

Example:

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

endTime
string

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
extractors
object[]

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

Example:
[
  {
    "name": "customer",
    "value": [
      { "name": "firstname", "value": ["John"] },
      { "name": "lastname", "value": ["Doe"] },
      {
        "name": "address",
        "value": ["123 Main St"]
      }
    ]
  },
  { "name": "example", "value": ["example1"] }
]
extractedData
object

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

Example:
{
  "customer": {
    "firstname": "John",
    "lastname": "Doe",
    "address": "123 Main St"
  },
  "example": "example1"
}
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:
[
  {
    "name": "Customer's request",
    "value": "Refund",
    "type": "PRIMARY"
  },
  {
    "name": "Sentiment",
    "value": "Positive",
    "type": "SECONDARY"
  }
]
classificationData
object

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

Example:
{
  "Customer's request": "Refund",
  "Sentiment": "Positive"
}
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:
{
  "firstName": "firstname",
  "lastName": "lastname",
  "orderNumber": "5HZ99FRT",
  "system": { "phone": "+33612345678" }
}
recorded
boolean

If the call was recorded

summary
string

Summary of what happened during the call

Example:

"Discussed project requirements and next steps."

created
string

Timestamp when the call record was created.

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

Example:

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