List calls
curl --request GET \
--url https://api.eu.volubile.ai/v1/calls \
--header 'X-Api-Key: <api-key>'{
"content": [
{
"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"
}
],
"size": 123,
"page": 123,
"totalElements": 123,
"totalPages": 123
}Authorizations
Your API key.
Query Parameters
Filter by agent id
Filter by phone number, in the E.164 international standard format
"+33612345678"
Filter by campaign name
Filter by date, inclusive lower bound. Requires 'to' to not be null.
Format: YYYY-MM-DD
"2024-08-01"
Filter by date, inclusive upper bound. Requires 'from' to not be null.
Format: YYYY-MM-DD
"2024-08-31"
The page number to be returned, starts at 1
The number of items to be returned, maximum 100
The sort property and direction
<property>,ASC, <property>,DESC "property,DESC"
Response
List of items in the current page
Unique identifier of the call
Unique identifier of the agent
Phone number of the other party, in the E.164 international standard format
"+33612345678"
Type of the call
INBOUND, OUTBOUND Duration of the call in seconds
360
Start time of the call.
Format: UTC time - yyyy-MM-dd'T'HH:mm:ss'Z'
"2024-07-30T14:35:00Z"
End time of the call.
Format: UTC time - yyyy-MM-dd'T'HH:mm:ss'Z'
"2024-07-30T14:41:00Z"
If the call was anonymous
Status of the call
IN_PROGRESS, CANCELED, COMPLETED, NO_ANSWER, VOICE_BOX, UNREACHABLE, FAILED, TRANSFERRED, REJECTED Result of the extractors. Each extractor is represented by an object with 'name' and 'value' fields.
[
{
"name": "customer",
"value": [
{ "name": "firstname", "value": ["John"] },
{ "name": "lastname", "value": ["Doe"] },
{
"name": "address",
"value": ["123 Main St"]
}
]
},
{ "name": "example", "value": ["example1"] }
]
Flattened result of the extractors. Extractors are represented by a { "key": "value" } object.
Flattened result of the extractors. Extractors are represented by a { "key": "value" } object.
{
"customer": {
"firstname": "John",
"lastname": "Doe",
"address": "123 Main St"
},
"example": "example1"
}
{
"customer": {
"firstname": "John",
"lastname": "Doe",
"address": "123 Main St"
},
"example": "example1"
}
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.
[
{
"name": "Customer's request",
"value": "Refund",
"type": "PRIMARY"
},
{
"name": "Sentiment",
"value": "Positive",
"type": "SECONDARY"
}
]
Flattened result of the classifiers. Classifiers are represented by a { "key": "value" } object.
Flattened result of the classifiers. Classifiers are represented by a { "key": "value" } object.
"{\"Customer's request\":\"Refund\",\"Sentiment\":\"Positive\"}"
{
"Customer's request": "Refund",
"Sentiment": "Positive"
}
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.
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.
{
"firstName": "firstname",
"lastName": "lastname",
"orderNumber": "5HZ99FRT",
"system": { "phone": "+33612345678" }
}
{
"firstName": "firstname",
"lastName": "lastname",
"orderNumber": "5HZ99FRT",
"system": { "phone": "+33612345678" }
}
If the call was recorded
Summary of what happened during the call
"Discussed project requirements and next steps."
Timestamp when the call record was created.
Format: UTC time - yyyy-MM-dd'T'HH:mm:ss'Z'
"2024-07-30T14:45:00Z"
The size of the page
The page number
The total amount of elements
The number of total pages
curl --request GET \
--url https://api.eu.volubile.ai/v1/calls \
--header 'X-Api-Key: <api-key>'{
"content": [
{
"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"
}
],
"size": 123,
"page": 123,
"totalElements": 123,
"totalPages": 123
}