StoredFile

Query stored files

Queries files stored within the given project.

get/v1/projects/{project_id}/files

Request

  • Base URL: https://api.telerivet.com
  • URL: https://api.telerivet.com/v1/projects/{project_id}/files
  • Auth: one of:
    • HTTP basic
    • OAuth 2 (authorization code, authorization URL https://telerivet.com/oauth/authorize, token URL https://api.telerivet.com/oauth/token)

Path parameters

project_idstring required

ID of the Project

Query parameters

filenamestring

Filter files by filename

typestring

Filter files by MIME type. A type ending in /* matches any subtype (e.g. image/*).

category'outgoing_media' | 'incoming_media' | 'call_audio' | 'test_recording' | 'script_module' | 'icon'

Filter files by category

source'upload' | 'recording' | 'message' | 'api'

Filter files by how they were created

sizeinteger

Filter files by size in bytes

time_createdinteger

Unix timestamp in seconds

Filter files by time_created

message_idstring

ID of Message

Filter files associated with a particular message

sha256string

Filter files by the SHA-256 hash of the file content (lowercase hex), e.g. to check whether a particular file has already been uploaded

sort'default' | 'filename' | 'size' | 'time_created'

Sort the results based on a field

sort_dir'asc' | 'desc'

Sort the results in ascending or descending order

page_sizeinteger

Number of results returned per page (max 500)

offsetinteger

Number of items to skip from beginning of result set

markerstring

'next_marker' property returned by a previous call to this API method, indicating where the next page of results should start.

countboolean

If true, the API will return the count of items matching the filter, instead of the items themselves

Response

Successful response. When count=1 parameter is provided, returns {"count": N} instead.

truncatedboolean

True if there are more results

next_markerstring

Marker for pagination

page_sizeinteger

Number of results per page

sort_dir'asc' | 'desc'

Sort direction

countinteger

Total count of matching items (only when count=1 parameter is provided)

Example response

{
  "data": [
    {
      "id": "SF2c72e0be64f38ea9",
      "filename": "image.jpg",
      "type": "image/jpeg",
      "size": 482133,
      "category": "outgoing_media",
      "source": "api",
      "message_id": "SM66bba24d8b6a3a25",
      "sha256": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
      "time_created": 1751980000,
      "user_id": "URba3e403e98f49735",
      "project_id": "PJ2ad0100821a98bea"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.