Menerima Email: Lampiran

Unggah file besar

Unggah file hingga 25 MB sebagai data biner, di luar JSON 1 MB pada POST /v1. Mengembalikan compose_uid dan id lampiran yang sama seperti upload_attachment.

POSThttps://g.sendcorex.com/v1/attachment
i

Gunakan rute ini untuk file di atas sekitar 700 KB. Di upload_attachment file dikirim dalam base64 di dalam JSON, yang dibatasi 1 MB, dan base64 membuat file sekitar 33% lebih besar.

i

Lalu kirim compose_uid (dan opsional attachment_ids) di send_email, reply, forward, schedule_send, atau save_draft. Kirim compose_uid yang sama lagi untuk menambahkan file lain ke email yang sama.

!

Unggahan yang tidak dikirim dalam 48 jam, dan tidak dipakai oleh draf atau email terjadwal mana pun, akan dihapus. Unggah file lagi jika Anda menerima ATTACHMENT_MISSING.

Query parameter

  • file_namestringwajib

    Nama file yang ditampilkan ke penerima. Wajib dengan body biner; dengan multipart, nama bagian file yang dipakai.

  • compose_uidstringopsional

    Tambahkan file ke email yang sedang Anda susun. Dengan multipart, ini juga bisa berupa field formulir.

Mulai cepat

import axios from 'axios';
import { readFileSync } from 'node:fs';

const res = await axios.post('https://g.sendcorex.com/v1/attachment', readFileSync('invoice.pdf'), {
  params: { file_name: 'invoice.pdf' },
  headers: {
    Authorization: process.env.SENDCOREX_TOKEN,
    'Content-Type': 'application/pdf',
  },
  maxBodyLength: Infinity,
});

const { compose_uid, attachment } = res.data.data;
console.log(compose_uid, attachment.id);

Respons

{
  "type": "SUCCESS",
  "data": {
    "compose_uid": "Vj0xQ01QMDAx",
    "attachment": {
      "id": "6f1c2a9e-4b7d-4e21-9a3f-0c8d5e7b1a42",
      "file_name": "invoice.pdf",
      "size_bytes": 3145728,
      "content_type": "application/pdf"
    }
  }
}

Field respons

  • data.compose_uid

    Kirim bersama unggahan berikutnya untuk email yang sama dan bersama perintah kirim.

  • data.attachment.id

    Gunakan di attachment_ids atau delete_attachment.

Body request

Kirim file dengan salah satu dari dua cara. Satu file per request.

  • Biner

    Body adalah file itu sendiri. Atur Content-Type ke tipe file (misalnya application/pdf); tanpa itu, file disimpan sebagai application/octet-stream.

  • Multipart

    multipart/form-data dengan file di field file. Field opsional: compose_uid dan file_name.

Batas

  • Per file

    25 MB.

  • Per email

    20 file dan total 25 MB.

  • Per kotak surat

    50 email dengan unggahan yang belum dikirim, dan total 500 MB. Mengirim email langsung membebaskan bagiannya.

  • Unggahan tak terpakai

    Dihapus setelah 48 jam jika tidak dipakai oleh draf atau email terjadwal. File milik draf atau email terjadwal tetap ada selama draf atau email itu ada.

Error

Error di level HTTP mengembalikan type, code, dan message. Error yang ditandai CMD dikembalikan di dalam hasil perintah, dengan HTTP 200.

  • 401TOKEN_EXPIRED

    Access token sudah kedaluwarsa. Panggil Refresh Token lalu ulangi request.

  • 401INVALID_TOKEN

    Token salah format, tidak dikenal, atau dicabut.

  • 429RATE_LIMITED

    Lebih dari 15 request/detik atau 15 yang sedang diproses untuk IP + kotak surat yang sama. Tunggu sesuai jumlah detik di Retry-After.

  • 400INVALID_ARGS

    `file_name` tidak ada (body biner), multipart tidak memiliki field `file` atau memiliki lebih dari satu, atau `compose_uid` tidak valid.

  • 400INVALID_ATTACHMENT

    File kosong atau tidak bisa dibaca.

  • 400FILE_BLOCKED

    File diblokir oleh pemindaian keamanan.

  • 400ALREADY_SENT

    `compose_uid` milik email yang sudah terkirim.

  • 400TOO_MANY_OPEN_COMPOSES

    Kotak surat memiliki 50 email dengan unggahan yang belum dikirim. Kirim email tersebut, atau tunggu yang tidak terpakai dihapus setelah 48 jam.

  • 413ATTACHMENTS_TOO_LARGE

    File lebih dari 25 MB, email melebihi 25 MB, atau kotak surat sudah memiliki 500 MB unggahan yang menunggu dikirim.

  • CMDINTERNAL

    Error server. Detailnya hanya ditulis ke log server.