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

Get latest code

BillionSend extension: the newest code or sign-in link in delivered mail, never from held mail or senders that failed authentication; links are never fetched. max_age counts from delivery, so a code released from quarantine counts from its release; since skips mail received at or before it, so a second sign-in waits for its own code. wait > 0 long-polls until one arrives (status timeout when none did). Always 200; status none when there is nothing.

GET/inboxes/{inbox_id}/codes/latest
Autorisierung
AuthorizationBearer-Token · headererforderlich

A BillionSend API key (bs_…).

Pfadparameter
inbox_idstringerforderlich

The inbox ID or its email address, such as support@example.com

Query-Parameter
fromstring

An exact sender address, or a domain covering itself and its subdomains

waitinteger

Seconds to wait for a code to arrive, 0-50 (default 0)

min. 0 · max. 50
max_ageinteger

How long ago the code may have reached the inbox, in seconds, 60-86400 (default 600); a released code counts from its release

min. 60 · max. 86400
sincestring<date-time>

Only mail received after this ISO 8601 instant, such as the received_at of a code already used

Antworten
200

The latest code, or a status saying why none

objectstringerforderlich
Erlaubt:verification_code
statusstringerforderlich
Erlaubt:foundnoneambiguoustimeout
kindstring | nullerforderlich
Erlaubt:otplinknull
codestring | nullerforderlich
urlstring | nullerforderlich
link_domain_matches_senderboolean | nullerforderlich
email_idstring<uuid> | nullerforderlich
fromstring | nullerforderlich
received_atstring | nullerforderlich
sender_truststring | nullerforderlich
Erlaubt:ownerallowlistedknown_threadexternalunauthenticatedfailednull
401

Missing, malformed, unknown or revoked API key

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
404

Not found

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
422

Validation error

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
429

Too many waits at once, or the rate limit (rate_limit_exceeded, with Retry-After)

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
Ausprobieren
Server
Autorisierung
Parameter
Anfrage
curl -X GET 'https://api.billionsend.com/inboxes/string/codes/latest' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Antwort
{
  "object": "verification_code",
  "status": "found",
  "kind": "otp",
  "code": "string",
  "url": "string",
  "link_domain_matches_sender": true,
  "email_id": "8e6bf5ae-e456-4654-87f8-33e2156caffc",
  "from": "string",
  "received_at": "string",
  "sender_trust": "owner"
}

War diese Seite hilfreich?