Cria um aplicativo de mensagens interativas chamando CreateLiveMessageApp.
Descrição da operação
Ao chamar outras operações de API de mensagens interativas, o data center deve ser o mesmo especificado ao criar o aplicativo de mensagens interativas.
Um máximo de 300 aplicativos de mensagens interativas pode ser criado em uma única conta Alibaba Cloud.
Limite de QPS
O limite de QPS por usuário para esta operação de API é de 50 chamadas por segundo. Se esse limite for excedido, a chamada de API será limitada, o que pode afetar seus negócios. Chame esta operação adequadamente.
Experimente agora
Testar
Autorização RAM
|
Ação |
Nível de acesso |
Tipo de recurso |
Chave de condição |
Ação dependente |
|
live:CreateLiveMessageApp |
create |
*Todos os recursos.
|
Nenhuma | Nenhuma |
Parâmetros da solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
Exemplo |
| AppName |
string |
Não |
O nome do aplicativo. O nome deve ter de 2 a 16 caracteres. |
testApp |
| AuditType |
integer |
Não |
O modo de auditoria de segurança. Valores válidos:
Valores válidos:
|
2 |
| AuditUrl |
string |
Não |
A URL para auditoria de segurança personalizada. Este parâmetro é obrigatório quando a auditoria de segurança personalizada é selecionada (AuditType=2). A URL deve começar com http:// ou https://, não deve conter endereços IP privados e não deve incluir números de porta. Para o formato do conteúdo de auditoria de segurança personalizada, consulte a seção a seguir. |
http://demo.aliyundoc.com/exampleaudit |
| EventCallbackUrl |
string |
Não |
A URL de callback de eventos para logon, logout, entrada em grupo e saída de grupo do cliente. Se este parâmetro estiver vazio, os callbacks de eventos serão desativados. Para as operações de API de callback acionadas, consulte Acesso do cliente. A URL de callback de eventos deve começar com http:// ou https://, não deve conter endereços IP privados e não deve incluir números de porta. Para o formato de callback de eventos e a lógica de autenticação de callback, consulte a seção a seguir. |
http://demo.aliyundoc.com/examplecallback |
| DataCenter |
string |
Não |
O data center. Valores válidos:
Nota
Ao chamar outras operações de API de mensagens interativas, o data center deve ser o mesmo especificado ao criar o aplicativo de mensagens interativas. |
cn-shanghai |
| MsgLifeCycle |
integer |
Não |
O nível de duração de armazenamento para mensagens de grupo dentro do aplicativo. Valores válidos:
|
1 |
Descrição do conteúdo de auditoria de segurança personalizada:
Protocolo de solicitação: HTTP
Método de solicitação: POST
Exemplo de solicitação:
{
"content": "testaudit"
}
Exemplo de resposta:
{
"pass": true,
"reason":"****" |pass definido como true indica que o conteúdo passou na auditoria. Caso contrário, o conteúdo não passou. reason indica o motivo da rejeição.
}
Um código de status HTTP 200 indica sucesso. Um código de status diferente de 200 indica que o serviço está indisponível, e o sistema degrada ignorando a auditoria da mensagem.
Callback de eventos
HTTP/HTTPS POST. O corpo é uma string JSON UTF-8 no seguinte formato. Exemplo de callback de eventos:
{
"appid":"demo",
"eves":[{
"uid":"uid1",
"sid":"sessionid",
"events":[{
"e": 3, |Tipo de evento. Enumeração. 1: logon, 2: logout, 3: joingroup, 4: leavegroup, 5: reconexão do cliente após desconexão de rede
"r": 1, |Motivo do logout. Este atributo não está presente para outros eventos. Enumeração. 1: chamada normal, 3: tempo limite, 4: logon realizado em outro dispositivo
"g": "testgroup", |ID do grupo. Este valor está presente para eventos de entrada e saída de grupo. Este atributo não está presente para eventos de logon e logout.
"gs":["testgroupid"] |Lista de IDs de grupos. Quando o cliente se reconecta após uma desconexão de rede, isso contém os grupos aos quais o cliente entrou. Este atributo não está presente para outros eventos.
}]
}]
}
Um código de status HTTP 200 indica sucesso. Outros códigos de status indicam falha, e o sistema tenta reenviar a entrega.
Descrição da autenticação de callback
Quando o serviço inicia uma solicitação, o cabeçalho da solicitação HTTP(S) inclui os campos Ali-Live-Timestamp e Ali-Live-Signature para que o servidor receptor de mensagens de callback realize a autenticação de assinatura. O valor de Ali-Live-Signature é calculado da seguinte forma: Ali-Live-Signature=sha256(CONTENT). CONTENT = nome de domínio de callback + valor de Ali-Live-Timestamp + chave de autenticação. O nome de domínio de callback é o nome de domínio configurado na URL de callback. A chave de autenticação é a AppKey gerada quando o AppId foi criado.
Elementos de resposta
|
Elemento |
Tipo |
Descrição |
Exemplo |
|
object |
Os parâmetros de resposta. |
||
| RequestId |
string |
O ID da solicitação. |
65EEDBEB-43FE-1E15-976F-3DDD753A**** |
| AppId |
string |
O ID do aplicativo, usado para operações subsequentes, como entrada em grupos. |
demo |
| AppKey |
string |
A AppKey, usada para gerar autenticação para várias operações relacionadas ao AppId. |
********************************** |
| AppSign |
string |
A assinatura do aplicativo. O SDK do serviço de mensagens interativas requer essa informação. |
************************************************************************** |
| DataCenter |
string |
O data center. |
cn-shanghai |
Exemplos
Resposta de sucesso
JSON formato
{
"RequestId": "65EEDBEB-43FE-1E15-976F-3DDD753A****",
"AppId": "demo",
"AppKey": "**********************************",
"AppSign": "**************************************************************************",
"DataCenter": "cn-shanghai"
}
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. |
| 400 | ErrorInvalidAppName | %s. | O AppName é inválido. Verifique o valor e tente novamente. |
| 400 | ErrorTooManyApps | %s. | No máximo 300 aplicativos podem ser criados para cada conta simultaneamente. |
| 400 | ErrorInvalidEventCallbackUrl | %s. | O EventCallbackUrl é inválido. Verifique o valor e tente novamente. |
| 400 | ErrorInvalidAuditUrl | %s. | O AuditUrl é inválido. Verifique o valor e tente novamente. |
| 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.