Retrieves a List of all Lead Recordings.
Endpoint:
GET https://api.convoso.com/v1/lead/get-recordings
đź”’ Authentication
- Parameter Name: auth_token
- Type: Query Parameter
- Required: Yes
🔎 Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| auth_token | string | Yes | Authorization Token |
| lead_id | string | Yes | Unique identifier of the lead. |
| start_time | string | No | Start datetime for filtering recordings (format: YYYY-MM-DD HH:MM:SS). |
| end_time | string | No | End datetime for filtering recordings (format: YYYY-MM-DD HH:MM:SS). |
| offset | int | No | Pagination offset (default: 0). |
| limit | int | No | Number of records to return (default: 10, max: 100). |
Example Request
GET https://api.convoso.com/v1/leads/get-recordings?auth_token=YOUR_AUTH_TOKEN&lead_id=0&start_time=2010-01-01 00:00:00&end_time=2018-01-01 00:00:00&offset=0&limit=10
Response Format (JSON)
{
"success": true,
"data": {
"offset": 0,
"limit": 10,
"total": 1,
"entries": [
{
"recording_id": 8,
"lead_id": 270,
"start_time": "2014-06-19 21:11:36",
"end_time": "",
"seconds": 10,
"url": "1403237496-all.wav"
}
]
}
}Response Field Definitions
Top-Level Data Object
| Field | Type | Description |
|---|---|---|
| success | boolean | Identifies if the API was executed successfully |
| data | object | Contains lead data and metadata |
Data Object
| Field | Type | Description |
|---|---|---|
| offset | string | Current pagination offset. |
| limit | string | Current page size. |
| total | string | Total number of matching leads. |
| entries | array | Array of recordings |
Entries - Recording Objects
| Field | Type | Description |
|---|---|---|
| recording_id | integer | Unique ID of the recording |
| lead_id | integer | ID of the lead associated with this recording |
| start_time | string | Start time of the recording (YYYY-MM-DD HH:MM:SS) |
| end_time | string | End time of the recording (YYYY-MM-DD HH:MM:SS) – may be empty |
| seconds | integer | Duration of the recording in seconds |
| url | string | Path or filename to the recording file (e.g., WAV file) |