GetTrackList - Direct Mail: Central de Documentação do Alibaba Cloud

Recupera dados sobre e-mails enviados.

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:GetTrackList

list

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
StartTime	string	Sim	A data de início da consulta. A data deve estar dentro dos últimos 30 dias. O formato é `yyyy-MM-dd`.	2019-09-29
EndTime	string	Sim	A data de término da consulta. A duração entre StartTime e EndTime não pode exceder 7 dias. O formato é `yyyy-MM-dd`. [_single.params.Total.desc](Este campo está obsoleto) [parameters.2.schema.description](Este campo está obsoleto)	2019-09-29
Total	string	Não	(This field is deprecated)	(This field is deprecated.)
Offset	string	Não	Defina como 0 para a primeira consulta. Para consultas subsequentes, defina como 1 para realizar uma consulta paginada em ordem cronológica. (Este campo está obsoleto)	(This field is deprecated.)
PageSize	string	Não	O número de entradas a serem retornadas em cada página.	10
OffsetCreateTime	string	Não	Usado para paginação. Não defina este parâmetro para a primeira consulta. Para consultas subsequentes, defina este parâmetro com o valor `OffsetCreateTime` retornado na resposta anterior. (Este campo está obsoleto) [_single.params.OffsetCreateTimeDesc.desc](Este campo está obsoleto) [parameters.6.schema.description](Este campo está obsoleto)	(This field is deprecated.)
OffsetCreateTimeDesc	string	Não	(This field is deprecated)	(This field is deprecated.)
PageNumber	string	Não	O número da página a ser retornado.	1
AccountName	string	Não	O endereço do remetente. Nota Se você omitir este parâmetro, a consulta retornará dados de todos os endereços de remetente. Este parâmetro é obrigatório se você especificar o parâmetro `TagName`.	test@example.com
TagName	string	Não	O nome da tag.	tagname
DedicatedIpPoolId	string	Não	O ID do pool de IPs dedicados a ser consultado. Se este parâmetro for omitido, os dados de todos os pools de IPs serão retornados.	xxx
DedicatedIp	string	Não	O endereço IP dedicado a ser consultado. Se este parâmetro for omitido, os dados de todos os IPs dedicados serão retornados.	xxx.xxx.xxx.xxx
Esp	string	Não	O Provedor de Serviços de E-mail (ESP) a ser consultado. Valores válidos: gmail.com yahoo.com outlook.com icloud.com Others: Qualquer ESP não listado acima. Se você omitir este parâmetro, a consulta retornará dados de todos os ESPs.	gmail.com
ConfigSetId	string	Não	O ID do conjunto de configurações. [_single.resp.200.props.OffsetCreateTimeDesc.desc](Este campo está obsoleto.) [responses.200.schema.properties.OffsetCreateTimeDesc.description](Este campo está obsoleto.)	xxx
Domain	string	Não		dmdomain.com

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
OffsetCreateTimeDesc	string	(This field is deprecated.)	(This field is deprecated.)
OffsetCreateTime	string	Usado para paginação. Não defina este parâmetro para a primeira solicitação. Para solicitações subsequentes, defina este parâmetro com o valor OffsetCreateTime da resposta anterior. (Este campo está obsoleto.)	(This field is deprecated.)
RequestId	string	O identificador exclusivo da solicitação.	10A1AD70-E48E-476D-98D9-39BD92193837
PageNo	integer	O número da página atual.	1
PageSize	integer	O número de entradas retornadas por página.	10
Total	integer	O número total de registros correspondentes.	100
TotalPages	integer	O número total de páginas.	2
data	object
stat	array<object>	Uma lista de registros de dados de rastreamento.
	object
RcptClickRate	string	The click-through rate.	0
RcptUniqueOpenCount	string	The number of unique opens.	0
RcptClickCount	string	The number of clicks.	0
RcptUniqueClickCount	string	The number of unique clicks.	0
CreateTime	string	The time the record was created.	2019-09-29T13:28Z
RcptUniqueOpenRate	string	The unique open rate.	0
RcptUniqueClickRate	string	The unique click-through rate.	0
TotalNumber	string	The total number of emails sent.	0
RcptOpenRate	string	The open rate.	0
RcptOpenCount	string	The number of opens.	0

Exemplos

Resposta de sucesso

JSON formato

{
  "OffsetCreateTimeDesc": "(This field is deprecated.)",
  "OffsetCreateTime": "(This field is deprecated.)",
  "RequestId": "10A1AD70-E48E-476D-98D9-39BD92193837",
  "PageNo": 1,
  "PageSize": 10,
  "Total": 100,
  "TotalPages": 2,
  "data": {
    "stat": [
      {
        "RcptClickRate": "0",
        "RcptUniqueOpenCount": "0",
        "RcptClickCount": "0",
        "RcptUniqueClickCount": "0",
        "CreateTime": "2019-09-29T13:28Z",
        "RcptUniqueOpenRate": "0",
        "RcptUniqueClickRate": "0",
        "TotalNumber": "0",
        "RcptOpenRate": "0",
        "RcptOpenCount": "0"
      }
    ]
  }
}

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.