跳到内容
Esc
↑↓导航↵打开⌘J预览

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
授权
AuthorizationBearer 令牌 · header必填

A BillionSend API key (bs_…).

响应
200

The account's status

objectstring必填
允许值:agent_account
statusstring必填
允许值:unclaimedclaimed
claimobject | null必填

Set while the account is unclaimed

显示属性
expires_atstring必填
mails_leftinteger必填

How many more times the claim link can be sent again

limitsobject | null必填

Set while the account is unclaimed

显示属性
receive_onlyboolean必填
inboxesinteger必填
emails_per_dayinteger必填
received_per_dayinteger必填

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

received_per_inbox_per_hourinteger必填

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

401

Missing, malformed, unknown or revoked API key

statusCodenumber必填
namestring必填
messagestring必填
429

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

statusCodenumber必填
namestring必填
messagestring必填
试一试
服务器
授权
请求
curl -X GET 'https://api.billionsend.com/agent/status' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
响应
{
  "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
  }
}

这个页面有帮助吗?