Skip to main content

Referência da API HappyOyster-Directing-Enter Travel

O cliente usa o ticket para criar uma Viagem real e obter a configuração de ingresso no RTC e a versão da capacidade de Direção. creationModel determina as interfaces de controle que a Viagem pode chamar.

Escopo

O cliente usa o ticket para criar uma Viagem real e obter a configuração de ingresso no RTC. Antes de chamar, confirme o seguinte:
  • Autenticação: A API Key primária não é obrigatória; o ticket completa a validação de entrada na sala. Para saber como obtê-lo, veja Obter credenciais de autenticação.
  • Pré-requisitos: O ticket é obtido em Obter Credencial da Travel, não está expirado nem foi usado, e o status do seu Mundo é ready.
  • Chamador: Chamado pelo seu cliente.

Solicitação HTTP

  • Singapore
  • EUA (Virgínia)
POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/enter-travelSubstitua {WorkspaceId} pelo seu ID do Workspace real.

Parâmetros da solicitação

  • Entrar na travel (cliente)
curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/enter-travel' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
    -H 'Content-Type: application/json' \
    -d '{
    "ticket": "{ticket}"
}'
Content-Typestring(Obrigatório)Tipo de conteúdo da solicitação. Este parâmetro deve ser definido como application/json.
Authorization string (Obrigatório)Autenticação por Chave de API. A Chave de API primária não é obrigatória; tanto a chave primária quanto uma temporária podem chamá-lo.
  • API Key Primária: começa com sk-, ex. sk-xxx.
  • Chave de API Temporária: começa com st-, por exemplo, st-xxx.
Corpo da solicitação
ticket string (Obrigatório)Uma credencial de uso único, não expirada e não utilizada, obtida em Obter Credencial da Travel. Reutilizar o mesmo ticket retorna 401011.
A entrada na viagem de Direção não consome maxExperienceTimeSec; não o passe. Este campo só tem efeito para Aventura; se um nível inválido for passado, 400000 é retornado antes do roteamento do modelo. A resposta de sucesso ainda é null.

Parâmetros de resposta

Entered successfully
{
    "code": 0,
    "message": null,
    "data": {
        "encryptedTravelId": "trvl_a1b2****",
        "encryptedWorldId": "enc_a1b2****",
        "mode": 2,
        "creationModel": "simple",
        "playUrl": null,
        "firstFrame": "https://cdn.happyoyster.com/frames/world_xyz789.jpg",
        "rtcConfig": {
            "channelId": "stream_abc123",
            "appId": "18bca2e3218c46aebf8ff3a32fb12311",
            "token": "007eJxTYOh...",
            "userId": "user_1"
        },
        "version": "storyV2",
        "aspectRatio": null,
        "noStreamAutoEndTimeoutSec": 30,
        "maxExperienceTimeSec": null
    }
}
code integerCódigo de retorno. 0 indica sucesso; diferente de zero é um código de erro.
message stringMensagem de erro. null em caso de sucesso.
data objectDados da resposta. null em caso de falha.

Propriedades

encryptedTravelId stringO ID de Viagem criptografado recém-criado. Usado para consultas subsequentes de Consultar Status da Viagem, retrocesso, pausa, retomada, término e artefatos.encryptedWorldId stringO ID criptografado do Mundo ao qual esta Travel corresponde.mode integerSempre 2 para Direção.creationModel stringsimple ou scriptlist; determina as interfaces de controle que a Viagem pode chamar:
  • simple: instruct, pause, resume, rewind, end
  • scriptlist: update-script, pause, resume, rewind, end (instruct não suportado)
playUrl nullAinda não disponível; fixado em null.firstFrame stringURL do primeiro quadro do Mundo.rtcConfig objectConfiguração de entrada RTC; null quando não há canal de streaming disponível, caso em que o cliente não pode iniciar a reprodução com base nela.
  • channelId: ID do canal RTC
  • appId: ID do aplicativo RTC atribuído pela plataforma
  • token: Token de entrada RTC
  • userId: ID de usuário de entrada RTC, fixado em user_1
version stringA versão de entrada na sala de Direção, fixada como storyV2.aspectRatio nullFixado como null para o modelo de Direção.noStreamAutoEndTimeoutSec integerTempo limite de término automático sem fluxo em segundos, padrão de 30; a resposta real prevalece. Se rtcStatus não entrar no estado de streaming dentro deste tempo após entrar na sala, chame Encerrar Travel com failCode=TRAVEL_NO_STREAM_AUTO_END.maxExperienceTimeSec nullFixado como null para o modelo de Direção.

Estados pré-requisitos e notas de chamada

  • O Mundo correspondente ao ticket deve estar ready, e o ticket não deve estar expirado nem usado.
  • Não passe maxExperienceTimeSec. A Direção não limita o tempo de experiência por este campo.
  • Uma chamada bem-sucedida cria a Travel; reutilizar o mesmo ticket retorna 401011.
  • Quando creationModel=scriptlist, não chame instruct; use Atualização completa do script em vez disso.
  • rtcConfig=null significa que não há atualmente nenhum canal de streaming disponível, e o cliente não pode iniciar a reprodução com base nele.

Códigos de erro

Se a chamada do modelo falhar e retornar um erro, consulte Códigos de Erro do HappyOyster para resolvê-lo.

Próximos passos

Após entrar na sala com sucesso: