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

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
Autorisation
AuthorizationJeton Bearer · headerrequis

A BillionSend API key (bs_…).

Paramètres de chemin
inbox_idstringrequis

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

Paramètres de requête
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

Réponses
200

The latest code, or a status saying why none

objectstringrequis
Valeurs autorisées :verification_code
statusstringrequis
Valeurs autorisées :foundnoneambiguoustimeout
kindstring | nullrequis
Valeurs autorisées :otplinknull
codestring | nullrequis
urlstring | nullrequis
link_domain_matches_senderboolean | nullrequis
email_idstring<uuid> | nullrequis
fromstring | nullrequis
received_atstring | nullrequis
sender_truststring | nullrequis
Valeurs autorisées :ownerallowlistedknown_threadexternalunauthenticatedfailednull
401

Missing, malformed, unknown or revoked API key

statusCodenumberrequis
namestringrequis
messagestringrequis
404

Not found

statusCodenumberrequis
namestringrequis
messagestringrequis
422

Validation error

statusCodenumberrequis
namestringrequis
messagestringrequis
429

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

statusCodenumberrequis
namestringrequis
messagestringrequis
Essayer
Serveur
Autorisation
Paramètres
Requête
curl -X GET 'https://api.billionsend.com/inboxes/string/codes/latest' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Réponse
{
  "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"
}

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