Send File

​

Endpoint

POST /send/file

​

Headers

​

Request Body (multipart/form-data)

​

Response

​

Code Examples

curl -X POST http://localhost:3000/send/file \
  -H "X-Device-Id: my-device" \
  -F "[email protected]" \
  -F "caption=Monthly Report - June 2024" \
  -F "file=@/path/to/report.pdf"

​

Response Example

{
  "code": "SUCCESS",
  "message": "Success",
  "results": {
    "message_id": "3EB0B430B6F8F1D0E053AC120E0A9E5C",
    "status": "File sent successfully"
  }
}

​

Supported File Types

​

Document Formats

• Microsoft Word: .doc, .docx
• Microsoft Excel: .xls, .xlsx
• Microsoft PowerPoint: .ppt, .pptx
• PDF: .pdf
• Text: .txt, .rtf

• Writer: .odt
• Calc: .ods
• Impress: .odp

​

Data Formats

• CSV: .csv
• JSON: .json
• XML: .xml
• YAML: .yml, .yaml

​

Archive Formats

• ZIP: .zip
• RAR: .rar
• 7-Zip: .7z
• TAR: .tar, .tar.gz, .tgz
• GZIP: .gz

​

Code & Development

• Source code: .js, .py, .java, .cpp, .c, .h
• Web: .html, .css, .php
• Configuration: .conf, .ini, .env
• Database: .sql, .db

​

Other Formats

• eBooks: .epub, .mobi
• Fonts: .ttf, .otf
• Vector: .svg
• Any other file type (as generic document)

​

File Size Limits

• Maximum file size: 100MB
• Recommended: Under 20MB for reliable delivery
• Large files: May take longer to upload and download
• Network dependent: Delivery time varies by connection speed

​

Use Cases

​

Business Documents

curl -X POST http://localhost:3000/send/file \
  -H "X-Device-Id: my-device" \
  -F "[email protected]" \
  -F "caption=Invoice #12345 - Payment Due June 30" \
  -F "file=@invoices/invoice-12345.pdf"

​

Educational Materials

curl -X POST http://localhost:3000/send/file \
  -H "X-Device-Id: my-device" \
  -F "[email protected]" \
  -F "caption=Chapter 5 - Introduction to Programming" \
  -F "file=@courses/chapter5.pdf"

​

Technical Documentation

curl -X POST http://localhost:3000/send/file \
  -H "X-Device-Id: my-device" \
  -F "[email protected]" \
  -F "caption=API Documentation v2.0" \
  -F "file=@docs/api-docs-v2.pdf"

​

File Sharing & Collaboration

curl -X POST http://localhost:3000/send/file \
  -H "X-Device-Id: my-device" \
  -F "[email protected]" \
  -F "caption=Design mockups - please review and provide feedback" \
  -F "file=@designs/mockups-v3.zip"

​

Data Export & Backup

curl -X POST http://localhost:3000/send/file \
  -H "X-Device-Id: my-device" \
  -F "[email protected]" \
  -F "caption=Database backup - 2024-06-15" \
  -F "file=@backups/db-backup-20240615.sql.gz"

​

Best Practices

1. File Naming
   • Use descriptive, meaningful file names
   • Include version numbers or dates
   • Avoid special characters and spaces
   • Example: report-june-2024-v2.pdf
2. Captions
   • Always provide context with captions
   • Include version information
   • Mention important details or deadlines
   • Keep captions concise but informative
3. File Size Optimization
   • Compress large files before sending
   • Use ZIP for multiple files
   • Optimize PDFs (remove unnecessary elements)
   • Consider splitting very large files
4. Security & Privacy
   • Use disappearing messages for sensitive documents
   • Encrypt sensitive files before sending
   • Verify recipient before sending confidential data
   • Consider using password-protected archives
5. Delivery Confirmation
   • Store message_id for tracking
   • Implement delivery receipt handling via webhooks
   • Follow up with recipient to confirm receipt
   • Have fallback delivery methods for critical documents
6. File Format Selection
   • Use PDF for documents that shouldn’t be edited
   • Use DOCX/XLSX for collaborative editing
   • Use ZIP for multiple related files
   • Use TXT for simple text that should be easily readable

​

File Metadata

• File Name: Preserved from original file
• File Size: Displayed in KB/MB
• File Type: Icon based on extension
• Page Count: For PDF documents (if available)
• Duration: For audio/video files sent as documents

​

Limitations

1. No File Preview: Unlike images/videos, documents don’t show inline preview
2. Download Required: Recipients must download to view content
3. Size Restrictions: 100MB hard limit
4. No Streaming: Files must be fully downloaded before viewing
5. Format Support: Some file types may not open on all devices

​

Error Responses

​

Troubleshooting

​

File Upload Fails

1. Check file size (must be under 100MB)
2. Verify file is not corrupted
3. Check device connection status
4. Ensure sufficient server disk space
5. Try with a smaller file first

​

Long Upload Time

1. Large files take time - be patient
2. Check network connection speed
3. Consider compressing the file
4. Split large archives into smaller parts
5. Use a faster network connection

​

Recipient Can’t Open File

1. Verify recipient has compatible app
2. Check file format is supported on their device
3. Ensure file is not corrupted
4. Try re-sending the file
5. Convert to more common format (e.g., PDF)

​

Related Endpoints

• Send Image - Send image messages
• Send Video - Send video messages
• Send Audio - Send audio messages
• Download Media - Download files from messages