Designed to retrieve call recordings associated with a specific user within a defined time range.
Endpoint:
GET https://api.convoso.com/v1/users/recordings
🔒 Authentication
- Parameter Name: auth_token
- Type: Query Parameter
- Required: Yes
🔎 Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| auth_token | string | Yes | Your API authentication token. |
| user | string | Yes | Comma delimited list of users for filtering recordings |
| start_time | string (YYYY-MM-DD HH:MM:SS) | No | The start if the date-time range for filtering recordings |
| end_time | string (YYYY-MM-DD HH:MM:SS) | No | The end if the date-time range for filtering recordings |
| limit | integer | No | Maximum number of recordings to return. Default is 20. |
| offset | integer | No | Number of recordings to skip for pagination. Default is 0. |
Example Request
GET https://api.convoso.com/v1/users/recordings?auth_token=YOUR_API_TOKEN&start_time=2015-01-01%2000:00:00&end_time=2015-02-01%2000:00:00&user=john1@gmail.com&limit=20&offset=0
Response Format
{
"success": true,
"data": {
"offset": 0,
"limit": 10,
"total": 10,
"entries": [
{
"recording_id": 8,
"lead_id": 270,
"start_time": "2014-06-19 21:11:36",
"end_time": "",
"seconds": null,
"url": "convoso_8183376356_8_1403237496-all.wav"
}
]
}
}Response Descriptions
Top-Level Request Metadata
| Field | Type | Description |
|---|---|---|
| success | boolean | Indicates whether the API call succeeded. |
| data | object | Contains pagination and recordings array |
Data Object
| Field | Type | Description |
|---|---|---|
| offset | integer | The current offset (for pagination). |
| limit | integer | Maximum number of entries returned per page. |
| total | integer | Total number of recordings matching the query. |
| entries | array | List of recording objects. |
Entries Array - Recording Object
| Field | Type | Description |
|---|---|---|
| recording_id | integer | Unique identifier for the recording. |
| lead_id | integer | Identifier of the lead/contact related to the recording. |
| start_time | string | The start datetime of the call (YYYY-MM-DD HH:MM:SS). |
| end_time | string | The end datetime of the call (may be empty if not available). |
| seconds | integer/null | Duration of the call in seconds (null if unavailable). |
| url | string | Filename or partial URL of the recording (may need prefix to stream/download). |