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

Descrição da operação

Antes de chamar esta operação, você já deve ter criado um grupo de mensagens interativas ao chamar CreateLiveMessageGroup.
Para grupos supergrandes (grupos com mais de 2.000 membros), as consultas à lista de membros não são mais suportadas. Além disso, as notificações de entrada ou saída de membros do grupo são enviadas em intervalos de pelo menos 5 segundos. As notificações não exibem a lista completa de usuários que entraram ou saíram, mas exibem a contagem exata de membros do grupo. Depois que um grupo é atualizado para um grupo supergrande, a lista de membros é limpa imediatamente. O grupo não pode ser revertido para um grupo regular até que todos os membros saiam do grupo (o grupo é fechado). Quando o grupo é reaberto, ele é restaurado como um grupo regular.

Limite de QPS

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

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

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 interativo ao vivo a ser consultado.	demo
GroupId	string	Sim	O ID do grupo a ser consultado.	grouptest
PageSize	integer	Sim	O número de usuários a serem exibidos por página. Valores válidos: 10 a 50.	10
SortType	integer	Sim	A ordem de classificação. Os usuários são classificados pela hora em que entraram no grupo. 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
DataCenter	string	Não	O data center. Este valor deve ser igual ao data center especificado em CreateLiveMessageApp. Valores válidos: cn-shanghai (Xangai) e ap-southeast-1 (Singapura).	cn-shanghai

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
RequestId	string	O ID da solicitação.	A1D75BEA-1329-116F-B29C-76F3F200****
GroupId	string	O ID do grupo a ser consultado.	grouptest
NextPageToken	integer	A posição inicial da próxima página. Um valor 0 indica que não há próxima página.	0
Hasmore	boolean	Indica se há uma próxima página.	false
UserList	array<object>	O array de objetos.
	object	Os detalhes do array.
UserId	string	O ID do usuário.	uid1
UserInfo	string	As informações estendidas do usuário.	info1

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "A1D75BEA-1329-116F-B29C-76F3F200****",
  "GroupId": "grouptest",
  "NextPageToken": 0,
  "Hasmore": false,
  "UserList": [
    {
      "UserId": "uid1",
      "UserInfo": "info1"
    }
  ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
420	SuperLargeGroup	%s.	Quando o grupo tem mais de 2000 membros, ele é atualizado para um supergrupo e não oferece mais suporte à consulta da lista de usuários.
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.