Todos os produtos
Search
Central de documentação

Direct Mail:BatchSendMail

Última atualização: Oct 27, 2026

Envia e-mails em massa.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

  • Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.

  • API: A API que você pode chamar para executar a ação.

  • Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.

  • Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.

    • Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.

    • Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.

  • Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.

  • Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

dm:BatchSendMail

none

*Todos os recursos.

*

Nenhuma Nenhuma

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

TemplateName

string

Não

O nome do modelo pré-criado e aprovado.

test1

AccountName

string

Sim

O endereço do remetente configurado no console.

test@example.com

ReceiversName

string

Não

O nome da lista de destinatários pré-criada para a qual os destinatários são carregados.

Nota:

O número de destinatários na lista não deve exceder a cota diária restante. Caso contrário, o envio do e-mail falhará.

A lista de destinatários deve ser excluída pelo menos 10 minutos após o acionamento da tarefa. Caso contrário, o envio do e-mail poderá falhar.

test2

AddressType

integer

Sim

Valores válidos:

  • 0: Conta aleatória.

  • 1: Endereço do remetente.

1

TagName

string

Não

O nome da tag de e-mail.

test3

ReplyAddress

string

Não

O endereço de resposta.

test2***@example.net

ReplyAddressAlias

string

Não

O alias do endereço de resposta.

Xiaohong

ClickTrace

string

Não

Especifica se o recurso de rastreamento de dados deve ser ativado. Valores válidos:

  • 1: Ativa o recurso de rastreamento de dados.

  • 0: Desativa o recurso de rastreamento de dados. Este é o valor padrão.

0

UnSubscribeLinkType

string

Não

O tipo do link de cancelamento de inscrição gerado. Para obter mais informações, consulte Mecanismo de geração e filtragem de links do recurso de cancelamento de inscrição. Valores válidos:

  • disabled: Não gera um link de cancelamento de inscrição.

  • default: Usa a política padrão. Um link de cancelamento de inscrição é gerado quando um endereço de remetente em massa envia e-mails para domínios específicos, como domínios que contêm as palavras-chave "gmail", "yahoo", "google", "aol.com", "hotmail", "outlook" e "ymail.com".

O idioma de exibição é identificado automaticamente com base nas configurações do navegador do destinatário.

default

UnSubscribeFilterLevel

string

Não

O nível de filtragem. Para obter mais informações, consulte Mecanismo de geração e filtragem de links do recurso de cancelamento de inscrição. Valores válidos:

  • disabled: Não filtra.

  • default: Usa a política padrão. Os endereços em massa são filtrados no nível do endereço do remetente.

  • mailfrom: Filtra no nível do endereço do remetente.

  • mailfrom_domain: Filtra no nível do domínio do remetente.

  • edm_id: Filtra no nível da conta.

mailfrom_domain

Headers

string

Não

As configurações de cabeçalho do e-mail.

Os campos padrão e não padrão devem estar em conformidade com os requisitos de sintaxe para cabeçalhos no padrão. Você pode passar até 10 cabeçalhos por meio do campo headers ao enviar e-mails chamando operações de API. Os cabeçalhos que excederem o limite serão ignorados. O SMTP não possui esse limite.

  1. Campos padrão

Message-ID, List-Unsubscribe e List-Unsubscribe-Post.

Os campos padrão substituem os valores originais nos cabeçalhos do e-mail.

  1. Campos não padrão

Não diferenciam maiúsculas de minúsculas.

a. Começam com X-User- (não enviados para o EventBridge ou Message Service. Necessários apenas para operações de API. O SMTP permite quaisquer campos personalizados).

b. Começam com X-User-Notify- (enviados para o EventBridge e Message Service. Suportados por operações de API e SMTP).

Quando enviados para o EventBridge ou Message Service, o campo de cabeçalho inclui esses campos.

{ "Message-ID": "", "X-User-UID1": "UID-1-000001", "X-User-UID2": "UID-2-000001", "X-User-Notify-UID1": "UID-3-000001", "X-User-Notify-UID2": "UID-4-000001" }

IpPoolId

string

Não

O ID do pool de endereços IP independentes. Os usuários que compraram endereços IP independentes podem usar este parâmetro para especificar o endereço IP de saída para o envio do e-mail atual.

e4xxxxxe-4xx0-4xx3-8xxa-74cxxxxx1cef

DomainAuth

boolean

Não

Especifica se a autenticação no nível do domínio deve ser ativada. Valores válidos:

  • true

  • false

Este parâmetro é usado apenas para autenticação no nível do domínio. Ignore este parâmetro para autenticação no nível do endereço do remetente.

  1. Crie o endereço domain-auth-created-by-system@example.com no console. Mantenha o prefixo antes de @ fixo e use seu próprio nome de domínio como sufixo.

Cenário de API

Defina AccountName como o nome de domínio. O destinatário vê domain-auth-created-by-system@example.com como o remetente.

Cenário de SMTP

a. Defina a senha do nome de domínio chamando a operação ModifyPWByDomain.

b. Autentique-se usando o nome de domínio e a senha configurada. Passe um endereço personalizado, como user@example.com, como o remetente real no campo mailfrom. O destinatário vê user@example.com como o remetente.

true

TemplateContent

object

Não

O conteúdo personalizado do e-mail. Você pode especificar o conteúdo a ser enviado diretamente sem criar um modelo com antecedência. Este parâmetro é mutuamente exclusivo com TemplateName. Se TemplateContent e TemplateName forem especificados, TemplateName terá precedência.

Subject

string

Não

O assunto do e-mail.

Black Friday, exclusive discounts available

HtmlBody

string

Não

O corpo HTML do e-mail.

Nota: HtmlBody e TextBody são para diferentes tipos de conteúdo de e-mail. Você deve especificar um deles.

O novo SDK limita o parâmetro Body a aproximadamente 8 MB (Java 1.4.0 e posterior, Python 3 1.4.0 e posterior, PHP 1.4.0 e posterior).

10% off storewide, today only

TextBody

string

Não

O corpo de texto do e-mail.

Nota: HtmlBody e TextBody são para diferentes tipos de conteúdo de e-mail. Você deve especificar um deles.

O novo SDK limita o parâmetro Body a aproximadamente 8 MB (Java 1.4.0 e posterior, Python 3 1.4.0 e posterior, PHP 1.4.0 e posterior).

10% off storewide, today only

Alias

string

Não

O nome de exibição do remetente.

Jackie

Receivers

array<object>

Não

A lista de destinatários. O número de destinatários não pode exceder 100. Este parâmetro é mutuamente exclusivo com ReceiversName. Se Receivers e ReceiversName forem especificados, ReceiversName terá precedência.

Exemplo: [{"To":["Jackie@example.com"],"TemplateData":{"UserName":"Jackie"}},{"To":["Tom@example.com"],"TemplateData":{"UserName":"Tom"}}]

array<object>

Não

Os detalhes personalizados do destinatário.

To

array

Não

A lista de destinatários, que é do tipo array.

string

Não

O endereço de e-mail.

Jackie@example.com

TemplateData

object

Não

Os parâmetros do modelo de e-mail, que são do tipo de dados JSON map.

string

Não

A string de chave-valor.

{"UserName": "Jackie"}

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

EnvId

string

O ID do evento.

xxx

RequestId

string

O ID da solicitação.

12D086F6-8F31-4658-84C1-006DED011A85

Exemplos

Resposta de sucesso

JSON formato

{
  "EnvId": "xxx",
  "RequestId": "12D086F6-8F31-4658-84C1-006DED011A85"
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.