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

Descrição da operação

Notas de uso

Primeiro, obtenha as informações de UserId, DeviceId e DeviceType do cliente e passe-as para o servidor. O servidor usa esta API para obter o token de autenticação e o retorna ao cliente. Diferentes usuários precisam usar diferentes UserIds, e diferentes dispositivos terminais precisam usar diferentes DeviceIds.

Limites de QPS

O limite de QPS para esta API é de 100 consultas por segundo (QPS) por usuário. Se você exceder esse limite, as chamadas de API serão limitadas, o que pode afetar suas operações. Você pode chamar esta API com uma frequência razoável. Para mais informações, consulte Limites de QPS.

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

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
AppId	string	Sim	O ID do aplicativo de Mensagens Interativas.	a494caec-***-695ef345db77
DeviceId	string	Sim	O ID do dispositivo terminal, que representa exclusivamente um dispositivo terminal do usuário, definido pelo usuário. Consiste em letras minúsculas, números, underscores (_) e hifens (-), com um comprimento máximo de 64 caracteres. Diferentes dispositivos terminais precisam usar diferentes DeviceIds. Recomendamos obtê-lo do dispositivo terminal e passá-lo ao servidor.	a494caec-***-695ef345db77
DeviceType	string	Sim	O tipo de dispositivo terminal. Valores válidos: ios android web pc	android
UserId	string	Sim	O UserId do usuário, definido pelo usuário, exclusivo dentro do AppId. Consiste em letras minúsculas, números, underscores (_) e pontos (.), com um comprimento máximo de 32 caracteres. Diferentes usuários precisam usar diferentes UserIds.	de1**a0

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Schema da resposta.
RequestId	string	O ID da solicitação.	16A96B9A-****-CB92E68F4CD8
Result	object	Os resultados retornados.
AccessToken	string	O token usado para estabelecer conexões persistentes.	oauth_cloud_key:***-b0YY5Gy6Q
AccessTokenExpiredTime	integer	O tempo de expiração do token de logon em milissegundos.	86400000
RefreshToken	string	O token de atualização. Se o AccessToken expirar, você pode usar o RefreshToken para obter um novo token.	oauth_cloud_key:****-Q62xggOTdgk3gw=

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "16A96B9A-****-CB92E68F4CD8",
  "Result": {
    "AccessToken": "oauth_cloud_key:***-b0YY5Gy6Q",
    "AccessTokenExpiredTime": 86400000,
    "RefreshToken": "oauth_cloud_key:****-Q62xggOTdgk3gw="
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvaildParameter	Invalid Parameter	Invalid request parameter.
403	Forbidden	User not authorized to operate on the specified resource.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.