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

Consulta a lista de grupos de mensagens interativas com suporte à paginação.

Descrição da operação

Antes de chamar esta operação, você deve ter chamado CreateLiveMessageGroup para criar um grupo de mensagens interativas.

Limite de QPS

O limite de QPS por usuário único 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:ListLiveMessageGroupByPage

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.	demo
SortType	integer	Sim	A ordem de classificação, baseada na hora de criação do grupo. Valores válidos: 1: Ordem ascendente. 2: Ordem descendente. Valores válidos: 1 : ordem ascendente. 2 : ordem descendente.	1
PageSize	integer	Não	O tamanho da página. Valores válidos: [1,50]. Valor padrão: 20.	20
PageNumber	integer	Não	O número da página. Valores válidos: [1,10000]. Valor padrão: 1.	1
GroupStatus	integer	Não	O status do grupo. Valor padrão: 0. Valores válidos: 0: Consulta todos os grupos. 1: Consulta grupos que não foram excluídos. 2: Consulta grupos excluídos. Valores válidos: 0 : consulta todos os grupos. 1 : consulta grupos que não foram excluídos. 2 : consulta grupos excluídos.	1
DataCenter	string	Não	O data center. Este valor deve ser igual ao 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	Esquema da resposta.
RequestId	string	O ID da solicitação.	B5D95365-5A46-1A6A-BBF5-C7B6BDED****
TotalCount	integer	O número total de entradas.	50
PageNumber	integer	O número da página atual dos dados retornados.	1
PageSize	integer	O tamanho da página.	20
GroupList	array<object>	A lista de grupos.
	object	O objeto do grupo.
GroupId	string	O ID do grupo.	cU9MeBqf****
CreatorId	string	O ID do criador.	user_77
AdminList	array	A lista de IDs de usuários administradores.
	string	O ID do usuário administrador.	uid1
Createtime	integer	A hora de criação, expressa como um timestamp UNIX. Unidade: segundos.	1698299727
GroupName	string	O nome do grupo.	mytestgroup
GroupInfo	string	As informações estendidas do grupo.	testgroupinfo
Delete	boolean	Indica se o grupo foi excluído.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "B5D95365-5A46-1A6A-BBF5-C7B6BDED****",
  "TotalCount": 50,
  "PageNumber": 1,
  "PageSize": 20,
  "GroupList": [
    {
      "GroupId": "cU9MeBqf****",
      "CreatorId": "user_77",
      "AdminList": [
        "uid1"
      ],
      "Createtime": 1698299727,
      "GroupName": "mytestgroup",
      "GroupInfo": "testgroupinfo",
      "Delete": true
    }
  ]
}

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.