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

MethodPathDescription
POST/conversation-filesUpload a file
GET/conversation-filesList files
GET/conversation-files/:idGet a file

The conversation file object

json

Fields

FieldTypeDescription
_idstringRead-only. File ID. Send it as conversation_file_id with the message.
organization_idintegerRead-only. Taken from the conversation.
conversation_idintegerConversation the file belongs to. Required.
file_namestringOriginal file name. Required.
file_typestringMIME type, e.g. image/jpeg. Required.
file_sizeintegerSize in bytes. Required.
file_categorystringimage, audio, video or file. Required.
s3_keystringStorage key (s3PathWithoutBucket from the upload URL).
s3_pathstringFull s3:// path (s3Path from the upload URL).
upload_by_user_idinteger | nullRead-only. User who registered the file (the API key's user).
uploaded_atstring (date-time)Read-only. Registration time.
updated_atstring (date-time)Read-only. Last update time.

Related

Report an issue with this documentation

Please log in to report issues with our documentation.