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

Obtém listas de destinatários.

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

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
PageNo	integer	Não	Este campo obsoleto é mantido para compatibilidade com versões anteriores. Você pode omitir este parâmetro.\n\nO número da página.	1
PageSize	integer	Não	O tamanho da página. Valor padrão: 100.\n\nOmitir este parâmetro retorna todos os resultados. No entanto, como o parâmetro PageNo está obsoleto, o efeito de PageSize na paginação é limitado.	10
KeyWord	string	Não	A palavra-chave para pesquisar listas de destinatários. Se omitida, todas as listas de destinatários serão retornadas.	mesh-notification
Status	integer	Não	Este campo obsoleto é mantido para compatibilidade com versões anteriores. Você pode omitir este parâmetro.\n\nO status da lista. Valores válidos:\n- 0: enviando\n- 1: envio concluído.	1

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
NextStart	string	Um token que indica que há mais resultados disponíveis. Para obter a próxima página de resultados, inclua este token no parâmetro NextStart da sua próxima solicitação.	6aec200853#102#1638894326#test@example.com
PageSize	integer	O número de entradas retornadas por página.	10
RequestId	string	O ID da solicitação.	10A1AD70-E48E-476D-98D9-39BD92193837
TotalCount	integer	A contagem total.	15
data	object
receiver	array<object>	Os detalhes das listas de destinatários.
	object	Os detalhes de uma lista de destinatários.
ReceiversAlias	string	The recipient list alias.	10***@example.com
ReceiversName	string	The recipient list name.	TKP000442-333
CreateTime	string	The creation time.	2019-09-29T13:28Z
ReceiverId	string	The recipient list ID.	0c910a7143044b1e116719eb678907b3
UtcCreateTime	integer	The creation time in UTC.	1569734892
ReceiversStatus	string	This deprecated field is kept for backward compatibility. The list status. Valid values: 0: uploading 1: upload complete	0
Count	string	The recipient address count.	3
Desc	string	The description.	Notification

Exemplos

Resposta de sucesso

JSON formato

{
  "NextStart": "6aec200853#102#1638894326#test@example.com",
  "PageSize": 10,
  "RequestId": "10A1AD70-E48E-476D-98D9-39BD92193837",
  "TotalCount": 15,
  "data": {
    "receiver": [
      {
        "ReceiversAlias": "10***@example.com",
        "ReceiversName": "TKP000442-333",
        "CreateTime": "2019-09-29T13:28Z",
        "ReceiverId": "0c910a7143044b1e116719eb678907b3",
        "UtcCreateTime": 1569734892,
        "ReceiversStatus": "0",
        "Count": "3",
        "Desc": "Notification"
      }
    ]
  }
}

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.