BatchSendMail - Direct Mail - Centro de documentación de Alibaba Cloud

Envía correos electrónicos masivos.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

dm:BatchSendMail

none

*Todos los recursos.

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
TemplateName	string	No	El nombre de la plantilla creada y aprobada previamente.	test1
AccountName	string	Sí	La dirección del remitente configurada en la consola.	test@example.com
ReceiversName	string	No	El nombre de la lista de destinatarios creada previamente a la que se cargan los destinatarios. Nota: El número de destinatarios en la lista no debe exceder la cuota diaria restante. De lo contrario, el envío del correo electrónico fallará. La lista de destinatarios debe eliminarse al menos 10 minutos después de que se active la tarea. De lo contrario, el envío de correos electrónicos podría fallar.	test2
AddressType	integer	Sí	Valores válidos: 0: Cuenta aleatoria. 1: Dirección del remitente.	1
TagName	string	No	El nombre de la etiqueta de correo electrónico.	test3
ReplyAddress	string	No	La dirección de respuesta.	test2***@example.net
ReplyAddressAlias	string	No	El alias de la dirección de respuesta.	Xiaohong
ClickTrace	string	No	Especifica si se debe habilitar la función de seguimiento de datos. Valores válidos: 1: Habilita la función de seguimiento de datos. 0: Deshabilita la función de seguimiento de datos. Este es el valor predeterminado.	0
UnSubscribeLinkType	string	No	El tipo de enlace de cancelación de suscripción generado. Para obtener más información, consulte Mecanismo de generación y filtrado de enlaces de la función de cancelación de suscripción. Valores válidos: disabled: No genera un enlace de cancelación de suscripción. default: Utiliza la política predeterminada. Se genera un enlace de cancelación de suscripción cuando una dirección de remitente masivo envía correos electrónicos a dominios específicos, como dominios que contienen las palabras clave "gmail", "yahoo", "google", "aol.com", "hotmail", "outlook" y "ymail.com". El idioma de visualización se identifica automáticamente según la configuración del navegador del destinatario.	default
UnSubscribeFilterLevel	string	No	El nivel de filtrado. Para obtener más información, consulte Mecanismo de generación y filtrado de enlaces de la función de cancelación de suscripción. Valores válidos: disabled: No filtra. default: Utiliza la política predeterminada. Las direcciones masivas se filtran a nivel de dirección del remitente. mailfrom: Filtra a nivel de dirección del remitente. mailfrom_domain: Filtra a nivel de dominio del remitente. edm_id: Filtra a nivel de cuenta.	mailfrom_domain
Headers	string	No	La configuración de los encabezados de correo electrónico. Tanto los campos estándar como los no estándar deben cumplir con los requisitos de sintaxis para los encabezados en el estándar. Puede pasar hasta 10 encabezados a través del campo de encabezados al enviar correos electrónicos mediante llamadas a operaciones de API. Los encabezados que excedan el límite se ignoran. SMTP no tiene este límite. Campos estándar Message-ID, List-Unsubscribe y List-Unsubscribe-Post. Los campos estándar sobrescriben los valores originales en los encabezados del correo electrónico. Campos no estándar No distinguen entre mayúsculas y minúsculas. a. Comienzan con X-User- (no se envían a EventBridge ni a Message Service. Solo son necesarios para las operaciones de API. SMTP permite cualquier campo personalizado). b. Comienzan con X-User-Notify- (se envían a EventBridge y a Message Service. Compatibles tanto con operaciones de API como con SMTP). Cuando se envían a EventBridge o Message Service, el campo de encabezado incluye estos 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	No	El ID del pool de direcciones IP independientes. Los usuarios que han comprado direcciones IP independientes pueden usar este parámetro para especificar la dirección IP de salida para el envío de correo electrónico actual.	e4xxxxxe-4xx0-4xx3-8xxa-74cxxxxx1cef
DomainAuth	boolean	No	Especifica si se debe habilitar la autenticación a nivel de dominio. Valores válidos: true false Este parámetro solo se utiliza para la autenticación a nivel de dominio. Ignore este parámetro para la autenticación a nivel de dirección del remitente. Cree la dirección domain-auth-created-by-system@example.com en la consola. Mantenga fijo el prefijo antes de @ y utilice su propio nombre de dominio como sufijo. Escenario de API Establezca AccountName en el nombre de dominio. El destinatario ve domain-auth-created-by-system@example.com como remitente. Escenario de SMTP a. Establezca la contraseña del nombre de dominio llamando a la operación ModifyPWByDomain. b. Autentíquese utilizando el nombre de dominio y la contraseña configurada. Pase una dirección personalizada, como user@example.com, como remitente real en el campo mailfrom. El destinatario ve user@example.com como remitente.	true
TemplateContent	object	No	El contenido personalizado del correo electrónico. Puede especificar el contenido para enviarlo directamente sin crear una plantilla previamente. Este parámetro es mutuamente excluyente con TemplateName. Si se especifican tanto TemplateContent como TemplateName, TemplateName tiene prioridad.
Subject	string	No	El asunto del correo electrónico.	Black Friday, exclusive discounts available
HtmlBody	string	No	El cuerpo HTML del correo electrónico. Nota: HtmlBody y TextBody son para diferentes tipos de contenido de correo electrónico. Debe especificar uno de ellos. El nuevo SDK limita el parámetro Body a aproximadamente 8 MB (Java 1.4.0 y posterior, Python 3 1.4.0 y posterior, PHP 1.4.0 y posterior).	10% off storewide, today only
TextBody	string	No	El cuerpo de texto del correo electrónico. Nota: HtmlBody y TextBody son para diferentes tipos de contenido de correo electrónico. Debe especificar uno de ellos. El nuevo SDK limita el parámetro Body a aproximadamente 8 MB (Java 1.4.0 y posterior, Python 3 1.4.0 y posterior, PHP 1.4.0 y posterior).	10% off storewide, today only
Alias	string	No	El nombre para mostrar del remitente.	Jackie
Receivers	array<object>	No	La lista de destinatarios. El número de destinatarios no puede exceder los 100. Este parámetro es mutuamente excluyente con ReceiversName. Si se especifican tanto Receivers como ReceiversName, ReceiversName tiene prioridad. Ejemplo: [{"To":["Jackie@example.com"],"TemplateData":{"UserName":"Jackie"}},{"To":["Tom@example.com"],"TemplateData":{"UserName":"Tom"}}]
	array<object>	No	Los detalles personalizados del destinatario.
To	array	No	La lista de destinatarios, que es de tipo matriz.
	string	No	La dirección de correo electrónico.	Jackie@example.com
TemplateData	object	No	Los parámetros de la plantilla de correo electrónico, que son del tipo de datos de mapa JSON.
	string	No	La cadena de clave-valor.	{"UserName": "Jackie"}

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
EnvId	string	El ID del evento.	xxx
RequestId	string	El ID de la solicitud.	12D086F6-8F31-4658-84C1-006DED011A85

Ejemplos

Respuesta exitosa

JSON Formato

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

Códigos de error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.