Consultar aplicativo de mensagens interativas
Descrição da operação
O limite desta operação é de 50 chamadas por segundo por conta. O sistema descarta solicitações que excedem esse limite, o que pode causar interrupções no serviço. Considere essa restrição ao chamar 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 de API. Descrição:
Operação: valor utilizado 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, gravação 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 recurso obrigatórios são indicados com o prefixo * .
Quando não for possível conceder permissões no nível do recurso, a coluna Tipo de recurso da operação exibirá
All Resources.
Chave de condição: chave de condição definida pelo serviço de nuvem.
Operação associada: outras operações que o usuário RAM ou a função RAM precisa ter permissão para executar a fim de concluir a operação principal. Para concluir a operação, o usuário RAM ou a função RAM deve possuir permissões para realizar as operações associadas.
| Operação | Nível de acesso | Tipo de recurso | Chave de condição | Operação associada |
|---|---|---|---|---|
| live:DescribeLiveMessageApp | get | *Rtc acs:live::{#accountId}:rtc/{#AppId} |
| none |
Parâmetros da solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
Exemplo |
|
AppId |
string |
Sim |
ID do aplicativo de mensagens interativas a ser consultado. |
demo |
|
DataCenter |
string |
Não |
Data center. Deve corresponder ao data center especificado durante a chamada da 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 | Resultado retornado. | ||
| RequestId | string | ID da solicitação. | 9FB68B5B-ED07-18F0-A3CF-083F4E74**** |
| AppId | string | ID do aplicativo de mensagens interativas. | demo |
| AppName | string | Nome do aplicativo de mensagens interativas. | testApp |
| AppKey | string | AppKey do aplicativo de mensagens interativas. Utilizado para autorizar operações relacionadas ao ID do aplicativo. | ********************************** |
| AppSign | string | Assinatura do aplicativo de mensagens interativas. Necessária para o SDK de mensagens interativas. | ************************************************************************** |
| AuditType | integer | Método de moderação de conteúdo. Valores válidos:
| 2 |
| AuditUrl | string | URL para moderação de conteúdo. Este parâmetro é retornado quando o valor de AuditType é 2. | http://example.aliyundoc.com/exampleaudit |
| EventCallbackUrl | string | URL de callback para eventos como login, logout, entrada em grupo e saída de grupo. Um valor vazio indica que os callbacks estão desativados. | http://example.aliyundoc.com/examplecallback |
| Disable | boolean | Indica se o aplicativo de mensagens interativas está desativado. | false |
| CreateTime | long | Hora de criação do aplicativo de mensagens interativas. O valor é um timestamp UNIX. Unidade: segundos. | 1698305471 |
| ModifyTime | long | Hora da última modificação do aplicativo de mensagens interativas. O valor é um timestamp UNIX. Unidade: segundos. | 1698305471 |
| MsgLifeCycle | integer | Período de retenção das mensagens de grupo no aplicativo. Valores válidos:
| 1 |
| DataCenter | string | Data center. | cn-shanghai |
Exemplos
Exemplos de respostas de sucesso
Formato JSON
{
"RequestId": "9FB68B5B-ED07-18F0-A3CF-083F4E74****",
"AppId": "demo",
"AppName": "testApp",
"AppKey": "****",
"AppSign": "****",
"AuditType": 2,
"AuditUrl": "http://example.aliyundoc.com/exampleaudit",
"EventCallbackUrl": "http://example.aliyundoc.com/examplecallback",
"Disable": false,
"CreateTime": 1698305471,
"ModifyTime": 1698305471,
"MsgLifeCycle": 1,
"DataCenter": "cn-shanghai"
}
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, acesse os Códigos de erro do serviço.
Histórico de alterações
|
Data da alteração |
Resumo das alterações |
Operação |
|
2025-03-26 |
Alteração no código de erro e na estrutura de resposta da API |
|
|
2025-01-23 |
Alteração no código de erro e na estrutura de resposta da API |
|
|
2024-08-01 |
Alteração no código de erro e na estrutura de resposta da API |
|
|
2024-02-22 |
Alteração no código de erro e na estrutura de resposta da API |
|
|
2024-01-09 |
Alteração no código de erro e na estrutura de resposta da API |