Documentation › Outils › inbox_status
inbox_status
Point de départ : dit sur quel espace travaille cette clé, s’il est vérifié, ses limites sur le domaine commun, ses permissions, le créneau d’envoi, et pour chaque boîte (ou celle demandée) son état, son réchauffage, le quota du jour (envoyés / restants), les messages en file, les brouillons à valider et le prochain départ possible.
En bref
| Propriété | Valeur |
|---|---|
| Titre | État des boîtes et quotas |
| Outil MCP | inbox_status, sur https://api.subagent.fr/mcp |
| Appel HTTP | POST https://api.subagent.fr/v1/inbox_status |
| Accès | toute clé |
| État de l’espace | vérifié ou non |
| Effet | lecture seule |
| Vue dans l’assistant | oui : voir Vues |
Ce que fait l’outil
Le serveur décrit l’outil ainsi à l’agent qui se branche :
Point de départ : dit sur quel espace travaille cette clé, s’il est vérifié, ses limites sur le domaine commun, ses permissions, le créneau d’envoi, et pour chaque boîte (ou celle demandée) son état, son réchauffage, le quota du jour (envoyés / restants), les messages en file, les brouillons à valider et le prochain départ possible. À appeler avant d’envoyer, et quand un envoi tarde.
Paramètres
inbox_status accepte ces paramètres. Un paramètre inconnu est refusé avec le code invalid_argument.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
inbox_id | identifiant inb_… | non | Une boîte précise (inb_…). Absent : toutes les boîtes de la clé. |
Résultat
L’outil rend un texte lisible en français et un objet structuré (structuredContent). En HTTP, la réponse est cet objet.
| Champ | Type | Contenu |
|---|---|---|
billing | objet ou null | Où en est le paiement de l’espace : standing (exempt, unpaid, paid), plan, paid_until, subscription_status (none, pending, active, past_due, canceled), last_payment (none, pending, paid, failed). null : rien à payer sur ce serveur. |
human_email | texte ou null | L’adresse de l’humain de l’espace, masquée (m•••@societe.fr). null : aucun humain rattaché. |
inboxes | liste | Une liste : des boîtes. Voir les champs d’une boîte. |
key | objet | La clé qui appelle : name, permissions, daily_cap (son plafond de messages par jour, ou null). |
now | texte | Instant de cet état (ISO 8601, heure de Paris). |
require_approval | booléen | Tout envoi de l’espace attend une validation humaine. |
send_window | texte | Créneau d’envoi en clair. |
tenant | objet | L’espace de la clé : id, name, brand, et domains, les domaines où il peut créer une boîte. |
trial | objet ou null | Limites d’essai des boîtes du domaine commun : limit, used, window, next_limit, next_at. null : aucune. |
verified | booléen | L’espace est vérifié : il envoie. Sinon ses boîtes reçoivent seulement (verify). |
Exemple d’appel
Les valeurs sont fictives.
HTTP
curl -X POST https://api.subagent.fr/v1/inbox_status \
-H "Authorization: Bearer $SUBAGENT_KEY" \
-H "Content-Type: application/json" \
-d '{}'MCP · tools/call
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "inbox_status",
"arguments": {}
}
}Refus possibles
| Code | HTTP | Ce qui s’est passé | Que faire |
|---|---|---|---|
not_found | 404 | L’objet n’existe pas pour cette clé. | Vérifier l’identifiant : il vient de list_inboxes, list_threads, get_thread ou list_drafts. |
S’y ajoutent les refus communs à tous les outils (unauthorized, forbidden, invalid_argument, rate_limited, internal) : voir Erreurs.