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

Consulta a lista de mensagens de um grupo chamando ListLiveMessageGroupMessages.

Descrição da operação

Antes de chamar esta operação, você deve ter criado um grupo de mensagens interativas chamando CreateLiveMessageGroup.

Limite de QPS

O limite de QPS por usuário para esta operação é de 50 chamadas por segundo. Se o limite for excedido, as chamadas de API serão limitadas, o que pode afetar seus negócios. Chame esta operação adequadamente.

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

list

*Rtc.

acs:live::{#accountId}:rtc/{#AppId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
AppId	string	Sim	O ID do aplicativo de mensagens interativas a ser consultado.	demo
GroupId	string	Sim	O ID do grupo a ser consultado.	grouptest
PageSize	integer	Sim	O número de mensagens a serem exibidas por vez. Valores válidos: [10,50].	10
SortType	integer	Sim	O tipo de ordenação. As mensagens são ordenadas pelo horário em que foram enviadas. Valores válidos: 1: ordem crescente 2: ordem decrescente Valores válidos: 1 : ordem crescente. 2 : ordem decrescente.	1
NextPageToken	integer	Não	A posição inicial da página de consulta. Se este parâmetro for deixado vazio, a primeira página será retornada por padrão.	1
MsgType	integer	Não	O tipo de mensagem a ser consultado. Se este parâmetro for deixado vazio, todos os tipos de mensagem serão retornados por padrão.	1
BeginTime	integer	Não	A hora de início da consulta, expressa como um timestamp UNIX. Unidade: segundos. Se este parâmetro for deixado vazio, a hora mais antiga será usada por padrão.	1697783235
EndTime	integer	Não	A hora de término da consulta, expressa como um timestamp UNIX. Unidade: segundos. Se este parâmetro for deixado vazio, a hora mais recente será usada por padrão.	1698301635
DataCenter	string	Não	O data center. Este valor deve ser consistente com o data center especificado em CreateLiveMessageApp. Os data centers suportados atualmente são Xangai (cn-shanghai) e Singapura (ap-southeast-1).	cn-shanghai

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
RequestId	string	O ID da solicitação.	1668FDC3-63D7-102F-B5D4-3D2F91D1****
GroupId	string	O ID do grupo a ser consultado.	grouptest
NextPageToken	integer	A posição inicial da próxima página. O valor é 0 se não houver próxima página.	0
Hasmore	boolean	Indica se há uma próxima página.	false
MessageList	array<object>	A lista de mensagens.
	array<object>	Os detalhes da lista.
Sender	object	Os detalhes do remetente da mensagem.
UserId	string	O ID do usuário que enviou a mensagem.	uid2
UserInfo	string	As informações adicionais sobre o usuário que enviou a mensagem.	testusermeta2
Body	string	O corpo da mensagem.	step2 helo, cc group
Timestamp	integer	A hora em que a mensagem foi criada, expressa como um timestamp UNIX. Unidade: segundos.	1697081134
MsgTid	string	O identificador da mensagem.	c-1-1-0
MsgType	integer	O tipo de mensagem.	2
SeqNumber	integer	O número de sequência da mensagem.	1
TotalMessages	integer	O número total de mensagens.	1

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "1668FDC3-63D7-102F-B5D4-3D2F91D1****",
  "GroupId": "grouptest",
  "NextPageToken": 0,
  "Hasmore": false,
  "MessageList": [
    {
      "Sender": {
        "UserId": "uid2",
        "UserInfo": "testusermeta2"
      },
      "Body": "step2 helo, cc group",
      "Timestamp": 1697081134,
      "MsgTid": "c-1-1-0",
      "MsgType": 2,
      "SeqNumber": 1,
      "TotalMessages": 1
    }
  ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InputInvalid	%s.	Os parâmetros de entrada são inválidos.
500	ServerError	%s.	Ocorreu um erro desconhecido. Tente novamente mais tarde ou abra um ticket.
403	NoAuth	%s.	Você não tem as permissões necessárias.
404	ResourceNotExist	%s.	O recurso solicitado não existe. Verifique a solicitação e tente novamente.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.