Conversation files
A conversation file is the record of an attachment uploaded to a conversation (image, audio, video or document). Register the file after uploading it, then reference it when you send a message.
Endpoints
| Method | Path | Description |
|---|---|---|
POST | /conversation-files | Upload a file |
GET | /conversation-files | List files |
GET | /conversation-files/:id | Get a file |
The conversation file object
json
Fields
| Field | Type | Description |
|---|---|---|
_id | string | Read-only. File ID. Send it as conversation_file_id with the message. |
organization_id | integer | Read-only. Taken from the conversation. |
conversation_id | integer | Conversation the file belongs to. Required. |
file_name | string | Original file name. Required. |
file_type | string | MIME type, e.g. image/jpeg. Required. |
file_size | integer | Size in bytes. Required. |
file_category | string | image, audio, video or file. Required. |
s3_key | string | Storage key (s3PathWithoutBucket from the upload URL). |
s3_path | string | Full s3:// path (s3Path from the upload URL). |
upload_by_user_id | integer | null | Read-only. User who registered the file (the API key's user). |
uploaded_at | string (date-time) | Read-only. Registration time. |
updated_at | string (date-time) | Read-only. Last update time. |
Related
Report an issue with this documentation
Please log in to report issues with our documentation.