Padrões de API e SDKs predefinidos multilíngues
A OpenAPI deste produto (Dm/2015-11-23) utiliza o estilo de assinatura RPC. Encapsulamos SDKs para linguagens de programação comuns para desenvolvedores. Os desenvolvedores podem baixar o SDK para chamar diretamente a OpenAPI deste produto sem se preocupar com detalhes técnicos. Se o SDK existente não atender às suas necessidades, você pode usar o mecanismo de assinatura para integração com assinatura própria. Como os detalhes da autoassinatura são muito complexos, isso pode levar cerca de 5 dias úteis. Portanto, recomendamos ingressar em nosso grupo de serviço DingTalk (147535001692) e realizar a integração de assinatura sob orientação especializada.
Antes de usar a API, você precisa preparar sua conta de identidade e chave de acesso (AccessKey) para acessar efetivamente a API por meio de ferramentas cliente (SDK, CLI, etc.). Para obter detalhes, consulte Obter um AccessKey.
Cenários de assinatura personalizada
Se o seu cenário de negócios tiver requisitos especiais e você precisar integrar a API por meio de autoassinatura, recomendamos consultar primeiro nossa equipe de suporte técnico (grupo de serviço DingTalk: 147535001692) para obter orientação profissional e garantir uma integração eficiente.
Preparação de conta e segurança
As contas da Alibaba Cloud têm permissões administrativas completas sobre todos os recursos. Quando um AccessKey é comprometido, todos os recursos associados estarão em risco de acesso não autorizado. Para garantir a segurança, recomenda-se criar um usuário RAM com apenas permissões de acesso à API e configurar seu AccessKey, além de configurar políticas RAM com base no princípio do menor privilégio (PoLP). Use a conta da Alibaba Cloud apenas em cenários específicos em que as permissões da conta da Alibaba Cloud sejam explicitamente necessárias.
Conta
|
API |
Título |
Descrição |
| DescAccountSummary | Obter informações da conta. | Obtém as informações da conta. |
| UpdateUser | Atualizar informações do usuário. | Atualiza as informações da conta. |
| GetUser | Informações do usuário. | Obtém os detalhes da conta. |
Lista de permissões
|
API |
Título |
Descrição |
| AddIpfilter | Add IP Whitelist | Adiciona informações de proteção de IP. |
| DeleteIpfilterByEdmId | Excluir lista de permissões de IP. | Exclui as informações de proteção de IP. |
Proteção de IP
|
API |
Título |
Descrição |
| UpdateIpProtection | Ativar ou desativar o recurso de proteção de IP. | Atualiza a API de proteção de IP. |
| GetIpProtection | Verificar se a proteção de IP está ativada. | Obtém informações de proteção de IP. |
| GetIpfilterList | Lista de filtros de IP. | Obtém as informações de proteção de IP. |
Tarefa
|
API |
Título |
Descrição |
| QueryTaskByParam | Query Job. | Consulta tarefas com base em parâmetros especificados. |
|
API |
Título |
Descrição |
| Estatísticas | Estatísticas | |
| SenderStatisticsByTagNameAndBatchID | Obter dados de envio com base em condições especificadas. | Obtém dados de envio com base em condições especificadas. |
| SenderStatisticsDetailByParam | Obter detalhes de envio. | Consulta os detalhes de envio. |
| GetTrackList | Recupera dados de rastreamento de e-mails enviados. | Recupera dados sobre e-mails enviados. |
| GetTrackListByMailFromAndTagName | Obtém dados de envio de rastreamento de e-mail por endereço do remetente e tag [_single.params.Total.desc](Este campo está obsoleto) | Obtém dados de rastreamento de e-mail que atendem às condições especificadas. [parameters.0.schema.description](Este campo está obsoleto) |
| SingleSendMail | SingleSendMail. | Envia um único e-mail. |
| BatchSendMail | Envio de e-mails em lotes | Envia e-mails em lotes. |
| SendTestByTemplate | Enviar e-mail de teste. | Envia um e-mail de teste usando um modelo. |
Domínio
|
API |
Título |
Descrição |
| CreateDomain | Create Domain. | Cria um domínio. |
| DeleteDomain | Excluir domínio. | Exclui um domínio. |
| ModifyPWByDomain | Define a senha SMTP para um domínio. | Modifica a senha no nível do domínio. |
| QueryDomainByParam | Consultar informações da lista de domínios. | Consulta informações de domínio. |
| CheckDomain | Verificação de domínio. | Verifica o status do domínio. |
| DescDomain | Configurar domínio. | Configura o nome de domínio. |
Endereço
|
API |
Título |
Descrição |
| CreateMailAddress | Create a sender address. | Cria um endereço de remetente. |
| DeleteMailAddress | Excluir endereço de e-mail. | Exclui um endereço de e-mail. |
| ModifyMailAddress | Definir senha SMTP e endereço de resposta para o endereço de envio. | Modifica o endereço de envio. |
| QueryInvalidAddress | Obtenção de informações de endereços inválidos. | NextStart alterado para string. |
| QueryMailAddressByParam | Consultar lista de endereços de remetente. | Consulta a lista de endereços de remetente. |
| ApproveReplyMailAddress | Verificação do endereço de resposta. | Verifica o endereço de resposta. |
| CheckReplyToMailAddress | Verificação do endereço de resposta para envio de e-mails. | Valida o endereço de resposta. |
| DeleteInvalidAddress | Excluir endereço inválido. | Remove os endereços inválidos do banco de dados de endereços inválidos. |
Destinatário
|
API |
Título |
Descrição |
| CreateReceiver | Criar lista de destinatários. | Cria uma lista de destinatários. |
| DeleteReceiver | Exclusão da lista de destinatários. | Exclui a lista de destinatários. |
| DeleteReceiverDetail | Excluir um único destinatário. | Exclui um único destinatário. |
| QueryReceiverByParam | Consulta de listas de destinatários. | Obtém listas de destinatários. |
| QueryReceiverDetail | Consultar detalhes de uma lista de destinatários específica. | Obtém informações detalhadas sobre uma lista de destinatários. |
| SaveReceiverDetail | Create a Single Recipient. | Cria um único destinatário. |
Rótulo
|
API |
Título |
Descrição |
| CreateTag | Create Tag. | Cria uma tag. |
| DeleteTag | Delete Tag. | Exclui uma tag. |
| ModifyTag | Modify Tag. | Modifica uma tag. |
| QueryTagByParam | Consulta de tags. | Chama QueryTagByParam para obter tags. |
IP dedicado
|
API |
Título |
Descrição |
| DedicatedIpPoolCreate | Criar pool de IPs. | Cria um pool de IPs dedicados. |
| DedicatedIpPoolDelete | Excluir pool de IPs. | Exclui um pool de IPs dedicado. |
| DedicatedIpPoolUpdate | Update IP Pool. | Atualiza um pool de IP. |
| DedicatedIpPoolList | Listar pools de IP. | Lista pools de IP. |
| DedicatedIpNonePoolList | Lista de IPs não adicionados ao pool de IPs. | Lista os endereços IP que não estão atribuídos a nenhum pool de IPs. Esta operação é usada para a configuração de pool de IPs. |
| DedicatedIpAutoRenewal | Definir renovação automática de IP. | Define a renovação automática para um endereço IP dedicado. |
| DedicatedIpChangeWarmupType | Update Purchased IP Warmup Method | Atualiza o método de pré-busca para um endereço IP dedicado. |
| DedicatedIpList | Listar endereços IP adquiridos. | Lista os IPs adquiridos. |
Endereço inválido
|
API |
Título |
Descrição |
| ListUserSuppression | Listar endereços inválidos pessoais e do sistema. | Lista endereços inválidos do usuário. |
| CreateUserSuppression | Criar endereço ou domínio inválido. | Cria o endereço inválido do usuário. |
| RemoveUserSuppression | Remover endereços inválidos para indivíduos e sistemas. | Exclui endereços identificados pelo sistema e adicionados manualmente da lista de supressão em nível de usuário. |
| UnblockSending | Remover restrições de envio | Remove restrições de envio causadas por cancelamentos de assinatura ou reclamações. |
| ListBlockSending | ListBlockSending. | Consulta a lista de bloqueio de envio de e-mails. |
Conjunto de configurações
|
API |
Título |
Descrição |
| ConfigSetCreate | ConfigSetCreate. | Cria um conjunto de configurações. Você pode criar até 100 conjuntos de configurações. |
| ConfigSetDelete | ConfigSetDelete. | Exclui conjuntos de configuração. |
| ConfigSetUpdate | ConfigSetUpdate. | Atualiza um conjunto de configurações. |
| ConfigSetDetail | ConfigSetDetail. | Obtém os detalhes de um conjunto de configurações especificado. |
| ConfigSetList | ConfigSetList | Lista os ConfigSets. |
| ConfigSetRelationFromAddress | ConfigSetRelationFromAddress. | Associa um conjunto de configurações a um endereço de remetente. |
| ConfigSetCancelRelationFromAddress | ConfigSetCancelRelationFromAddress. | Desassocia um endereço de remetente de um conjunto de configurações. |
Modelo
|
API |
Título |
Descrição |
| DeleteTemplate | Delete template | Queries template information. |
| ModifyTemplate | Modificar modelo de e-mail | Modifica um modelo de e-mail. |
| CreateTemplate | CreateTemplate. | Cria um novo modelo de e-mail no DirectMail. |
| DescTemplate | View template information | Queries template information. |
| QueryTemplateByParam | Paging query of template list information | Queries template list information by paging. |
Verificação de endereço
|
API |
Título |
Descrição |
| GetValidationQuota | GetValidationQuota. | Obtém a cota de validação de e-mail. |
| ValidateEmail | Validate an email address | Valida um endereço de e-mail. |
| SendValidateFile | SendValidateFile. | Faz o upload da lista de endereços a serem verificados. |
| GetValidateFileStatus | GetValidateFileStatus. | Obtém o status de uma tarefa de validação de arquivo. |
| GetValidateFile | GetValidateFile. | Obtém o arquivo de resultados de uma tarefa de validação em lote. |
| DeleteValidateFile | DeleteValidateFile. | Exclui o arquivo de verificação após a conclusão do processo de verificação. |
Outros
|
API |
Título |
Descrição |
| ListValidateFile | ListValidateFile. | Obtém uma lista de arquivos de validação carregados. |