Calls
List Calls
Calls
List Calls
List all calls
GET
/
calls
curl --request GET \
--url https://api.prod.usesimple.ai/api/v1/calls \
--header 'Authorization: <api-key>'
{
"calls": [
{
"id": 123,
"simple_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"record": true,
"language": "en",
"from_number": "<string>",
"to_number": "<string>",
"status": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z",
"duration": 123,
"created_at": "2023-11-07T05:31:56Z",
"prompt": {
"prompt_text": "<string>",
"created_at": "2023-11-07T05:31:56Z"
},
"transcripts": [
{
"text": "<string>",
"role": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"function_name": "<string>",
"arguments": {}
}
],
"recording_presigned_url": "<string>",
"call_prompt": "<string>",
"answered_by": "voicemail",
"analyzers": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prompt": "<string>",
"output_config": {
"type": "string",
"properties": {}
}
}
],
"analysis_results": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"analyzer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prompt": "<string>",
"output_config": {},
"result": {}
}
]
}
],
"total_count": 123,
"page": 123,
"page_size": 123,
"total_pages": 123
}
Authorizations
Response
200
application/json
Successful Response
Indicates how the call was answered - by a human, voicemail, or if there was no answer
Available options:
voicemail
, human
, no_answer
, unknown
The language to use for the call - English (en) or Spanish (es)
Available options:
en
, es
, ar
List of analyzers configured for this call
Unique identifier for the analyzer
The prompt used for analysis
Configuration for the expected output format
Results from analyzers that have completed
Unique identifier for the analysis result
Identifier of the analyzer that produced this result
The prompt used for analysis
Configuration for the expected output format
The analysis result, structure depends on the output_config
curl --request GET \
--url https://api.prod.usesimple.ai/api/v1/calls \
--header 'Authorization: <api-key>'
{
"calls": [
{
"id": 123,
"simple_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"record": true,
"language": "en",
"from_number": "<string>",
"to_number": "<string>",
"status": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z",
"duration": 123,
"created_at": "2023-11-07T05:31:56Z",
"prompt": {
"prompt_text": "<string>",
"created_at": "2023-11-07T05:31:56Z"
},
"transcripts": [
{
"text": "<string>",
"role": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"function_name": "<string>",
"arguments": {}
}
],
"recording_presigned_url": "<string>",
"call_prompt": "<string>",
"answered_by": "voicemail",
"analyzers": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prompt": "<string>",
"output_config": {
"type": "string",
"properties": {}
}
}
],
"analysis_results": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"analyzer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prompt": "<string>",
"output_config": {},
"result": {}
}
]
}
],
"total_count": 123,
"page": 123,
"page_size": 123,
"total_pages": 123
}