:APIs para envio de dados

Nome

Tipo

Obrigatório

Descrição

Action

String

Sim

Parâmetro obrigatório. Defina o valor como SenderStatisticsByTagNameAndBatchID.

AccountName

String

Não

Endereço do remetente. Se você não especificar este parâmetro, a resposta retornará dados de todos os endereços de remetente.

TagName

String

Não

Tag do e-mail. Se você não especificar este parâmetro, a resposta retornará dados de todas as tags.

StartTime

String

Sim

Início do intervalo de tempo da consulta. A data deve estar dentro dos últimos 30 dias. Formato: yyyy-MM-dd.

EndTime

String

Sim

Fim do intervalo de tempo da consulta. O período não pode exceder 7 dias. Formato: yyyy-MM-dd.

Nome

Tipo

Descrição

TotalCount

Integer

Quantidade total de registros.

Data

Array

Registros de dados.

Nome

Tipo

Descrição

createTime

String

Momento de criação do registro.

faildCount

String

Quantidade de falhas.

requestCount

String

Número de solicitações de envio.

succeededPercent

String

Taxa de sucesso.

successCount

String

Contagem de sucessos.

unavailableCount

String

Volume de e-mails inválidos.

unavailablePercent

String

Ineficiência.

Código de erro

Descrição

Código de status HTTP

Semântica

InvalidDate.Malformed

O formato da hora é inválido.

InvalidDate.NotFound

A hora não foi especificada.

InvalidStartTime.Malformed

O formato da hora inicial é inválido.

InvalidBetweenTime.Malformed

O intervalo de tempo excede o limite permitido.

InvalidMailAddressName.Malformed

O endereço do remetente é inválido.

InvalidMailAddress.NotFound

O endereço do remetente não existe.

InvalidTagName.Malformed

A tag do e-mail é inválida.

InvalidYear.Malformed

O ano especificado é inválido.

InternalError

Ocorreu um erro desconhecido.

Nome

Tipo

Obrigatório

Descrição

Action

String

Sim

Parâmetro obrigatório. Defina o valor como GetTrackListByMailFromAndTagName.

AccountName

String

Não

Endereço do remetente. Se você não especificar este parâmetro, a resposta retornará dados de todos os remetentes. Este parâmetro é obrigatório se você especificar TagName.

TagName

String

Não

Tag do e-mail. Se você não especificar este parâmetro, a resposta retornará dados de todas as tags.

StartTime

String

Sim

Início do período de consulta. A data deve estar dentro dos últimos 30 dias. Formato: yyyy-MM-dd.

EndTime

String

Sim

Término do período de consulta. O intervalo máximo é de 15 dias. Formato: yyyy-MM-dd.

Total

String

Não

Parâmetro descontinuado.

Offset

String

Sim

Defina como 0 na primeira consulta e 1 nas seguintes. O valor 1 indica paginação em ordem cronológica. Parâmetro descontinuado.

PageSize

String

Não

Tamanho da página.

OffsetCreateTime

String

Não

Utilizado para paginação. Não defina este parâmetro na primeira consulta. Nas consultas subsequentes, defina-o com o valor sOffsetCreateTime da resposta anterior. Parâmetro descontinuado.

OffsetCreateTimeDesc

String

Não

Parâmetro descontinuado.

PageNumber

String

Não

Número da página.

Nome

Tipo

Descrição

OffsetCreateTime

String

Usado para paginação.

OffsetCreateTimeDesc

String

Parâmetro descontinuado.

PageNo

Integer

Número da página.

PageSize

Integer

Tamanho da página.

TrackList

Array

Registros de rastreamento de e-mail.

Total

Integer

Parâmetro descontinuado.

Nome

Tipo

Descrição

CreateTime

String

Horário de criação do registro.

RcptClickCount

String

Total de cliques.

RcptOpenCount

String

Total de aberturas.

RcptUniqueClickCount

String

Quantidade de cliques únicos.

RcptUniqueClickRate

String

Taxa de cliques únicos.

RcptUniqueOpenCount

String

Número de aberturas únicas.

RcptUniqueOpenRate

String

Taxa de abertura única.

TotalNumber

String

Total.

Código de erro

Descrição

Código de status HTTP

Semântica

InvalidDate.Malformed

O formato da hora é inválido.

InvalidDate.NotFound

A hora não foi especificada.

InvalidStartTime.Malformed

O formato da hora inicial é inválido.

InvalidBetweenTime.Malformed

O intervalo de tempo excede o limite permitido.

InvalidMailAddressName.Malformed

O endereço do remetente é inválido.

InvalidMailAddress.NotFound

O endereço do remetente não existe.

InvalidTagName.Malformed

A tag do e-mail é inválida.

InvalidYear.Malformed

O ano especificado é inválido.

InternalError

Ocorreu um erro desconhecido.

Nome

Tipo

Obrigatório

Descrição

Action

String

Sim

Parâmetro obrigatório. Defina o valor como GetTrackList.

StartTime

String

Sim

Início do intervalo de consulta. A data deve estar dentro dos últimos 30 dias. Formato: yyyy-MM-dd.

EndTime

String

Sim

Fim do intervalo de consulta. O período não pode ultrapassar 7 dias. Formato: yyyy-MM-dd.

Total

String

Não

Parâmetro descontinuado.

Offset

String

Não

Defina como 0 na primeira consulta e 1 nas seguintes. O valor 1 indica paginação em ordem cronológica. Parâmetro descontinuado.

OffsetCreateTime

String

Não

Aplicado na paginação.

OffsetCreateTimeDesc

String

Não

Parâmetro descontinuado.

PageNumber

String

Não

Número da página.

PageSize

String

Não

Quantidade de registros por página.

Nome

Tipo

Descrição

OffsetCreateTime

String

Utilizado para paginação.

OffsetCreateTimeDesc

String

Parâmetro descontinuado.

Total

Integer

Parâmetro descontinuado.

PageNo

Integer

Número da página.

PageSize

Integer

Quantidade de registros por página.

Data

Array

Registros de rastreamento de e-mail.

Nome

Tipo

Descrição

CreateTime

String

Horário de criação do registro.

RcptClickCount

String

Total de cliques.

RcptOpenCount

String

Total de aberturas.

RcptUniqueClickCount

String

Quantidade de cliques únicos.

RcptUniqueClickRate

String

Taxa de cliques únicos.

RcptUniqueOpenCount

String

Número de aberturas únicas.

RcptUniqueOpenRate

String

Taxa de abertura única.

TotalNumber

String

Total.

RcptClickRate

String

Taxa de cliques.

RcptOpenRate

String

Taxa de abertura.

Código de erro

Descrição

Código de status HTTP

Semântica

InvalidDate.Malformed

O formato da hora é inválido.

InvalidDate.NotFound

A hora não foi especificada.

InvalidStartTime.Malformed

O formato da hora inicial é inválido.

InvalidBetweenTime.Malformed

O intervalo de tempo excede o limite permitido.

InvalidMailAddressName.Malformed

O endereço do remetente é inválido.

InvalidMailAddress.NotFound

O endereço do remetente não existe.

InvalidTagName.Malformed

A tag do e-mail é inválida.

InvalidYear.Malformed

O ano especificado é inválido.

InternalError

Ocorreu um erro desconhecido.

Nome

Tipo

Obrigatório

Descrição

Action

String

Sim

Parâmetro obrigatório. Defina o valor como QueryInvalidAddress.

StartTime

String

Não

Início do intervalo de consulta. A data deve estar dentro dos últimos 30 dias. Formato: yyyy-MM-dd.

EndTime

String

Não

Fim do intervalo de consulta. O período não pode exceder 30 dias. Formato: yyyy-MM-dd.

KeyWord

String

Não

Palavra-chave para filtragem. Se você não especificar este parâmetro, todos os endereços inválidos serão listados.

Length

Integer

Não

Quantidade de registros a retornar por solicitação.

NextStart

String

Não

Posição inicial da consulta.

Nome

Tipo

Descrição

TotalCount

Integer

Quantidade total de registros.

Data

Array

Dados retornados.

NextStart

String

Posição inicial para a próxima consulta.

Nome

Tipo

Descrição

mailDetail

List

Os registros.

Nome

Tipo

Descrição

ToAddress

String

Endereço do destinatário.

LastUpdateTime

String

Última atualização.

UtcLastUpdateTime

Long

Timestamp UNIX da última atualização do endereço.

Nome

Tipo

Obrigatório

Descrição

Action

String

Sim

Parâmetro obrigatório. Defina o valor como SenderStatisticsDetailByParam.

AccountName

String

Não

Endereço do remetente. Se você não especificar este parâmetro, a resposta retornará dados de todos os remetentes. Nota: Você pode deixar AccountName, TagName e ToAddress vazios simultaneamente. No entanto, se especificar um valor para qualquer um desses parâmetros, poderá especificar um valor para apenas um deles. Não é permitido combinar dois ou mais desses parâmetros.

TagName

String

Não

Tag do e-mail. Se você não especificar este parâmetro, a resposta retornará dados de todas as tags.

StartTime

String

Não

Início do intervalo de consulta. O período máximo é de 30 dias. Formato: yyyy-MM-dd HH:mm.

EndTime

String

Não

Fim do intervalo de consulta. O período máximo é de 30 dias. Formato: yyyy-MM-dd HH:mm.

ToAddress

String

Não

Endereço do destinatário. Se você não especificar este parâmetro, a resposta retornará dados de todos os destinatários.

Status

Integer

Não

Status de entrega. Se você não especificar este parâmetro, a resposta retornará dados de todos os status. Valores válidos: 0 (sucesso), 2 (endereço inválido), 3 (spam) e 4 (falha).

Length

Integer

Não

Número de registros na resposta. O valor deve estar entre 1 e 100.

NextStart

String

Não

Controle de paginação. Define o deslocamento da solicitação atual. Se houver mais resultados disponíveis, defina este parâmetro com o valor NextStart da resposta para a próxima solicitação.

Nome

Tipo

Descrição

Data

Array

Dados retornados.

NextStart

String

Usado para paginação. Se houver mais resultados disponíveis, defina o parâmetro NextStart na próxima solicitação com este valor.

Nome

Tipo

Descrição

mailDetail

List

Os registros.

Nome

Tipo

Descrição

ToAddress

String

Endereço do destinatário.

LastUpdateTime

String

Momento da última atualização do registro.

UtcLastUpdateTime

String

Timestamp UNIX da última atualização do registro.

AccountName

String

Endereço do remetente.

Message

String

Detalhes da entrega.

Status

Integer

Status da entrega. Valores válidos: 0 (sucesso), 2 (endereço inválido), 3 (spam) e 4 (outras falhas).

Subject

String

Assunto do e-mail.

ErrorClassification

String

Classificação detalhada do erro. Exemplos:

• SendOk

• SmtpNxBox

etc.