Get Recordings List

GET /v1/recordings

Summary: Retrieves a paginated list of recordings for the currently authenticated user.

Security:

Bearer Authentication required.

Query Parameters:

quantity (number, required): Number of elements to retrieve (min: 1).
from (number, required): Zero-based index of the first recording to retrieve.
words (string, optional): Full-text search filter using a special syntax (supports exact, and, or, not filters).
sentiment (string, optional): Comma-separated list of sentiment values (e.g. POSITIVE,NEUTRAL).
tel (string, optional): Filter by phone number (supports comma-separated phone numbers).
startdate (string, optional): ISO date string marking the start of the date range (required if enddate is provided).
enddate (string, optional): ISO date string marking the end of the date range (must be after startdate).
users (string, optional): User filter, using an “include” or “exclude” list of user GUIDs.
tagids (string, optional): Comma-separated list of tag GUIDs.
noteswords (string, optional): Full-text search filter for notes (with similar syntax to words).

Responses:

200 OK:
Returns a JSON object with:

total: total number of matching recordings.
recordings: an array of Recording objects.
Example:

CODE

{
  "total": 8,
  "recordings": [
    {
      "id": "string",
      "ownerId": "string",
      "direction": "IN",
      "from": { "fullName": "string", "phoneNumber": "string" },
      "to": { "fullName": "string", "phoneNumber": "string" },
      "date": "2021-04-25T10:24:40Z",
      "analysisResult": { "score": 0.8, "sentiment": "POSITIVE", "status": 2 },
      "channels": 2,
      "duration": 362,
      "tags": [
        { "id": "1efc024d-5c55-456b-9e91-26cd3f57e689", "value": "Customer Complaint" },
        { "id": "a2c80f67-7d9d-4c99-9a13-20f2cac40c63", "value": "Happy Customer" }
      ],
      "video": { "status": "OK" },
      "hasNotes": true
    }
  ]
}

Error messages:

400 Bad Request
401 Unauthorized
403 Forbidden – e.g. when a standard user attempts to access recordings for other users.
500 Internal Server Error