Retrieves Call Log records.
Endpoint:
GET https://api.convoso.com/v1/log/retrieve
đź”’ Authentication
- Parameter Name: auth_token
- Type: Query Parameter
- Required: Yes
🔍 Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| auth_token | string | Yes | Your API authentication token. |
| id | string | No | Specific log ID to retrieve. |
| lead_id | string | No | Filter logs by lead ID. |
| campaign_id | string | No | Filter logs by campaign ID. |
| queue_id | string | No | Filter logs by queue ID. |
| list_id | string | No | Filter logs by list ID. |
| user_id | string | No | Filter logs by user (agent) ID. |
| status | string | No | Filter logs by call status. |
| phone_number | string | No | Filter logs by phone number. |
| number_dialed | string | No | Filter logs by the number dialed. |
| first_name | string | No | Filter logs by lead's first name. |
| last_name | string | No | Filter logs by lead's last name. |
| start_time | string | No | Start time for filtering logs (format: YYYY-MM-DD HH:MM:SS). |
| end_time | string | No | End time for filtering logs (format: YYYY-MM-DD HH:MM:SS). |
| limit | integer | No | Maximum number of records to return. |
| offset | integer | No | Number of records to skip for pagination. |
| order | string | No | Order of results (asc or desc). "default = DESC (newest call)" |
| call_type | string | No | Filter logs by call type (INBOUND, OUTBOUND, etc.). |
| called_count | integer | No | Filter logs by the number of times the lead was called. |
| include_recordings | boolean | No | Include recording URLs in the response (1 for yes, 0 for no). |
Example Request
GET https://api.convoso.com/v1/log/retrieve?auth_token=YOUR_API_TOKEN&user_id=123456&call_type=OUTBOUND&include_recordings=0
Response Format
{
"success": true,
"data": {
"offset": 0,
"limit": 500,
"total_found": "546",
"entries": 500,
"results": [
{
"id": "9999999999",
"lead_id": "99999999",
"list_id": "99999",
"campaign_id": "9999",
"campaign": "Example Campaign",
"user": "Example Agent",
"user_id": "9999999"",
"phone_number": "9999999999",
"number_dialed": "9999999999",
"first_name": "First_Name",
"last_name": "Last_Name",
"status": "HU",
"status_name": "Hang Up",
"call_length": "21",
"call_date": "2025-05-28 14:58:38",
"agent_comment": "",
"recording": [
{
"src": "https://admin-dt.convoso.com/play-recording-public/JTdCJTIyYWNjb3VudF9pZCUyMiUzQTEwNjM4NyUyQyUyMnVfaWQlMjIlM0ElMjJhNTRiYTFqZzdqbDZzcThyMXBnNGExZmphNDQ0MHdzMCUyMiU3RA==?rlt=tH9oAVlBG1gJ1eWTsd8lo7NKyxjnG+GWF8YVlyrUvl8",
"type": "pause",
"new": "yes",
"recording_id": "999999999999",
"filename": "106387_1143823_6055457374_50279005_5051_1748469536_8636-in-1748.mp3",
"public_url": "https://admin-dt.convoso.com/play-recording-public/JTdCJTIyYVudF9pZCUyMiUzQTEwNjM4NyUyQyUyMnVfaWQlMjIlM0ElMjJhNTRiYTFqZzdqbDZzcThyMXBnNGExZmphNDQ0MHdzMCUyMiU3RA==?rlt=tH9oAVlBG1gJ1eWTsd8lo7NKyxjnG+GWF8YVlyrUvl8"
}
],
"queue_id": null,
"called_count": "14",
"caller_id_displayed": "16059999999",
"term_reason": "CALLER",
"call_type": "OUTBOUND",
"queue_position": "1",
"queue_seconds": "0.00",
"originating_agent_id": null,
"session_id": "54e763323127574e3795008b41e36162@192.0.0.0:5060"
}
]
}
}Response Descriptions
Top-Level Request Metadata
| Field | Type | Description |
|---|---|---|
| success | boolean | Indicates whether the request was successful. |
| offset | integer | Pagination offset used in the request. |
| limit | integer | Number of results returned (max per page). |
| total_found | string | Total number of matching call log records. |
| entries | integer | Number of records returned in this page. |
| results | array | Array of call log result objects (see main table). |
Call Log Results Object
| Field | Type | Description |
|---|---|---|
| id | string | Unique identifier for the call log entry. |
| lead_id | string | ID of the associated lead. |
| list_id | string | ID of the lead list. |
| campaign_id | string | ID of the campaign. |
| campaign | string | Name of the campaign. |
| user | string | Full name or label of the user (agent). |
| user_id | string | ID of the agent/user. |
| phone_number | string | Phone number of the lead. |
| number_dialed | string | Number that was dialed. |
| first_name | string | First name of the lead. |
| last_name | string | Last name of the lead. |
| status | string | Call status code (e.g., HU for Hang Up). |
| status_name | string | Human-readable name of the call status. |
| call_length | string | Duration of the call in seconds. |
| call_date | string | Timestamp when the call occurred (YYYY-MM-DD HH:MM:SS). |
| agent_comment | string | Optional comment added by the agent. |
| recording | array[object] | Array of recording objects (see sub-table below). |
| queue_id | string/null | ID of the queue (if applicable). |
| called_count | string | Number of times this lead has been called. |
| caller_id_displayed | string | Caller ID number shown to the lead. |
| term_reason | string | Reason the call ended (e.g., CALLER). |
| call_type | string | Type of call (OUTBOUND, INBOUND). |
| queue_position | string | Lead’s position in the queue (if applicable). |
| queue_seconds | string | Time in seconds the lead waited in the queue. |
| originating_agent_id | string/null | ID of the originating agent (if any). |
| session_id | string | SIP session ID associated with the call. |
Recording Object Structure
| Field | Type | Description |
|---|---|---|
| src | string | Internal source path of the recording. |
| type | string | Type of recording (e.g., pause). |
| new | string | Whether it's a new recording (yes). |
| recording_id | string | Unique ID of the recording. |
| filename | string | File name of the recording. |
| public_url | string | Publicly accessible URL for playback/download of the recording. |