Εισερχόμενα
Δημιουργήστε και διαχειριστείτε εισερχόμενα email για τους πράκτορες AI σας. Κάθε εισερχόμενο αποκτά μια μοναδική διεύθυνση email που μπορεί να στέλνει και να λαμβάνει μηνύματα.
Όλα τα requests API απαιτούν κεφαλίδα x-api-key. Αποκτήστε το κλειδί σας από τον πίνακα ελέγχου. Το base URL για όλα τα endpoints είναι https://api.agentsend.io.
Το Αντικείμενο Inbox
Όλα τα endpoints που επιστρέφουν inbox περιλαμβάνουν τα εξής πεδία.
| Πεδίο | Τύπος | Περιγραφή |
|---|---|---|
id |
uuid | Μοναδικό αναγνωριστικό για τα εισερχόμενα. |
address |
string | Η πλήρης διεύθυνση email που ανατίθεται σε αυτά τα εισερχόμενα, π.χ. a1b2c3@agentsend.io. |
displayName |
string | Αναγνώσιμο από άνθρωπο όνομα που εμφανίζεται στην κεφαλίδα From κατά την αποστολή email. |
domainId |
uuid | null | Το ID ενός επαληθευμένου προσαρμοσμένου τομέα ή null όταν χρησιμοποιείται ο κοινόχρηστος τομέας AgentSend. |
status |
string | Μία από τις: active, suspended ή deleted. |
dailySendLimit |
integer | Μέγιστος αριθμός μηνυμάτων που μπορούν να σταλούν από αυτό το inbox ανά ημερολογιακή ημέρα. |
sendsToday |
integer | Αριθμός μηνυμάτων που έχουν σταλεί σήμερα (μηδενίζει τα μεσάνυχτα UTC). |
totalSent |
integer | Αθροιστικός αριθμός όλων των μηνυμάτων που έχουν σταλεί από αυτό το inbox. |
bounceCount |
integer | Αριθμός hard bounces που έχουν καταγραφεί για αυτό το inbox. |
complaintCount |
integer | Αριθμός παραπόνων spam που έχουν καταγραφεί για αυτό το inbox. |
createdAt |
string (ISO 8601) | Χρονοσήμανση δημιουργίας του inbox. |
{
"id": "3a8f1c2d-4e5b-6f7a-8b9c-0d1e2f3a4b5c",
"address": "a1b2c3@agentsend.io",
"displayName": "Support Agent",
"domainId": null,
"status": "active",
"dailySendLimit": 500,
"sendsToday": 12,
"totalSent": 1847,
"bounceCount": 2,
"complaintCount": 0,
"createdAt": "2025-03-15T10:22:00Z"
}Δημιουργία inbox
Δημιουργεί νέο inbox και του αναθέτει μια διεύθυνση email. Αν δεν παρέχεται address, δημιουργείται τυχαία διεύθυνση στον κοινόχρηστο τομέα agentsend.io. Για χρήση προσαρμοσμένου τομέα, περάστε επαληθευμένο domainId.
Σώμα request
| Παράμετρος | Τύπος | Περιγραφή |
|---|---|---|
address |
string | Επιθυμητή διεύθυνση email (μόνο το local-part αν χρησιμοποιείτε προσαρμοσμένο τομέα ή πλήρης διεύθυνση). Προαιρετικό — δημιουργείται αυτόματα αν παραλειφθεί. |
displayName |
string | Φιλικό όνομα που εμφανίζεται στην κεφαλίδα From. Προαιρετικό. |
domainId |
uuid | ID επαληθευμένου προσαρμοσμένου τομέα που θα ανατεθεί σε αυτό το inbox. Προαιρετικό — προεπιλογή ο κοινόχρηστος τομέας AgentSend. |
Επιστρέφει
201 Created με το νέο δημιουργημένο αντικείμενο Inbox.
curl -X POST https://api.agentsend.io/inboxes \ -H "x-api-key: $AGENTSEND_API_KEY" \ -H "Content-Type: application/json" \ -d '{"displayName": "Support Agent"}'
const res = await fetch("https://api.agentsend.io/inboxes", { method: "POST", headers: { "x-api-key": process.env.AGENTSEND_API_KEY, "Content-Type": "application/json", }, body: JSON.stringify({ displayName: "Support Agent", }), }); const inbox = await res.json(); // 201 Created console.log(inbox.address); // "a1b2c3@agentsend.io"
{
"id": "3a8f1c2d-4e5b-6f7a-8b9c-0d1e2f3a4b5c",
"address": "a1b2c3@agentsend.io",
"displayName": "Support Agent",
"domainId": null,
"status": "active",
"dailySendLimit": 500,
"sendsToday": 0,
"totalSent": 0,
"bounceCount": 0,
"complaintCount": 0,
"createdAt": "2025-04-16T09:00:00Z"
}Λίστα inboxes
Επιστρέφει λίστα με σελιδοποίηση όλων των inboxes στον λογαριασμό σας, ταξινομημένων κατά ημερομηνία δημιουργίας (πιο πρόσφατα πρώτα).
Παράμετροι query
| Παράμετρος | Τύπος | Προεπιλογή | Περιγραφή |
|---|---|---|---|
limit |
integer | 20 |
Αριθμός inboxes προς επιστροφή. Μέγιστο 100. |
offset |
integer | 0 |
Αριθμός inboxes προς παράλειψη πριν την επιστροφή αποτελεσμάτων. Χρησιμοποιήστε με limit για σελιδοποίηση. |
Επιστρέφει
200 OK με paginated envelope που περιέχει πίνακα αντικειμένων Inbox.
curl https://api.agentsend.io/inboxes?limit=10&offset=0 \
-H "x-api-key: $AGENTSEND_API_KEY"const res = await fetch( "https://api.agentsend.io/inboxes?limit=10&offset=0", { headers: { "x-api-key": process.env.AGENTSEND_API_KEY } } ); const { data, total, limit, offset } = await res.json(); console.log(`Showing ${data.length} of ${total} inboxes`);
{
"data": [
{
"id": "3a8f1c2d-4e5b-6f7a-8b9c-0d1e2f3a4b5c",
"address": "a1b2c3@agentsend.io",
"displayName": "Support Agent",
"domainId": null,
"status": "active",
"dailySendLimit": 500,
"sendsToday": 12,
"totalSent": 1847,
"bounceCount": 2,
"complaintCount": 0,
"createdAt": "2025-03-15T10:22:00Z"
}
],
"total": 1,
"limit": 10,
"offset": 0
}Λήψη inbox
Ανακτά ένα inbox με το ID του, συμπεριλαμβανομένων live μετρητών αποστολής και metrics υγείας.
Παράμετροι διαδρομής
| Παράμετρος | Τύπος | Περιγραφή |
|---|---|---|
id απαιτείται |
uuid | Το ID του inbox προς ανάκτηση. |
Επιστρέφει
200 OK με το αντικείμενο Inbox. Επιστρέφει 404 Not Found αν το inbox δεν υπάρχει ή ανήκει σε διαφορετικό λογαριασμό.
curl https://api.agentsend.io/inboxes/3a8f1c2d-4e5b-6f7a-8b9c-0d1e2f3a4b5c \
-H "x-api-key: $AGENTSEND_API_KEY"const inboxId = "3a8f1c2d-4e5b-6f7a-8b9c-0d1e2f3a4b5c"; const inbox = await fetch( `https://api.agentsend.io/inboxes/${inboxId}`, { headers: { "x-api-key": process.env.AGENTSEND_API_KEY } } ).then(r => r.json()); console.log(inbox.status); // "active" console.log(inbox.sendsToday); // 12
{
"id": "3a8f1c2d-4e5b-6f7a-8b9c-0d1e2f3a4b5c",
"address": "a1b2c3@agentsend.io",
"displayName": "Support Agent",
"domainId": null,
"status": "active",
"dailySendLimit": 500,
"sendsToday": 12,
"totalSent": 1847,
"bounceCount": 2,
"complaintCount": 0,
"createdAt": "2025-03-15T10:22:00Z"
}Διαγραφή inbox
Διαγράφει μόνιμα ένα inbox και τη διεύθυνση email του. Όλα τα μηνύματα και νήματα που σχετίζονται με το inbox διαγράφονται επίσης. Αυτή η ενέργεια δεν μπορεί να αναιρεθεί.
Η διαγραφή inbox είναι μη αναστρέψιμη. Αν χρειάζεστε μόνο προσωρινή παύση αποστολής, εξετάστε το πεδίο status του inbox (επικοινωνήστε με την υποστήριξη για αναστολή inbox).
Παράμετροι διαδρομής
| Παράμετρος | Τύπος | Περιγραφή |
|---|---|---|
id απαιτείται |
uuid | Το ID του inbox προς διαγραφή. |
Επιστρέφει
204 No Content σε επιτυχία με κενό σώμα απάντησης. Επιστρέφει 404 Not Found αν το inbox δεν υπάρχει ή ανήκει σε διαφορετικό λογαριασμό.
curl -X DELETE https://api.agentsend.io/inboxes/3a8f1c2d-4e5b-6f7a-8b9c-0d1e2f3a4b5c \
-H "x-api-key: $AGENTSEND_API_KEY"const inboxId = "3a8f1c2d-4e5b-6f7a-8b9c-0d1e2f3a4b5c"; const res = await fetch( `https://api.agentsend.io/inboxes/${inboxId}`, { method: "DELETE", headers: { "x-api-key": process.env.AGENTSEND_API_KEY }, } ); // 204 No Content — no body to parse if (res.ok) console.log("Inbox deleted");