Aller au contenu
Esc
↑↓naviguer↵ouvrir⌘Japerçu

Get the account's claim status

BillionSend extension. Whether the account behind the key is still unclaimed, when it deletes itself, and what it may do meanwhile. Any key may ask; an account a person has claimed answers claimed with no limits.

GET/agent/status
Autorisation
AuthorizationJeton Bearer · headerrequis

A BillionSend API key (bs_…).

Réponses
200

The account's status

objectstringrequis
Valeurs autorisées :agent_account
statusstringrequis
Valeurs autorisées :unclaimedclaimed
claimobject | nullrequis

Set while the account is unclaimed

Afficher les propriétés
expires_atstringrequis
mails_leftintegerrequis

How many more times the claim link can be sent again

limitsobject | nullrequis

Set while the account is unclaimed

Afficher les propriétés
receive_onlybooleanrequis
inboxesintegerrequis
emails_per_dayintegerrequis
received_per_dayintegerrequis

Emails the account may receive per UTC day; past it the sender is told to retry

received_per_inbox_per_hourintegerrequis

Emails the inbox may receive per rolling hour; past it the sender is told to retry

401

Missing, malformed, unknown or revoked API key

statusCodenumberrequis
namestringrequis
messagestringrequis
429

Over the rate limit (rate_limit_exceeded, with Retry-After)

statusCodenumberrequis
namestringrequis
messagestringrequis
Essayer
Serveur
Autorisation
Requête
curl -X GET 'https://api.billionsend.com/agent/status' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Réponse
{
  "object": "agent_account",
  "status": "unclaimed",
  "claim": {
    "expires_at": "string",
    "mails_left": 0
  },
  "limits": {
    "receive_only": true,
    "inboxes": 0,
    "emails_per_day": 0,
    "received_per_day": 0,
    "received_per_inbox_per_hour": 0
  }
}

Cette page vous a-t-elle été utile ?