ListMessage - ApsaraVideo Live: Central de Documentação do Alibaba Cloud

Descrição da operação

Limites de QPS\n\nO limite de QPS por usuário para esta operação de API é de 100 consultas por segundo (QPS). Se o limite for excedido, as chamadas de API serão limitadas, o que pode afetar seus negócios. Você pode chamar a operação de API adequadamente para evitar esse problema. Para mais informações, consulte Limites de QPS.

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

live:ListMessage

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
GroupId	string	Sim	O ID do grupo de mensagens.	AE35-****-T95F
AppId	string	Sim	O ID do aplicativo de mensagens interativas.	VKL3***
Type	integer	Não	O tipo de mensagem definido pelo usuário. O valor deve ser maior que 10000.	10002
SortType	integer	Não	O método de classificação. Valores válidos:\n\n- 0: ordem crescente por tempo.\n\n- 1: ordem decrescente por tempo.	1
PageNum	integer	Sim	O número da página. Valor padrão: 1. Valores válidos: 1 a 100000.	10
PageSize	integer	Sim	O número de usuários exibidos por página. Valor padrão: 20. Valores válidos: 1 a 50.	20

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
RequestId	string	O ID da solicitação.	16A96B9A-****-CB92E68F4CD8
Result	object	Os resultados retornados.
HasMore	boolean	Indica se há uma próxima página. Valores válidos:\n\n- true: Há uma próxima página.\n\n- false: Não há uma próxima página.	false
MessageList	array<object>	A lista de mensagens.
	object
Data	string	The message body, in JSONString format.	test
GroupId	string	The message group ID.	AE35-****-T95F
MessageId	string	The message ID.	qt***
SenderId	string	The message sender ID.	yi***
Type	integer	The message type.	10002

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "16A96B9A-****-CB92E68F4CD8",
  "Result": {
    "HasMore": false,
    "MessageList": [
      {
        "Data": "test",
        "GroupId": "AE35-****-T95F",
        "MessageId": "qt***",
        "SenderId": "yi***",
        "Type": 10002
      }
    ]
  }
}

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.