Pular para o conteúdo
Esc
↑↓navegar↵abrir⌘Jpré-visualizar

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
Autorização
AuthorizationToken Bearer · headerobrigatório

A BillionSend API key (bs_…).

Respostas
200

The account's status

objectstringobrigatório
Valores permitidos:agent_account
statusstringobrigatório
Valores permitidos:unclaimedclaimed
claimobject | nullobrigatório

Set while the account is unclaimed

Mostrar propriedades
expires_atstringobrigatório
mails_leftintegerobrigatório

How many more times the claim link can be sent again

limitsobject | nullobrigatório

Set while the account is unclaimed

Mostrar propriedades
receive_onlybooleanobrigatório
inboxesintegerobrigatório
emails_per_dayintegerobrigatório
received_per_dayintegerobrigatório

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

received_per_inbox_per_hourintegerobrigatório

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

401

Missing, malformed, unknown or revoked API key

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
429

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

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
Experimentar
Servidor
Autorização
Requisição
curl -X GET 'https://api.billionsend.com/agent/status' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Resposta
{
  "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
  }
}

Esta página foi útil?