Zum Inhalt springen
Esc
↑↓navigieren↵öffnen⌘Jvorschau

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
Autorisierung
AuthorizationBearer-Token · headererforderlich

A BillionSend API key (bs_…).

Antworten
200

The account's status

objectstringerforderlich
Erlaubt:agent_account
statusstringerforderlich
Erlaubt:unclaimedclaimed
claimobject | nullerforderlich

Set while the account is unclaimed

Eigenschaften anzeigen
expires_atstringerforderlich
mails_leftintegererforderlich

How many more times the claim link can be sent again

limitsobject | nullerforderlich

Set while the account is unclaimed

Eigenschaften anzeigen
receive_onlybooleanerforderlich
inboxesintegererforderlich
emails_per_dayintegererforderlich
received_per_dayintegererforderlich

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

received_per_inbox_per_hourintegererforderlich

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

401

Missing, malformed, unknown or revoked API key

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
429

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

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
Ausprobieren
Server
Autorisierung
Anfrage
curl -X GET 'https://api.billionsend.com/agent/status' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Antwort
{
  "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
  }
}

War diese Seite hilfreich?