List Canned Files

GET/v1/conversations/canned-files

Returns a paginated list of canned files available in the workspace. Use a canned file id as fileId when sending media session messages.

Query Parameters

searchstring

Filter canned files by name

Example:invoice

fileTypesarray

Filter by MIME type(s)

Example:image/jpeg,application/pdf

maxSizenumber

Maximum file size in MB

Example:5

pageinteger

Example:1

limitinteger

Example:10

sortBystring

Example:createdAt

sortOrderstring

Example:desc

Responses

Body

success_codeenum: 200 | 201•Numeric success code matching the HTTP response status. required

Example:200

messagestring required

Example:OK

detailsobject required

dataarray[object] required

_idstring

Example:60faaaaaa7890abcdef12345

namestring

Example:Invoice template

descriptionstring or null

Example:Standard invoice PDF

workspaceIdstring

Example:9e69c76a-683d-44f9-a314-3be15c98aebb

uploadedFileobject

idstring

Example:60fbbbbbb7890abcdef12345

originalNamestring

Example:invoice.pdf

fileTypestring

Example:application/pdf

sizenumber

Example:0.25

presignedUrlstring

Example:https://example.com/presigned

createdByobject

idstring

namestring

isDeletedboolean

metaobject

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

Request Sample:Shell / cURL

1
2
3
4

curl --request GET \
  --url "https://api-stg.bevatelcloud.com/v1/conversations/canned-files?search=invoice&fileTypes=image/jpeg,application/pdf&maxSize=5&page=1&limit=10&sortBy=createdAt&sortOrder=desc" \
  --header "Authorization: Bearer <YOUR_API_KEY>" \
  --header "Content-Type: application/json"

Response Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

{
  "success_code": 200,
  "message": "OK",
  "details": {},
  "data": [
    {
      "_id": "60faaaaaa7890abcdef12345",
      "name": "Invoice template",
      "description": "Standard invoice PDF",
      "workspaceId": "9e69c76a-683d-44f9-a314-3be15c98aebb",
      "uploadedFile": {
        "id": "60fbbbbbb7890abcdef12345",
        "originalName": "invoice.pdf",
        "fileType": "application/pdf",
        "size": 0.25,
        "presignedUrl": "https://example.com/presigned"
      },
      "createdBy": {
        "id": "string",
        "name": "string"
      },
      "isDeleted": true
    }
  ],
  "meta": {}
}