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

Descrição da operação

O limite de QPS para esta API é de 200 chamadas por segundo por usuário. Se esse limite for excedido, as chamadas de API serão limitadas, o que pode afetar seus negócios. Utilize esta API de forma responsável.

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

update

*Domain

acs:live:*:{#accountId}:domain/{#DomainName}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
AppId	string	Sim	ID do aplicativo de mensagens interativas.	a494caec-***-695ef345db77
GroupId	string	Sim	O ID do grupo de mensagens ao qual ingressar. Certifique-se de que o GroupId fornecido existe.	AE35-****-T95F
UserId	string	Sim	ID do usuário, personalizado pelo usuário e deve ser único sob o AppId. Pode conter letras minúsculas, números, underscores (_) e pontos (.). O comprimento máximo é de 32 caracteres. Usuários diferentes devem usar UserIds diferentes.	de1**a0
BroadCastType	integer	Não	Tipo de difusão de mensagens do sistema. Valores válidos: 0 (padrão): Sem difusão. 1: Difusão para usuários especificados. 2: Difusão para o grupo.	2
BroadCastStatistics	boolean	Não	Especifica se as mensagens de estatísticas devem ser transmitidas. Quando ativado, as informações de estatísticas do grupo de mensagens serão transmitidas após o ingresso no grupo de mensagens, e o cliente pode receber e processar essa mensagem. Valores válidos: true: Transmitir mensagens de estatísticas. false: Não transmitir mensagens de estatísticas.	true

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Schema da resposta.
RequestId	string	ID da solicitação.	16A96B9A-****-CB92E68F4CD8
Result	object	Resultado retornado.
Success	boolean	Indica se o ingresso no grupo de mensagens foi bem-sucedido. Valores válidos: true: Bem-sucedido. false: Malsucedido.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "16A96B9A-****-CB92E68F4CD8",
  "Result": {
    "Success": true
  }
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.