Envia uma mensagem a um usuário específico, identificado pelo ReceiverId.
Descrição da operação
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 essa restrição ao chamar esta API.
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. 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 executar a fim de 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:SendLiveMessageUser | crie | *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 de destino da mensagem. | demo |
| ReceiverId | string | Sim | ID do usuário destinatário da mensagem. O ID pode ter até 64 bytes e conter letras e dígitos. Nota
Certifique-se de que o usuário destinatário esteja online. Chame a operação CheckLiveMessageUsersOnline para verificar o status de conexão do usuário.
| uid2 |
| SenderId | string | Sim | ID do usuário remetente da mensagem. O ID pode ter até 64 bytes e conter letras e dígitos. | uid1 |
| SenderInfo | string | Não | Informações adicionais sobre o usuário remetente. Pode ter até 512 bytes. | uid1meta1 |
| Body | string | Não | Corpo da mensagem. Pode ter até 15 KB. | hello, user |
| MsgType | long | Não | Tipo da mensagem. | 2 |
| MsgTid | string | Não | ID da mensagem. Este identificador único permite excluir a mensagem posteriormente. O ID pode ter até 64 bytes e conter letras e dígitos. | 169830**** |
| DataCenter | string | Não | Data center. Deve corresponder 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 |
| HighReliability | boolean | Não | Define se a mensagem deve ser tratada como altamente confiável. Uma mensagem altamente confiável garante retorno de sucesso apenas após o destinatário recebê-la e responder. Se não houver resposta em 3 segundos, o sistema retorna falha.
Nota
Este parâmetro tem suporte apenas no SDK cliente V1.5.1 ou posterior. Ao enviar uma mensagem para um cliente com versão anterior do SDK, o envio ocorre com sucesso sem aguardar resposta de confirmação (ACK).
| false |
| Storage | boolean | Não | Indica se a mensagem deve ser armazenada.
| false |
Parâmetros de resposta
|
Parâmetro |
Tipo |
Descrição |
Exemplo |
|
object |
Parâmetros da resposta. |
||
|
RequestId |
string |
ID da solicitação. |
6CFDE7AB-571A-14EA-B072-989FF753**** |
|
MsgTid |
string |
ID da mensagem. Este identificador único permite excluir a mensagem. O ID pode ter até 64 bytes e conter letras e dígitos. |
169830**** |
Exemplos
Exemplos de respostas de sucesso
Formato JSON
{
"RequestId": "6CFDE7AB-571A-14EA-B072-989FF753****",
"MsgTid": "169830****"
}
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 |
|
408 |
UserNotAck |
%s. |
Mensagem altamente confiável enviada ao usuário, mas sem resposta. |
|
500 |
ServerError |
%s. |
Erro desconhecido. Tente novamente mais tarde ou abra um ticket para suporte. |
Para obter uma lista completa de códigos de erro, consulte os Códigos de erro do serviço.
Histórico de alterações
|
Data da alteração |
Resumo das alterações |
Operação |
|
2025-01-23 |
Alteração nos códigos de erro, nos parâmetros de solicitação e na estrutura de resposta da API |