Consulta os grupos de mensagens interativas em um aplicativo de mensagens interativas.
Descrição da operação
Antes de chamar esta operação, certifique-se de ter chamado a operação CreateLiveMessageGroup para criar um grupo de mensagens interativas.
Limite de QPS
Você pode chamar esta operação até 50 vezes por segundo por conta. O sistema descarta solicitações que excedem esse limite, o que pode causar interrupções no serviço. Considere esse limite ao executar esta operação.
Depuração
Informações de autorização
A tabela a seguir apresenta as informações de autorização correspondentes à API. Use essas informações no elemento de política Action para conceder permissões a um usuário RAM ou função RAM e permitir a chamada desta operação da API. Descrição:
Operação: valor usado no elemento Action para especificar a ação sobre um recurso.
Nível de acesso: nível de acesso de cada operação. Os níveis disponíveis são leitura, escrita e listagem.
-
Tipo de recurso: tipo de recurso no qual o usuário RAM ou a função RAM recebe autorização para executar a operação. Observe os seguintes pontos:
Tipos de recursos obrigatórios são indicados com o prefixo * .
Se não for possível conceder permissões no nível do recurso, use
All Resourcesna coluna Tipo de recurso da operação.
Operação associada: outras operações que o usuário RAM ou a função RAM precisam ter permissão para concluir a operação principal. Para finalizar a tarefa, é necessário possuir permissões também nas operações associadas.
Chave de condição: chave de condição definida pelo serviço de nuvem.
| Operação | Nível de acesso | Tipo de recurso | Chave de condição | Operação associada |
|---|---|---|---|---|
| live:ListLiveMessageGroups | list | *Rtc acs:live::{#accountId}:rtc/{#AppId} |
| none |
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 no horário de criação dos grupos. Valores válidos:
| 1 |
| NextPageToken | long | Não | Número da página inicial para a consulta. Se este parâmetro estiver vazio, a consulta começa na primeira página. | 1001 |
| GroupStatus | integer | Não | Status dos grupos a serem consultados. Valor padrão: 0. Valores válidos:
| 1 |
| DataCenter | string | Não | O data center. Deve ser igual ao data center especificado ao chamar a operação CreateLiveMessageApp para criar o aplicativo de mensagens interativas. Valores válidos: cn-shanghai e ap-southeast-1 (Singapura). | cn-shanghai |
Parâmetros de resposta
|
Parâmetro |
Tipo |
Descrição |
Exemplo |
|
object |
|||
|
RequestId |
string |
O ID da solicitação. |
B5D95365-5A46-1A6A-BBF5-C7B6BDED**** |
|
Hasmore |
boolean |
Indica se há mais páginas após a página atual. |
false |
|
NextpageToken |
string |
Número da página inicial para a próxima consulta. Este parâmetro é retornado apenas se o valor de Hasmore for true. |
1001 |
|
GroupList |
array |
Detalhes sobre os grupos. |
|
|
Groups |
object |
Detalhes sobre os grupos. |
|
|
GroupId |
string |
O ID do grupo. |
cU9MeBqf**** |
|
CreatorId |
string |
O ID do criador do grupo. |
user_77 |
|
AdminList |
array |
Lista de IDs dos administradores do grupo. |
|
|
Admins |
string |
Administrador. |
uid1 |
|
Createtime |
long |
Horário de criação do grupo. O valor é um timestamp UNIX. Unidade: segundos. |
1698299727 |
|
GroupName |
string |
Nome do grupo. |
mytestgroup |
|
GroupInfo |
string |
Informações adicionais sobre o grupo. |
testgroupinfo |
|
Delete |
boolean |
Indica se o grupo foi excluído. |
true |
Exemplos
Exemplos de respostas de sucesso
Formato JSON
{
"RequestId": "B5D95365-5A46-1A6A-BBF5-C7B6BDED****",
"Hasmore": false,
"NextpageToken": 1001,
"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. |
Parâmetros de entrada inválidos |
|
403 |
NoAuth |
%s. |
Sem permissão |
|
404 |
ResourceNotExist |
%s. |
O recurso solicitado não existe. Verifique e tente novamente |
|
500 |
ServerError |
%s. |
Erro desconhecido. Tente novamente mais tarde ou envie um ticket para consulta. |
Para obter uma lista completa de códigos de erro, visite os Códigos de erro do serviço.
Histórico de alterações
|
Data da alteração |
Resumo das alterações |
Operação |
|
2024-05-23 |
O código de erro foi alterado. Os parâmetros de solicitação da API foram modificados |