Documentação da API do TempMail

REST API v1 e Webhooks

TempMailg Documentação da API do Desenvolvedor

Use esta documentação para gerar sua chave de API pessoal, conectar o host de API de usuário dedicado, ler mensagens da caixa de correio, gerenciar caixas de correio de propriedade e integrar o TempMail aos seus próprios aplicativos ou automações.

Autenticação de Token Bearer Webhooks em tempo real Aliases do Gmail e Outlook Respostas JSON
URL Base da API do Usuário HTTPS
Formato da solicitação Use sua chave de API apenas no cabeçalho de autorização Bearer e mantenha as URLs de endpoint limpas.

Gerenciamento de Caixa de Correio

Buscar domínios permitidos, criar ou alternar caixas de correio, escolher períodos de vida permitidos e excluir endereços próprios.

GET https://v1.tempmailg.com/api/domains?type={type}
#

Listar domínios permitidos

Liste os domínios disponíveis para criar e‑mails temporários. Filtre por tipo para ver apenas domínios gratuitos, premium ou personalizados suportados pelo seu plano de assinatura.

Parâmetros 1
Parâmetro Localização Tipo Status Descrição
type query string opcional
Filtro de nível de domínio. Omissão usa todos quando o acesso premium-domain está habilitado, caso contrário gratuito. Valores reconhecidos: free, basic, pro, premium, custom, ultimate, all
Padrão: Dependente da conta
Obter domínios permitidos
curl --request GET \
  --url 'https://v1.tempmailg.com/api/domains?type=free' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Resposta ilustrativa usando dados sintéticos. IDs, endereços, tokens, timestamps, limites e contagens do plano variam. As durações de exemplo não substituem o padrão do seu plano. As descrições dos campos de resposta identificam campos anuláveis e específicos do provedor.

Exemplo de resposta
200 OK • JSON
{
    "status": true,
    "data": {
        "requested_type": "free",
        "plan": "pro",
        "plan_name": "Pro Plan",
        "allowed_types": [
            "free",
            "basic",
            "pro",
            "premium",
            "custom",
            "ultimate",
            "all"
        ],
        "domains": [
            {
                "domain": "example.com",
                "type": "Free",
                "custom": false
            }
        ]
    }
}
Campos de resposta
Campo Tipo Descrição
status boolean
Se a operação foi bem-sucedida.
data.requested_type string
Filtro de domínio aplicado.
data.plan string
Etiqueta do plano atual.
data.plan_name string
Nome legível do plano atual.
data.allowed_types array<string>
Filtros de domínio disponíveis para esta conta. Um filtro reconhecido ainda pode ser proibido para o seu plano.
data.domains array
Domínios selecionáveis após filtragem; um array vazio é válido.
data.domains[].domain string
Nome de domínio selecionável.
data.domains[].type string
Rótulo de nível de domínio legível.
data.domains[].custom boolean
Se este é um domínio personalizado.
POST https://v1.tempmailg.com/api/emails
#

Criar caixa de correio temporária

Crie uma caixa de correio temporária própria. Omitir nome de usuário e domínio para geração aleatória, ou fornecer um nome de usuário personalizado permitido e um domínio permitido. O parâmetro provider pode selecionar a geração de alias Gmail ou Outlook.

Parâmetros 8
Parâmetro Localização Tipo Status Descrição
username body string opcional
Nome de usuário personalizado opcional: de 2 a 64 caracteres ASCII, incluindo letras, dígitos, pontos, sublinhados ou hífens. Requer permissão do plano; custom_username também é aceito.
Padrão: Gerado aleatoriamente
domain body string opcional
Um dos domínios permitidos retornados por GET /domains. A omissão escolhe um domínio permitido aleatório.
Padrão: Domínio permitido aleatório
lifetime body string opcional
valores permitidos:
10m — 10 Minutos 1h — 1 Hora 2h — 2 Horas 1d — 1 Dia 1w — 1 Semana 1m — 30 Dias 3m — 90 dias 6m — 180 Dias 1y — 365 Dias unlimited — Ilimitado
Padrão: Tempo de vida padrão do plano
provider body string opcional
Provedor de caixa de correio: standard, gmail_alias, ou outlook_alias.
Padrão: standard
pin_enabled body boolean opcional
Proteção opcional por PIN para a nova caixa de correio, quando permitida pelo seu plano. Não altera o PIN de uma caixa de correio existente.
Padrão: false
pin body string opcional
Obrigatório quando pin_enabled for true: um PIN de 6 a 8 dígitos, enviado como string para preservar zeros à esquerda.
pin_confirmation body string opcional
Obrigatório quando pin_enabled for verdadeiro. Deve corresponder exatamente ao pin.
Idempotency-Key header string opcional
Necessário para criação ou exclusão protegida por PIN: uma chave estável de 16 a 128 caracteres. Refaça a mesma solicitação com a mesma chave para evitar trabalho duplicado.
Parâmetros de corpo opcionais: username (nome de usuário personalizado se permitido pelo plano), domain (domínio permitido, ex. example.com), lifetime (valores permitidos: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited), provider (standard, gmail_alias, outlook_alias). Omitir o tempo de vida, ou deixá-lo vazio, para usar o Tempo de Vida de Email Padrão configurado para o seu plano mensal/anual atual. Envie um tempo de vida permitido, como 1h, para substituir esse padrão. Ilimitado é usado somente quando configurado como padrão do plano ou explicitamente solicitado e permitido. Os parâmetros de corpo mailbox_lifetime e email_lifetime também são aceitos; o primeiro valor não vazio tem prioridade nesta ordem: lifetime, mailbox_lifetime, email_lifetime. Valores inválidos ou não permitidos retornam HTTP 422 em vez de selecionar silenciosamente um padrão.
Criar caixa de correio
curl --request POST \
  --url 'https://v1.tempmailg.com/api/emails' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Resposta ilustrativa usando dados sintéticos. IDs, endereços, tokens, timestamps, limites e contagens do plano variam. As durações de exemplo não substituem o padrão do seu plano. As descrições dos campos de resposta identificam campos anuláveis e específicos do provedor.

Exemplo de resposta
200 OK • JSON
{
    "status": true,
    "data": {
        "id": 2301,
        "pin_protected": false,
        "email": "demo123@example.com",
        "domain": "example.com",
        "provider": "standard",
        "expire_at": "2026-11-20T02:17:59+00:00",
        "expires_in_seconds": 86399.75,
        "mailbox_state": "active",
        "receiving_enabled": true,
        "message_count": 0,
        "unread_message_count": 0,
        "last_message_received_at": null,
        "message_count_synced_at": null,
        "created_at": "2026-11-19T02:17:59+00:00",
        "email_token": "encrypted-email-token"
    }
}
Campos de resposta
Campo Tipo Descrição
status boolean
Se a operação foi bem-sucedida.
data.id integer
ID da caixa de correio. IDs, endereços e tokens gerados diferem para cada caixa de correio.
data.pin_protected boolean
Se esta caixa de correio tem proteção por PIN. Nenhum PIN ou hash de PIN é retornado.
data.email string
Endereço completo da caixa de correio gerado.
data.domain string
Domínio da caixa de correio gerada.
data.provider string
Provedor de caixa de correio: standard, gmail_alias, ou outlook_alias.
data.expire_at string|null
Expiração efetiva como um timestamp ISO-8601, ou null para uma caixa de correio ilimitada.
data.expires_in_seconds number|null
Segundos restantes não negativos quando calculado; segundos fracionários são possíveis. Null significa ilimitado, não zero.
data.mailbox_state string
Estado atual da caixa de correio: ativo, pausado, expirado ou inativo.
data.receiving_enabled boolean
Se esta caixa de correio aceita mensagens recebidas atualmente.
data.message_count integer
Contagem total de mensagens conhecida; pode refletir a última sincronização da caixa de correio.
data.unread_message_count integer
Contagem conhecida de mensagens não lidas; pode refletir a última sincronização da caixa de correio.
data.last_message_received_at string|null
Último horário conhecido de mensagem recebida no formato ISO-8601, ou null quando indisponível.
data.message_count_synced_at string|null
Última hora de sincronização da contagem de mensagens no formato ISO-8601, ou null antes da sincronização.
data.created_at string|null
Hora de criação da caixa de correio no formato ISO-8601.
data.email_token string
Referência de caixa de correio criptografada opaca. Não substitui a autenticação Bearer, verificações de propriedade ou autorização por PIN.
data.pin_grant object
Condicional: a criação de caixa de correio protegida por PIN ativo retorna esta concessão de leitura; a criação comum sem proteção a omite.
data.pin_grant.mailbox_id integer
ID da caixa de correio ao qual a concessão de leitura condicional está vinculada.
data.pin_grant.unlock_token string
Token de leitura opaco para X-Mailbox-Unlock com a mesma credencial do proprietário. Mantenha-o privado e em memória; uma concessão de leitura não autoriza a exclusão.
data.pin_grant.scope string
O escopo lido para a concessão de criação condicional.
data.pin_grant.idle_timeout_seconds integer
Tempo ocioso permitido para a concessão de leitura, normalmente 3600 segundos.
data.pin_grant.absolute_timeout_seconds integer
Tempo máximo de vida da concessão de leitura, normalmente 86400 segundos.
data.pin_grant.expires_at string
Expiração atual da concessão de leitura no formato ISO-8601.
data.pin_grant.absolute_expires_at string
Data de expiração absoluta da concessão de leitura no formato ISO-8601. Alterações de segurança podem revogar a concessão mais cedo.
POST https://v1.tempmailg.com/api/emails/{email}/{username}/{domain}
#

Atualizar / Trocar Caixa de Correio

Crie ou selecione uma caixa de correio no novo nome de usuário e domínio após verificar a propriedade da caixa de correio atual. Isso não renomeia a caixa de correio antiga nem altera sua duração no local. Quando o destino difere, a caixa de correio antiga permanece no histórico e pode ser pausada pelos limites de caixas de correio ativas. Reutilizar seu próprio destino ativo reaplica sua duração solicitada ou o padrão do plano.

Parâmetros 9
Parâmetro Localização Tipo Status Descrição
email path string obrigatório
Endereço de e‑mail completo atual da caixa de correio de propriedade a ser trocado. URL-encode cada segmento de caminho; codifique um sinal de mais como %2B.
username path string obrigatório
Novo nome de usuário desejado: de 2 a 64 caracteres alfanuméricos; sujeito à permissão de nome de usuário personalizado.
domain path string obrigatório
Novo nome de domínio permitido.
lifetime body string opcional
valores permitidos:
10m — 10 Minutos 1h — 1 Hora 2h — 2 Horas 1d — 1 Dia 1w — 1 Semana 1m — 30 Dias 3m — 90 dias 6m — 180 Dias 1y — 365 Dias unlimited — Ilimitado
Padrão: Tempo de vida padrão do plano
pin_enabled body boolean opcional
Proteção opcional por PIN para a nova caixa de correio, quando permitida pelo seu plano. Não altera o PIN de uma caixa de correio existente.
Padrão: false
pin body string opcional
Obrigatório quando pin_enabled for true: um PIN de 6 a 8 dígitos, enviado como string para preservar zeros à esquerda.
pin_confirmation body string opcional
Obrigatório quando pin_enabled for verdadeiro. Deve corresponder exatamente ao pin.
Idempotency-Key header string opcional
Necessário para criação ou exclusão protegida por PIN: uma chave estável de 16 a 128 caracteres. Refaça a mesma solicitação com a mesma chave para evitar trabalho duplicado.
X-Mailbox-Unlock header string opcional
Cabeçalho, apenas caixas de correio protegidas: use um unlock_token de leitura. Primeiro faça POST de pin e scope=read para a URL de desbloqueio de PIN. Mantenha sua autenticação Bearer normal. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
Usar um endereço de e-mail existente de propriedade em {email}. Parâmetro opcional do corpo: lifetime (valores permitidos: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). Omitir o tempo de vida, ou deixá-lo vazio, para usar o Tempo de Vida de Email Padrão configurado para o seu plano mensal/anual atual. Envie um tempo de vida permitido, como 1h, para substituir esse padrão. Ilimitado é usado somente quando configurado como padrão do plano ou explicitamente solicitado e permitido. Os parâmetros de corpo mailbox_lifetime e email_lifetime também são aceitos; o primeiro valor não vazio tem prioridade nesta ordem: lifetime, mailbox_lifetime, email_lifetime. Valores inválidos ou não permitidos retornam HTTP 422 em vez de selecionar silenciosamente um padrão.
Atualizar caixa de correio de propriedade
curl --request POST \
  --url 'https://v1.tempmailg.com/api/emails/current@example.com/demo123/example.com' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Resposta ilustrativa usando dados sintéticos. IDs, endereços, tokens, timestamps, limites e contagens do plano variam. As durações de exemplo não substituem o padrão do seu plano. As descrições dos campos de resposta identificam campos anuláveis e específicos do provedor.

Exemplo de resposta
200 OK • JSON
{
    "status": true,
    "data": {
        "id": 2302,
        "pin_protected": false,
        "email": "demo123@example.com",
        "domain": "example.com",
        "provider": "standard",
        "expire_at": "2026-11-19T02:27:59+00:00",
        "expires_in_seconds": 599.75,
        "mailbox_state": "active",
        "receiving_enabled": true,
        "message_count": 0,
        "unread_message_count": 0,
        "last_message_received_at": null,
        "message_count_synced_at": null,
        "created_at": "2026-11-19T02:17:59+00:00",
        "email_token": "encrypted-email-token"
    }
}
Campos de resposta
Campo Tipo Descrição
status boolean
Se a operação foi bem-sucedida.
data.id integer
ID da caixa de correio. IDs, endereços e tokens gerados diferem para cada caixa de correio.
data.pin_protected boolean
Se esta caixa de correio tem proteção por PIN. Nenhum PIN ou hash de PIN é retornado.
data.email string
Endereço completo da caixa de correio gerado.
data.domain string
Domínio da caixa de correio gerada.
data.provider string
Provedor de caixa de correio: standard, gmail_alias, ou outlook_alias.
data.expire_at string|null
Expiração efetiva como um timestamp ISO-8601, ou null para uma caixa de correio ilimitada.
data.expires_in_seconds number|null
Segundos restantes não negativos quando calculado; segundos fracionários são possíveis. Null significa ilimitado, não zero.
data.mailbox_state string
Estado atual da caixa de correio: ativo, pausado, expirado ou inativo.
data.receiving_enabled boolean
Se esta caixa de correio aceita mensagens recebidas atualmente.
data.message_count integer
Contagem total de mensagens conhecida; pode refletir a última sincronização da caixa de correio.
data.unread_message_count integer
Contagem conhecida de mensagens não lidas; pode refletir a última sincronização da caixa de correio.
data.last_message_received_at string|null
Último horário conhecido de mensagem recebida no formato ISO-8601, ou null quando indisponível.
data.message_count_synced_at string|null
Última hora de sincronização da contagem de mensagens no formato ISO-8601, ou null antes da sincronização.
data.created_at string|null
Hora de criação da caixa de correio no formato ISO-8601.
data.email_token string
Referência de caixa de correio criptografada opaca. Não substitui a autenticação Bearer, verificações de propriedade ou autorização por PIN.
data.pin_grant object
Condicional: a criação de caixa de correio protegida por PIN ativo retorna esta concessão de leitura; a criação comum sem proteção a omite.
data.pin_grant.mailbox_id integer
ID da caixa de correio ao qual a concessão de leitura condicional está vinculada.
data.pin_grant.unlock_token string
Token de leitura opaco para X-Mailbox-Unlock com a mesma credencial do proprietário. Mantenha-o privado e em memória; uma concessão de leitura não autoriza a exclusão.
data.pin_grant.scope string
O escopo lido para a concessão de criação condicional.
data.pin_grant.idle_timeout_seconds integer
Tempo ocioso permitido para a concessão de leitura, normalmente 3600 segundos.
data.pin_grant.absolute_timeout_seconds integer
Tempo máximo de vida da concessão de leitura, normalmente 86400 segundos.
data.pin_grant.expires_at string
Expiração atual da concessão de leitura no formato ISO-8601.
data.pin_grant.absolute_expires_at string
Data de expiração absoluta da concessão de leitura no formato ISO-8601. Alterações de segurança podem revogar a concessão mais cedo.
DELETE https://v1.tempmailg.com/api/emails/{email}
#

Excluir caixa de correio

Exclua uma caixa de correio de propriedade e invoque a limpeza de suas mensagens e arquivos. Registros de caixa de correio retidos podem ser excluídos suavemente internamente; o endereço não está mais utilizável através da API.

Parâmetros 3
Parâmetro Localização Tipo Status Descrição
email path string obrigatório
Endereço de e‑mail completo da caixa de correio proprietária a ser excluída. Codifique o endereço em URL; codifique o sinal de mais como %2B.
X-Mailbox-Unlock header string opcional
Cabeçalho, apenas caixas de correio protegidas: use o unlock_token de exclusão de uso único. Primeiro POST pin, scope=delete e o action/target_id retornado pela resposta 423 para a PIN unlock URL. Um token de leitura não pode excluir. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
Idempotency-Key header string opcional
Necessário para criação ou exclusão protegida por PIN: uma chave estável de 16 a 128 caracteres. Refaça a mesma solicitação com a mesma chave para evitar trabalho duplicado.
Excluir caixa de correio de propriedade
curl --request DELETE \
  --url 'https://v1.tempmailg.com/api/emails/demo123@example.com' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Resposta ilustrativa usando dados sintéticos. IDs, endereços, tokens, timestamps, limites e contagens do plano variam. As durações de exemplo não substituem o padrão do seu plano. As descrições dos campos de resposta identificam campos anuláveis e específicos do provedor.

Exemplo de resposta
200 OK • JSON
{
    "status": true,
    "message": "Email has been successfully deleted."
}
Campos de resposta
Campo Tipo Descrição
status boolean
Se a operação foi bem-sucedida.
message string
Resultado da exclusão. Um recurso ausente retorna HTTP 404.

Aliases do Gmail e Outlook

Gerar caixas de correio de alias Gmail e Outlook/Hotmail de alta reputação.

POST https://v1.tempmailg.com/api/gmail-alias/emails
#

Criar alias do Gmail

Crie uma nova caixa de correio temporária de alias do Gmail, de propriedade do usuário autenticado.

Parâmetros 8
Parâmetro Localização Tipo Status Descrição
mode body string opcional
Modo de geração: auto, dot, plus ou plus_dot. Também aceita gmail_alias_mode. Se a seleção de estilo não for permitida, auto será usado.
Padrão: auto
username body string opcional
Sufixo de alias personalizado opcional: de 2 a 32 letras ou dígitos ASCII, normalizado para minúsculas; sujeito a permissão de recurso. Também aceita custom_username ou alias_username.
Padrão: Gerado automaticamente
domain body string opcional
Use aleatório, gmail.com ou googlemail.com; alias_domain também é aceito. Omissão ou permissão de seleção de domínio indisponível usa aleatório.
Padrão: random
lifetime body string opcional
valores permitidos:
10m — 10 Minutos 1h — 1 Hora 2h — 2 Horas 1d — 1 Dia 1w — 1 Semana 1m — 30 Dias 3m — 90 dias 6m — 180 Dias 1y — 365 Dias unlimited — Ilimitado
Padrão: Tempo de vida padrão do plano
pin_enabled body boolean opcional
Proteção opcional por PIN para a nova caixa de correio, quando permitida pelo seu plano. Não altera o PIN de uma caixa de correio existente.
Padrão: false
pin body string opcional
Obrigatório quando pin_enabled for true: um PIN de 6 a 8 dígitos, enviado como string para preservar zeros à esquerda.
pin_confirmation body string opcional
Obrigatório quando pin_enabled for verdadeiro. Deve corresponder exatamente ao pin.
Idempotency-Key header string opcional
Necessário para criação ou exclusão protegida por PIN: uma chave estável de 16 a 128 caracteres. Refaça a mesma solicitação com a mesma chave para evitar trabalho duplicado.
Requer que a permissão Gmail Alias API esteja habilitada no seu plano de assinatura ou desbloqueada via um pacote de Créditos de API. Parâmetros opcionais: mode (auto, dot, plus, plus_dot), username (nome de usuário de alias personalizado), domain (ex.: gmail.com, googlemail.com), lifetime (valores permitidos: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). Omitir o tempo de vida, ou deixá-lo vazio, para usar o Tempo de Vida de Email Padrão configurado para o seu plano mensal/anual atual. Envie um tempo de vida permitido, como 1h, para substituir esse padrão. Ilimitado é usado somente quando configurado como padrão do plano ou explicitamente solicitado e permitido. Os parâmetros de corpo mailbox_lifetime e email_lifetime também são aceitos; o primeiro valor não vazio tem prioridade nesta ordem: lifetime, mailbox_lifetime, email_lifetime. Valores inválidos ou não permitidos retornam HTTP 422 em vez de selecionar silenciosamente um padrão.
Criar caixa de correio de alias do Gmail
curl --request POST \
  --url 'https://v1.tempmailg.com/api/gmail-alias/emails' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Resposta ilustrativa usando dados sintéticos. IDs, endereços, tokens, timestamps, limites e contagens do plano variam. As durações de exemplo não substituem o padrão do seu plano. As descrições dos campos de resposta identificam campos anuláveis e específicos do provedor.

Exemplo de resposta
200 OK • JSON
{
    "status": true,
    "data": {
        "id": 2305,
        "pin_protected": false,
        "email": "example+alias123@gmail.com",
        "domain": "gmail.com",
        "provider": "gmail_alias",
        "expire_at": "2026-11-19T03:17:59+00:00",
        "expires_in_seconds": 3599.75,
        "mailbox_state": "active",
        "receiving_enabled": true,
        "message_count": 0,
        "unread_message_count": 0,
        "last_message_received_at": null,
        "message_count_synced_at": null,
        "created_at": "2026-11-19T02:17:59+00:00",
        "email_token": "encrypted-email-token"
    }
}
Campos de resposta
Campo Tipo Descrição
status boolean
Se a operação foi bem-sucedida.
data.id integer
ID da caixa de correio. IDs, endereços e tokens gerados diferem para cada caixa de correio.
data.pin_protected boolean
Se esta caixa de correio tem proteção por PIN. Nenhum PIN ou hash de PIN é retornado.
data.email string
Endereço completo da caixa de correio gerado.
data.domain string
Domínio da caixa de correio gerada.
data.provider string
Provedor de caixa de correio: standard, gmail_alias, ou outlook_alias.
data.expire_at string|null
Expiração efetiva como um timestamp ISO-8601, ou null para uma caixa de correio ilimitada.
data.expires_in_seconds number|null
Segundos restantes não negativos quando calculado; segundos fracionários são possíveis. Null significa ilimitado, não zero.
data.mailbox_state string
Estado atual da caixa de correio: ativo, pausado, expirado ou inativo.
data.receiving_enabled boolean
Se esta caixa de correio aceita mensagens recebidas atualmente.
data.message_count integer
Contagem total de mensagens conhecida; pode refletir a última sincronização da caixa de correio.
data.unread_message_count integer
Contagem conhecida de mensagens não lidas; pode refletir a última sincronização da caixa de correio.
data.last_message_received_at string|null
Último horário conhecido de mensagem recebida no formato ISO-8601, ou null quando indisponível.
data.message_count_synced_at string|null
Última hora de sincronização da contagem de mensagens no formato ISO-8601, ou null antes da sincronização.
data.created_at string|null
Hora de criação da caixa de correio no formato ISO-8601.
data.email_token string
Referência de caixa de correio criptografada opaca. Não substitui a autenticação Bearer, verificações de propriedade ou autorização por PIN.
data.pin_grant object
Condicional: a criação de caixa de correio protegida por PIN ativo retorna esta concessão de leitura; a criação comum sem proteção a omite.
data.pin_grant.mailbox_id integer
ID da caixa de correio ao qual a concessão de leitura condicional está vinculada.
data.pin_grant.unlock_token string
Token de leitura opaco para X-Mailbox-Unlock com a mesma credencial do proprietário. Mantenha-o privado e em memória; uma concessão de leitura não autoriza a exclusão.
data.pin_grant.scope string
O escopo lido para a concessão de criação condicional.
data.pin_grant.idle_timeout_seconds integer
Tempo ocioso permitido para a concessão de leitura, normalmente 3600 segundos.
data.pin_grant.absolute_timeout_seconds integer
Tempo máximo de vida da concessão de leitura, normalmente 86400 segundos.
data.pin_grant.expires_at string
Expiração atual da concessão de leitura no formato ISO-8601.
data.pin_grant.absolute_expires_at string
Data de expiração absoluta da concessão de leitura no formato ISO-8601. Alterações de segurança podem revogar a concessão mais cedo.
GET https://v1.tempmailg.com/api/outlook-alias/domains
#

Domínios de Alias do Outlook

Buscar domínios de alias do Outlook / Hotmail ativos disponíveis para geração de caixa de correio.

Requer que a permissão da API Outlook Alias esteja habilitada no seu plano de assinatura ou desbloqueada via um pacote de Créditos de API. Indica se a seleção de domínio específico está desbloqueada no seu plano.
Obter domínios de alias do Outlook
curl --request GET \
  --url 'https://v1.tempmailg.com/api/outlook-alias/domains' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Resposta ilustrativa usando dados sintéticos. IDs, endereços, tokens, timestamps, limites e contagens do plano variam. As durações de exemplo não substituem o padrão do seu plano. As descrições dos campos de resposta identificam campos anuláveis e específicos do provedor.

Exemplo de resposta
200 OK • JSON
{
    "status": true,
    "data": {
        "domains": [
            {
                "domain": "outlook.com",
                "type": "Outlook/Hotmail",
                "selectable": true,
                "locked": false,
                "disabled_reason": null
            },
            {
                "domain": "hotmail.com",
                "type": "Outlook/Hotmail",
                "selectable": true,
                "locked": false,
                "disabled_reason": null
            }
        ]
    }
}
Campos de resposta
Campo Tipo Descrição
status boolean
Se a operação foi bem-sucedida.
data.domains array
Domínios Outlook/Hotmail ativos; um array vazio é válido.
data.domains[].domain string
Nome de domínio disponível.
data.domains[].type string
Rótulo legível do provedor.
data.domains[].selectable boolean
Se a sua conta pode escolher explicitamente este domínio.
data.domains[].locked boolean
Se a seleção explícita de domínio está bloqueada para sua conta.
data.domains[].disabled_reason string|null
Motivo pelo qual a seleção de domínio está bloqueada, ou nulo quando selecionável.
POST https://v1.tempmailg.com/api/outlook-alias/emails
#

Criar alias do Outlook

Crie uma nova caixa de correio temporária de alias do Outlook / Hotmail de propriedade do usuário autenticado.

Parâmetros 7
Parâmetro Localização Tipo Status Descrição
domain body string opcional
Use aleatório ou um domínio de GET /outlook-alias/domains; outlook_alias_domain também é aceito. Sem permissão de seleção, aleatório é usado.
Padrão: Domínio disponível aleatório
username body string opcional
Sufixo de alias personalizado opcional: de 2 a 32 letras ou dígitos ASCII, normalizado para minúsculas; sujeito a permissão de recurso. Também aceita custom_username ou alias_username.
Padrão: Gerado automaticamente
lifetime body string opcional
valores permitidos:
10m — 10 Minutos 1h — 1 Hora 2h — 2 Horas 1d — 1 Dia 1w — 1 Semana 1m — 30 Dias 3m — 90 dias 6m — 180 Dias 1y — 365 Dias unlimited — Ilimitado
Padrão: Tempo de vida padrão do plano
pin_enabled body boolean opcional
Proteção opcional por PIN para a nova caixa de correio, quando permitida pelo seu plano. Não altera o PIN de uma caixa de correio existente.
Padrão: false
pin body string opcional
Obrigatório quando pin_enabled for true: um PIN de 6 a 8 dígitos, enviado como string para preservar zeros à esquerda.
pin_confirmation body string opcional
Obrigatório quando pin_enabled for verdadeiro. Deve corresponder exatamente ao pin.
Idempotency-Key header string opcional
Necessário para criação ou exclusão protegida por PIN: uma chave estável de 16 a 128 caracteres. Refaça a mesma solicitação com a mesma chave para evitar trabalho duplicado.
Requer que a permissão da API Outlook Alias esteja habilitada no seu plano de assinatura ou desbloqueada via um pacote de Créditos de API. Parâmetros opcionais: domain (ex. outlook.com, hotmail.com), username (nome de usuário de alias personalizado), lifetime (valores permitidos: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). Omitir o tempo de vida, ou deixá-lo vazio, para usar o Tempo de Vida de Email Padrão configurado para o seu plano mensal/anual atual. Envie um tempo de vida permitido, como 1h, para substituir esse padrão. Ilimitado é usado somente quando configurado como padrão do plano ou explicitamente solicitado e permitido. Os parâmetros de corpo mailbox_lifetime e email_lifetime também são aceitos; o primeiro valor não vazio tem prioridade nesta ordem: lifetime, mailbox_lifetime, email_lifetime. Valores inválidos ou não permitidos retornam HTTP 422 em vez de selecionar silenciosamente um padrão.
Criar caixa de correio de alias do Outlook
curl --request POST \
  --url 'https://v1.tempmailg.com/api/outlook-alias/emails' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Resposta ilustrativa usando dados sintéticos. IDs, endereços, tokens, timestamps, limites e contagens do plano variam. As durações de exemplo não substituem o padrão do seu plano. As descrições dos campos de resposta identificam campos anuláveis e específicos do provedor.

Exemplo de resposta
200 OK • JSON
{
    "status": true,
    "data": {
        "id": 2306,
        "pin_protected": false,
        "email": "example+alias45@outlook.com",
        "domain": "outlook.com",
        "provider": "outlook_alias",
        "expire_at": "2026-11-19T03:17:59+00:00",
        "expires_in_seconds": 3599.75,
        "mailbox_state": "active",
        "receiving_enabled": true,
        "message_count": 0,
        "unread_message_count": 0,
        "last_message_received_at": null,
        "message_count_synced_at": null,
        "created_at": "2026-11-19T02:17:59+00:00",
        "email_token": "encrypted-email-token"
    }
}
Campos de resposta
Campo Tipo Descrição
status boolean
Se a operação foi bem-sucedida.
data.id integer
ID da caixa de correio. IDs, endereços e tokens gerados diferem para cada caixa de correio.
data.pin_protected boolean
Se esta caixa de correio tem proteção por PIN. Nenhum PIN ou hash de PIN é retornado.
data.email string
Endereço completo da caixa de correio gerado.
data.domain string
Domínio da caixa de correio gerada.
data.provider string
Provedor de caixa de correio: standard, gmail_alias, ou outlook_alias.
data.expire_at string|null
Expiração efetiva como um timestamp ISO-8601, ou null para uma caixa de correio ilimitada.
data.expires_in_seconds number|null
Segundos restantes não negativos quando calculado; segundos fracionários são possíveis. Null significa ilimitado, não zero.
data.mailbox_state string
Estado atual da caixa de correio: ativo, pausado, expirado ou inativo.
data.receiving_enabled boolean
Se esta caixa de correio aceita mensagens recebidas atualmente.
data.message_count integer
Contagem total de mensagens conhecida; pode refletir a última sincronização da caixa de correio.
data.unread_message_count integer
Contagem conhecida de mensagens não lidas; pode refletir a última sincronização da caixa de correio.
data.last_message_received_at string|null
Último horário conhecido de mensagem recebida no formato ISO-8601, ou null quando indisponível.
data.message_count_synced_at string|null
Última hora de sincronização da contagem de mensagens no formato ISO-8601, ou null antes da sincronização.
data.created_at string|null
Hora de criação da caixa de correio no formato ISO-8601.
data.email_token string
Referência de caixa de correio criptografada opaca. Não substitui a autenticação Bearer, verificações de propriedade ou autorização por PIN.
data.pin_grant object
Condicional: a criação de caixa de correio protegida por PIN ativo retorna esta concessão de leitura; a criação comum sem proteção a omite.
data.pin_grant.mailbox_id integer
ID da caixa de correio ao qual a concessão de leitura condicional está vinculada.
data.pin_grant.unlock_token string
Token de leitura opaco para X-Mailbox-Unlock com a mesma credencial do proprietário. Mantenha-o privado e em memória; uma concessão de leitura não autoriza a exclusão.
data.pin_grant.scope string
O escopo lido para a concessão de criação condicional.
data.pin_grant.idle_timeout_seconds integer
Tempo ocioso permitido para a concessão de leitura, normalmente 3600 segundos.
data.pin_grant.absolute_timeout_seconds integer
Tempo máximo de vida da concessão de leitura, normalmente 86400 segundos.
data.pin_grant.expires_at string
Expiração atual da concessão de leitura no formato ISO-8601.
data.pin_grant.absolute_expires_at string
Data de expiração absoluta da concessão de leitura no formato ISO-8601. Alterações de segurança podem revogar a concessão mais cedo.

Mensagens e Anexos

Buscar caixas de entrada recebidas, ler mensagens completas em HTML/texto e transmitir anexos.

GET https://v1.tempmailg.com/api/messages?email={email}
#

Listar mensagens da caixa de correio

Recupere os resumos de mensagens disponíveis e os metadados da caixa de correio. As varreduras padrão da caixa de entrada retornam um lote recente de até 25 mensagens; este não é um endpoint paginado de histórico completo. Use GET /messages/{messageId} para obter os corpos completos e os anexos.

Parâmetros 2
Parâmetro Localização Tipo Status Descrição
email query string obrigatório
Endereço de e-mail completo da caixa de correio de propriedade para ler mensagens. Codifique o valor da consulta em URL; codifique um sinal de mais como %2B.
X-Mailbox-Unlock header string opcional
Cabeçalho, apenas caixas de correio protegidas: use um unlock_token de leitura. Primeiro faça POST de pin e scope=read para a URL de desbloqueio de PIN. Mantenha sua autenticação Bearer normal. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
O e‑mail deve pertencer à sua conta. Resumos padrão e do Gmail contêm campos OTP e verification-link; o Outlook também inclui from_name, snippet, received_at e has_attachments. A sincronização e o cache do provedor podem atrasar novas mensagens e contagens.
Ler mensagens da caixa de correio
curl --request GET \
  --url 'https://v1.tempmailg.com/api/messages?email=demo123@example.com' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Resposta ilustrativa usando dados sintéticos. IDs, endereços, tokens, timestamps, limites e contagens do plano variam. As durações de exemplo não substituem o padrão do seu plano. As descrições dos campos de resposta identificam campos anuláveis e específicos do provedor.

Exemplo de resposta
200 OK • JSON
{
    "status": true,
    "mailbox": "demo123@example.com",
    "email_token": "encrypted-email-token",
    "messages": [
        {
            "is_seen": false,
            "subject": "Welcome to Temp Mail",
            "from": "Example Sender",
            "from_email": "hello@example.org",
            "receivedAt": "2026-11-19 02:17:59",
            "id": "ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1",
            "otp": null,
            "otp_locked": false,
            "verification_link": null,
            "verification_link_locked": false
        }
    ],
    "mailbox_provider": "standard",
    "mailbox_state": "active",
    "expire_at": "2026-11-20T02:17:59+00:00",
    "expires_in_seconds": 86399.75,
    "receiving_enabled": true,
    "mailbox_limit": {
        "limit": 50,
        "limit_label": "50",
        "active_count": 1,
        "paused_count": 0,
        "paused_mailboxes": [],
        "remaining": 49,
        "remaining_label": "49",
        "reached": false,
        "blocked": false,
        "provider": "standard"
    },
    "message_count": 1,
    "unread_message_count": 1,
    "last_message_received_at": "2026-11-19T02:17:59+00:00",
    "message_count_synced_at": "2026-11-19T02:17:59+00:00"
}
Campos de resposta
Campo Tipo Descrição
status boolean
Se a operação foi bem-sucedida.
mailbox string
Endereço da caixa de correio cujas mensagens foram solicitadas.
email_token string
Referência opaca de caixa de correio criptografada; a autenticação normal ainda é necessária.
mailbox_provider string
Provedor de caixa de correio: standard, gmail_alias, ou outlook_alias.
messages array
Resumos de mensagens. Uma caixa de entrada vazia retorna um array vazio; recupere uma única mensagem para seu corpo e anexos.
expire_at string|null
Expiração efetiva como um timestamp ISO-8601, ou null para uma caixa de correio ilimitada.
expires_in_seconds number|null
Segundos restantes não negativos quando calculado; segundos fracionários são possíveis. Null significa ilimitado, não zero.
mailbox_state string
Estado atual da caixa de correio: ativo, pausado, expirado ou inativo.
receiving_enabled boolean
Se esta caixa de correio aceita mensagens recebidas atualmente.
message_count integer
Contagem total de mensagens conhecida; pode refletir a última sincronização da caixa de correio.
unread_message_count integer
Contagem conhecida de mensagens não lidas; pode refletir a última sincronização da caixa de correio.
last_message_received_at string|null
Último horário conhecido de mensagem recebida no formato ISO-8601, ou null quando indisponível.
message_count_synced_at string|null
Última hora de sincronização da contagem de mensagens no formato ISO-8601, ou null antes da sincronização.
mailbox_limit.limit integer
Limite ativo de caixas de correio para este provedor; -1 significa ilimitado.
mailbox_limit.limit_label string
Rótulo de exibição para o limite da caixa de correio.
mailbox_limit.active_count integer
Número de caixas de correio ativas para este provedor.
mailbox_limit.paused_count integer
Número de caixas de correio pausadas para este provedor.
mailbox_limit.paused_mailboxes array<string>
Endereços pausados pelo limite da caixa de correio.
mailbox_limit.remaining integer
Slots de caixa de correio ativos restantes; -1 significa ilimitado. Isto não é quota de requisições da API.
mailbox_limit.remaining_label string
Exibir rótulo para vagas restantes da caixa de correio.
mailbox_limit.reached boolean
Se o limite de caixas de correio ativas foi atingido.
mailbox_limit.blocked boolean
Se o limite de caixa de correio ativa é zero.
mailbox_limit.provider string|null
Provedor ao qual o limite da caixa de correio se aplica.
messages[].id string
ID de mensagem opaca usado pelos endpoints de mensagem única, exclusão e anexo.
messages[].is_seen boolean
Se a mensagem está marcada como lida.
messages[].subject string
Assunto da mensagem.
messages[].from string
Nome de exibição ou endereço do remetente.
messages[].from_email string
Endereço de e‑mail do remetente.
messages[].receivedAt string
Hora recebida no fuso horário da aplicação, formatada como YYYY-MM-DD HH:mm:ss.
messages[].otp string|null
Detectado código de uso único quando disponível e permitido; caso contrário, nulo.
messages[].otp_locked boolean
Se um código de uso único detectado está oculto pelas permissões do recurso.
messages[].verification_link string|null
URL de verificação detectada quando disponível e permitida; caso contrário, nulo.
messages[].verification_link_locked boolean
Se um link de verificação detectado está oculto pelas permissões de recurso.
messages[].from_name string|null
Campo de resumo do Outlook: nome do remetente original. Ausente dos resumos padrão e do Gmail.
messages[].snippet string|null
Campo de resumo do Outlook: pré‑visualização curta da mensagem.
messages[].received_at string|null
Campo de resumo do Outlook: hora recebida em ISO-8601, quando conhecida.
messages[].has_attachments boolean
Campo de resumo do Outlook: se os metadados do anexo existem. A disponibilidade de download é verificada separadamente.
GET https://v1.tempmailg.com/api/messages/{messageId}
#

Obter mensagem única

Recupere uma mensagem de propriedade própria pelo seu ID de mensagem opaco. Retorna formatos de corpo e metadados de anexos. Os campos do corpo dependem do formato da mensagem; o Outlook adiciona campos específicos do provedor listados abaixo.

Parâmetros 2
Parâmetro Localização Tipo Status Descrição
messageId path string obrigatório
ID de mensagem única retornado na lista de mensagens.
X-Mailbox-Unlock header string opcional
Cabeçalho, apenas caixas de correio protegidas: use um unlock_token de leitura. Primeiro faça POST de pin e scope=read para a URL de desbloqueio de PIN. Mantenha sua autenticação Bearer normal. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
Ler uma mensagem
curl --request GET \
  --url 'https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Resposta ilustrativa usando dados sintéticos. IDs, endereços, tokens, timestamps, limites e contagens do plano variam. As durações de exemplo não substituem o padrão do seu plano. As descrições dos campos de resposta identificam campos anuláveis e específicos do provedor.

Exemplo de resposta
200 OK • JSON
{
    "status": true,
    "data": {
        "is_seen": true,
        "subject": "Welcome to Temp Mail",
        "from": "Example Sender",
        "from_email": "hello@example.org",
        "to": "demo123@example.com",
        "mailbox_provider": "standard",
        "receivedAt": "2026-11-19 02:17:59",
        "id": "ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1",
        "html": true,
        "html_content": "<p>Hello from the inbox.</p>",
        "text_content": "<pre>Hello from the inbox.</pre>",
        "content": "<p>Hello from the inbox.</p>",
        "attachments": [
            {
                "name": "file.txt",
                "extension": "txt",
                "size": 91,
                "url": "https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1/attachments/file.txt"
            }
        ]
    }
}
Campos de resposta
Campo Tipo Descrição
status boolean
Se a operação foi bem-sucedida.
data.id string
ID de mensagem opaco.
data.is_seen boolean
Estado de leitura da mensagem. Ler pode marcá-la como vista; dados em cache podem refletir um estado anterior.
data.subject string
Assunto da mensagem.
data.from string
Nome de exibição ou endereço do remetente.
data.from_email string
Endereço de e‑mail do remetente.
data.to string
Endereço da caixa de correio do destinatário.
data.mailbox_provider string
Provedor de caixa de correio: standard, gmail_alias, ou outlook_alias.
data.receivedAt string
Hora recebida no fuso horário da aplicação, formatada como YYYY-MM-DD HH:mm:ss.
data.html boolean
Se a mensagem tem um corpo HTML.
data.html_content string
Corpo HTML quando presente. Mensagens padrão sem HTML podem omitir este campo. Trate o conteúdo da mensagem como não confiável.
data.text_content string
Corpo de texto quando presente; Mensagens padrão podem conter texto escapado em um elemento pre ou omitir este campo.
data.content string
Corpo preferido para exibição, normalmente HTML quando disponível.
data.attachments array
Metadados do anexo, ou um array vazio. Downloads requerem autenticação normal e autorização de PIN aplicável.
data.attachments[].name string
Nome do arquivo a codificar em URL como um único segmento de caminho ao baixar.
data.attachments[].size integer
Tamanho do anexo em bytes.
data.attachments[].url string
URL de download da API de Usuário Autenticado adicionada aos anexos com um nome de arquivo. Uma URL não garante que o arquivo local esteja disponível.
data.attachments[].extension string
Campo de metadados padrão/Gmail: extensão de arquivo quando fornecida.
data.attachments[].id string
Campo de metadados do Outlook: ID de anexo do provedor.
data.attachments[].content_type string
Campo de metadados do Outlook: tipo de conteúdo MIME.
data.from_name string|null
Campo de detalhe do Outlook: nome do remetente original.
data.to_email string|null
Campo de detalhe do Outlook: endereço do destinatário original.
data.received_at string|null
Campo de detalhe do Outlook: hora recebida no formato ISO-8601.
data.has_html boolean
Campo de detalhe do Outlook: se existe um corpo HTML.
DELETE https://v1.tempmailg.com/api/messages/{messageId}
#

Excluir Mensagem

Excluir uma mensagem de propriedade única.

Parâmetros 3
Parâmetro Localização Tipo Status Descrição
messageId path string obrigatório
String de ID de mensagem única para excluir permanentemente.
X-Mailbox-Unlock header string opcional
Cabeçalho, apenas caixas de correio protegidas: use o unlock_token de exclusão de uso único. Primeiro POST pin, scope=delete e o action/target_id retornado pela resposta 423 para a PIN unlock URL. Um token de leitura não pode excluir. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
Idempotency-Key header string opcional
Necessário para criação ou exclusão protegida por PIN: uma chave estável de 16 a 128 caracteres. Refaça a mesma solicitação com a mesma chave para evitar trabalho duplicado.
Excluir uma mensagem
curl --request DELETE \
  --url 'https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Resposta ilustrativa usando dados sintéticos. IDs, endereços, tokens, timestamps, limites e contagens do plano variam. As durações de exemplo não substituem o padrão do seu plano. As descrições dos campos de resposta identificam campos anuláveis e específicos do provedor.

Exemplo de resposta
200 OK • JSON
{
    "status": true,
    "message": "Message was deleted successfully."
}
Campos de resposta
Campo Tipo Descrição
status boolean
Se a operação foi bem-sucedida.
message string
Resultado da exclusão. Um recurso ausente retorna HTTP 404.
GET https://v1.tempmailg.com/api/messages/{messageId}/attachments/{filename}
#

Baixar anexo

Baixar um anexo de uma mensagem de propriedade.

Parâmetros 3
Parâmetro Localização Tipo Status Descrição
messageId path string obrigatório
ID da mensagem que contém o arquivo.
filename path string obrigatório
Nome do arquivo e extensão do anexo para download.
X-Mailbox-Unlock header string opcional
Cabeçalho, apenas caixas de correio protegidas: use um unlock_token de leitura. Primeiro faça POST de pin e scope=read para a URL de desbloqueio de PIN. Mantenha sua autenticação Bearer normal. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
O sucesso retorna bytes do arquivo, não JSON. Arquivos excessivamente grandes retornam HTTP 403; arquivos locais ausentes ou indisponíveis retornam HTTP 404. Codifique a URL do nome do arquivo como um único segmento de caminho. Apenas os metadados do anexo não garantem a disponibilidade do download.
Baixar um anexo
curl --request GET \
  --url 'https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1/attachments/file.txt' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY' \
  --output file.txt
Comportamento de download Este ponto de extremidade retorna o arquivo solicitado diretamente em vez de um corpo JSON.
Campos de resposta
Campo Tipo Descrição
Content-Disposition header
Resposta bem-sucedida baixa o nome de arquivo solicitado.
body binary
Bytes do arquivo em caso de sucesso, não JSON. Erros retornam JSON com um status diferente de 2xx.

Limites de Taxas e Cotas

Monitore orçamentos de solicitações em tempo real, limites de taxa e cotas de conta sem consumir créditos.

GET https://v1.tempmailg.com/api/rate-limit
#

Limite de taxa & cota

Verifique seu limite de taxa atual e o status da cota sem consumir nenhum uso da API. Este endpoint é livre de cota e não deduz créditos mensais da API (limite de proteção contra abuso: 60 solicitações/min).

X-RateLimit-* descreve o orçamento de solicitações indicado; X-Quota-* descreve a capacidade mensal e adquirida quando disponível. X-Mailbox-RateLimit-* relata o orçamento separado de criação/atualização de caixa de correio. Uma rejeição apenas de caixa de correio usa o escopo da caixa de correio e sua própria janela de nova tentativa. Rejeições por limite de minuto podem omitir informações de cota. Retry-After é incluído apenas para uma nova tentativa cronometrada; o acesso desativado pode exigir uma mudança de conta. Nesta resposta de status bem-sucedida, data.limit, data.remaining e data.reset descrevem o orçamento de minutos da conta, não créditos gastáveis. O objeto data.quota descreve a cota mensal, saldos de crédito e uso. Os campos existentes data.monthly_limit, data.monthly_remaining e data.purchased_credits permanecem como aliases dos campos de quota correspondentes. Uma verificação de status bem-sucedida não autoriza outra operação de API. As operações ainda requerem acesso habilitado, cota disponível e aprovação através de todos os limites aplicáveis. A captura instantânea da cota não garante capacidade já reservada por uma solicitação em andamento.
Verificar status do limite de taxa
curl --request GET \
  --url 'https://v1.tempmailg.com/api/rate-limit' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Resposta ilustrativa usando dados sintéticos. IDs, endereços, tokens, timestamps, limites e contagens do plano variam. As durações de exemplo não substituem o padrão do seu plano. As descrições dos campos de resposta identificam campos anuláveis e específicos do provedor.

Exemplo de resposta
200 OK • JSON
{
    "status": "success",
    "data": {
        "limit": 60,
        "remaining": 45,
        "reset": 32,
        "plan": "premium",
        "monthly_limit": 50000,
        "monthly_remaining": 48210,
        "purchased_credits": 5000,
        "quota": {
            "enabled": true,
            "user_api_status": true,
            "plan_name": "Premium Plan",
            "period": "2026-10",
            "base_limit": 50000,
            "extra_requests": 0,
            "monthly_limit": 50000,
            "monthly_remaining": 48210,
            "used": 1790,
            "purchased_credits": 5000,
            "bonus_credits": 1000,
            "direct_purchased_credits": 4000,
            "remaining": 53210,
            "unlimited": false,
            "usage_percent": 3,
            "reset_at": "2026-11-01T00:00:00+00:00"
        }
    }
}
Campos de resposta
Campo Tipo Descrição
data.limit integer|string
Limite de solicitações por minuto da conta. A string unlimited indica um orçamento ilimitado por minuto; isso é independente da cota mensal.
data.remaining integer|string
Slots de orçamento de minutos restantes da conta, ou a string unlimited. Um valor positivo não significa que créditos da API permanecem.
data.reset integer
Segundos para a janela de minuto da conta, não para a redefinição mensal da cota. Orçamentos de minuto desativados ou ilimitados podem manter um valor nominal de 60 segundos; isso não garante acesso após a espera.
data.plan string
Etiqueta do plano atual. O nome legível do plano é fornecido separadamente em data.quota.plan_name.
data.quota.enabled boolean
Se o acesso global e de plano/crédito à API está habilitado. Isso não indica a capacidade restante nem substitui a chave de API do usuário.
data.quota.user_api_status boolean
Se o usuário ativou o interruptor da API do usuário. As operações requerem esse interruptor, bem como acesso habilitado e capacidade disponível.
data.quota.plan_name string
Nome legível do plano atual.
data.quota.period string
Período de uso de calendário-mês no formato YYYY-MM, usando o fuso horário da aplicação; não necessariamente o período de faturamento da assinatura.
data.quota.base_limit integer
Cota base do plano mensal. Um valor de -1 significa ilimitado.
data.quota.extra_requests integer
Aumento mensal adicional concedido para o período de uso atual; separado dos créditos comprados.
data.quota.monthly_limit integer
Cota base mais solicitações extras do período atual. Um valor de -1 significa ilimitado. Créditos comprados não estão incluídos.
data.quota.monthly_remaining integer|null
Alocação mensal finita restante, ou null quando a cota mensal é ilimitada. Null não deve ser interpretado como zero.
data.quota.used integer
Operações de API bem-sucedidas e contabilizadas no período de uso atual, incluindo operações usando créditos. Verificações de status não aumentam esse valor.
data.quota.purchased_credits integer
Saldo atual de créditos, incluindo créditos bônus do plano ativo. Créditos bônus não devem ser adicionados a este saldo uma segunda vez.
data.quota.bonus_credits integer
Parte de bônus do plano ativo do saldo de crédito; uma divisão de purchased_credits, não capacidade adicional.
data.quota.direct_purchased_credits integer
Saldo de crédito excluindo a parte de bônus do plano ativo. Este valor mais bonus_credits equivale a purchased_credits.
data.quota.remaining integer|null
Cota mensal restante mais o saldo de crédito atual, sem contar bônus duas vezes. Null significa quota mensal ilimitada. Permissões individuais de recursos e outros limites de requisição ainda se aplicam.
data.quota.unlimited boolean
Indica se a cota mensal é ilimitada. Isso não torna ilimitado o orçamento de minutos da conta ou outros limites de recursos.
data.quota.usage_percent integer
Porcentagem arredondada compatível com o painel de 0 a 100: usado dividido por usado mais restante, multiplicado por 100. Inclui a capacidade de crédito disponível, portanto recarregar pode reduzir a porcentagem. É 0 para cota ilimitada ou um pool de tamanho zero; não é a porcentagem de limite de taxa por minuto nem uma decisão de acesso.
data.quota.reset_at string
Carimbo de data/hora ISO-8601 com deslocamento de fuso horário para a redefinição da cota do próximo mês calendário. Isso não é a data de expiração da assinatura, e a redefinição mensal não recarrega os créditos comprados.
status string
O sucesso literal para este endpoint de status. Outros endpoints de caixa de correio bem-sucedidos usam o booleano true.
data.monthly_limit integer
Alias de compatibilidade do campo data.quota correspondente; não o adicione novamente ao calcular saldos.
data.monthly_remaining integer|null
Alias de compatibilidade do campo data.quota correspondente; não o adicione novamente ao calcular saldos.
data.purchased_credits integer
Alias de compatibilidade do campo data.quota correspondente; não o adicione novamente ao calcular saldos.

Proteção de PIN da Caixa de Correio

Insira o PIN para continuar. Sua caixa de correio permanece desbloqueada enquanto estiver atual nesta sessão do site.

Você aceita cookies?

Usamos cookies para melhorar sua experiência de navegação. Ao usar este site, você concorda com nossa política de cookies.

Mais