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

Envia uma mensagem para um grupo.

Descrição da operação

Antes de chamar esta operação, você deve chamar para criar um grupo de mensagens interativas. Você só pode enviar mensagens para um grupo se o grupo estiver ativo, o que significa que um ou mais usuários ingressaram no grupo. Mensagens offline não são suportadas. Se você não conseguir enviar uma mensagem, verifique se há usuários no grupo. Se quiser enviar uma mensagem offline, recomendamos que armazene a mensagem localmente e a envie depois que os usuários estiverem online.

Limites de QPS

Você pode chamar esta operação até 50 vezes por segundo por conta. As solicitações que excederem esse limite serão descartadas e você poderá sofrer interrupções no serviço. Recomendamos que você considere esse limite ao chamar esta operação.

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:SendLiveMessageGroup

none

*Rtc

acs:live::{#accountId}:rtc/{#AppId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
AppId	string	Sim	O ID do aplicativo de mensagens interativas usado para receber a mensagem.	demo
GroupId	string	Sim	O ID do grupo que recebe a mensagem. Nota Certifique-se de que o GroupId especificado esteja disponível. Caso contrário, um erro ResourceNotExist será retornado.	grouptest
SenderId	string	Sim	O ID do usuário que envia a mensagem. O ID pode ter até 64 bytes de comprimento e pode conter letras e dígitos.	uid1
SenderMetaInfo	string	Não	As informações adicionais sobre o usuário que envia a mensagem. O valor pode ter até 512 bytes de comprimento.	uid1meta1
Body	string	Não	O corpo da mensagem. Pode ter até 15 KB de comprimento.	hello,group
MsgType	integer	Não	O tipo de mensagem. O número total de tipos de mensagens enviadas em um único grupo não pode exceder 30.	1
MsgTid	string	Não	O identificador exclusivo da mensagem. Este parâmetro é usado para excluir a mensagem. O ID pode conter apenas letras e dígitos e pode ter até 64 bytes de comprimento.	169830****
StaticsIncrease	integer	Não	A contribuição da mensagem para o aumento no número de mensagens deste tipo. Valor padrão: 1.	1
Weight	integer	Não	O peso da mensagem. Valor padrão: 1. Para mensagens de baixa prioridade, como curtidas, você pode definir o peso como 1. Para mensagens de texto regulares, como comentários em tela, você pode definir o peso como 5. Para mensagens de alta prioridade, como envelopes vermelhos e presentes, você pode definir o peso como 1000000.	1
NoStorage	boolean	Não	Especifica se o armazenamento de mensagens deve ser desativado. Valores válidos: true e false. Valor padrão: false, o que indica que a mensagem é armazenada por um período de validade de 30 dias. Você pode encontrar a mensagem na resposta da operação ListLiveMessageGroupMessages. Se não precisar armazenar a mensagem, defina este parâmetro como true.	false
NoCache	boolean	Não	Especifica se o armazenamento em cache de mensagens na lista das mensagens mais recentes do grupo deve ser desativado. Valores válidos: true e false. Valor padrão: false, o que indica que a mensagem é armazenada em cache.	false
DataCenter	string	Não	O data center, que deve ser o mesmo data center especificado em CreateLiveMessageApp. Valores válidos: cn-shanghai: Xangai ap-southeast-1: Singapura	cn-shanghai

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os resultados retornados.
RequestId	string	O ID da solicitação.	E4C1245F-597B-1BD1-B9BB-9D220E99****
MsgTid	string	O identificador exclusivo da mensagem, que pode ser usado para excluir a mensagem. O ID pode conter apenas letras e dígitos e pode ter até 64 bytes de comprimento.	169830****

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "E4C1245F-597B-1BD1-B9BB-9D220E99****",
  "MsgTid": "169830****"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InputInvalid	%s.	Illegal input parameters
400	ErrorTooManyMsgTypes	%s.
500	ServerError	%s.	Unknown error, please try again later or submit a ticket for consultation.
403	NoAuth	%s.	No permission
404	ResourceNotExist	%s.	The requested resource does not exist, please check and try again

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.