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

Chama ListMessageGroup para consultar a lista de grupos de mensagens de um usuário especificado.

Descrição da operação

Limites de QPS

O limite de QPS por usuário para esta API é de 100 consultas por segundo. Se esse limite for excedido, as chamadas de API serão limitadas, o que pode afetar seus negócios. Você pode chamar esta API a uma taxa razoável. 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:ListMessageGroup

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
UserId	string	Não	ID do usuário, personalizado pelo usuário e deve ser único dentro de um AppId. Usuários diferentes devem usar UserIds diferentes. Nota Você deve preencher corretamente este parâmetro para realizar uma consulta normal.	de1**a0
AppId	string	Não	ID do aplicativo Interactive Messages. Nota Você deve preencher corretamente este parâmetro para realizar uma consulta normal.	VKL3***
SortType	integer	Não	Método de ordenação. Valores válidos: 0: Ordem crescente por tempo. 1: Ordem decrescente por tempo.	1
PageNum	integer	Sim	Número da página. Valor padrão: 1. Valores válidos: 1 a 100000.	10
PageSize	integer	Sim	Número de grupos de mensagens a exibir por página. Valor padrão: 20. Valores válidos: 1 a 50.	20

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Schema da resposta.
RequestId	string	ID da solicitação.	16A96B9A-****-CB92E68F4CD8
Result	object	Resultado retornado.
GroupList	array<object>	Lista de grupos de mensagens.
	array<object>	Detalhes do grupo de mensagens.
AppId	string	Interactive Messages application ID.	VKL3***
CreateTime	integer	UTC timestamp when the message group was created.	1502280113
CreatorId	string	Creator ID.	as****hs
Extension	object	Extension field.
	string	Extension field.	test001
GroupId	string	Message group ID.	AE35-****-T95F
Status	integer	Message group status. The default value is 1, indicating that the message group status is normal.	1
HasMore	boolean	Indica se há uma próxima página. Valores válidos: true: Há uma próxima página. false: Não há uma próxima página.	false
Total	integer	Número total de grupos de mensagens.	5

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "16A96B9A-****-CB92E68F4CD8",
  "Result": {
    "GroupList": [
      {
        "AppId": "VKL3***",
        "CreateTime": 1502280113,
        "CreatorId": "as****hs",
        "Extension": {
          "key": "test001"
        },
        "GroupId": "AE35-****-T95F",
        "Status": 1
      }
    ],
    "HasMore": false,
    "Total": 5
  }
}

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.