Receber emails: Identidade

Whoami

Retorna a qual caixa de email esta credencial pertence e detalhes da própria credencial, sem ler nenhuma mensagem. Use para confirmar que uma credencial pertence a uma caixa específica.

POSThttps://g.sendcorex.com/v1command: whoami
i

Todos os campos de token, exceto type, só vêm quando a credencial é um token de caixa (mailbox_token). Tokens de acesso OAuth retornam só token.type.

Argumentos

Este endpoint não recebe argumentos.

Início rápido

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1',
  {
    commands: [
      {
        command: "whoami"
      }
    ]
  },
  { headers: { Authorization: process.env.SENDCOREX_TOKEN } },
);

const [result] = response.data.results;
if (result.type !== 'SUCCESS') throw new Error(`${result.code}: ${result.message}`);
console.log(result.data);

Resposta

{
  "type": "SUCCESS",
  "results": [
    {
      "command": "whoami",
      "id": "0",
      "type": "SUCCESS",
      "data": {
        "mailbox": {
          "email": "support@acme.com",
          "from_name": "Acme Support",
          "sender_ref": "snd_7Kq2Xr9P"
        },
        "token": {
          "type": "mailbox_token",
          "id": "mbt_3Fh8LwQ1",
          "name": "Helpdesk bot",
          "prefix": "scx_mb_4f9a",
          "created_at": "2026-10-02T09:14:00.000Z",
          "expires_at": null,
          "last_used_at": "2026-11-19T00:31:12.000Z"
        }
      }
    }
  ]
}

Campos da resposta

  • mailbox.email

    O endereço da caixa a que esta credencial pertence.

  • mailbox.from_name

    O nome exibido ao enviar desta caixa.

  • mailbox.sender_ref

    A referência do perfil de remetente desta caixa.

  • token.type

    mailbox_token para um token de caixa, oauth para um token de acesso OAuth.

  • token.id

    O ID do token. Só para mailbox_token.

  • token.name

    O nome dado ao token. Só para mailbox_token.

  • token.prefix

    Os primeiros caracteres do token, como aparecem no painel. Só para mailbox_token.

  • token.created_at

    Quando o token foi criado. Só para mailbox_token.

  • token.expires_at

    Quando o token expira, ou null se não expira. Só para mailbox_token.

  • token.last_used_at

    A última vez que o token foi usado, ou null. Só para mailbox_token.

Erros

Erros no nível HTTP retornam type, code e message. Erros marcados com CMD voltam dentro do resultado do comando, com HTTP 200.

  • 401TOKEN_EXPIRED

    O access token expirou. Chame Refresh Token e repita a requisição.

  • 401INVALID_TOKEN

    O token está malformado, é desconhecido ou foi revogado.

  • 429RATE_LIMITED

    Mais de 15 requisições/s ou 15 em andamento para o mesmo IP + caixa de correio. Espere o número de segundos indicado em Retry-After.

  • CMDINTERNAL

    Erro no servidor. O detalhe só é gravado no log do servidor.