Skip to main content

Referência da API HappyOyster-Adventure-End Travel

Encerre ativamente uma Adventure Travel. Após um término normal, ela entra em completed; em um término por tempo limite sem stream, ela entra em failed e nenhum artefato de replay é gerado. O servidor também a encerra automaticamente quando maxExperienceTimeSec é atingido.

Escopo

Encerre ativamente uma Adventure Travel. Após um término normal, a Travel entra em completed; em um término por tempo limite sem stream, ela entra em failed. Antes de chamar, confirme o seguinte:
  • Autenticação: A Chave de API primária não é obrigatória; tanto a chave primária quanto uma temporária podem chamá-la. Para saber como obtê-las, veja Obter credenciais de autenticação.
  • Pré-requisitos: A Travel ainda não deve ter entrado em um estado terminal e deve estar em um estado que o servidor possa encerrar. Confirme via Consultar Status da Travel.
  • Chamador: Tanto seu servidor quanto seu cliente podem fazer a chamada.

Solicitação HTTP

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

Parâmetros da solicitação

  • Término normal
  • Término por tempo limite sem fluxo
curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/travels/end' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
    -H 'Content-Type: application/json' \
    -d '{
    "encryptedTravelId": "{encryptedTravelId}",
    "userAgent": "HappyOyster-Web/0.1.0"
}'
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
encryptedTravelId string (Obrigatório)O ID criptografado da Adventure Travel a ser encerrada. Retornado por Entrar na Travel.
failCode string (Opcional)O motivo de término de falha para um tempo limite sem fluxo. Quando omitido, é tratado como um término normal. Atualmente, apenas suportado:
  • TRAVEL_NO_STREAM_AUTO_END: para o cenário em que nenhum fluxo é recebido após entrar na sala por mais de noStreamAutoEndTimeoutSec; este tipo de término não gera artefatos de replay
Passar um valor não suportado retorna 400000.
userAgent string (Opcional)Identificador de versão do SDK ou cliente. Uma string não vazia; tem precedência sobre o User-Agent HTTP.

Parâmetros de resposta

  • Término normal
  • Término por tempo limite sem fluxo
{
    "code": 0,
    "message": null,
    "data": {
        "encryptedTravelId": "trvl_a1b2****",
        "status": "completed",
        "errorCode": null,
        "errorMessage": null,
        "endedAt": "2026-06-04T00:03:00Z",
        "durationSec": 90
    }
}
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 da Viagem criptografado que foi encerrado.status stringStatus final:
  • completed: término normal
  • failed: término por falha quando um failCode suportado é fornecido
errorCode stringCódigo do motivo da falha; null em um término normal.errorMessage stringDescrição da falha; null em um término normal.endedAt stringHora de término, no formato ISO 8601.durationSec integerDuração efetiva do vídeo em segundos; null em um término de falha sem fluxo ou quando a duração ainda não puder ser analisada.

Estados pré-requisitos e notas de chamada

  • O encryptedTravelId deve pertencer à conta principal atual e ao modelo Adventure.
  • Quando failCode é omitido, é tratado como um término normal; passar um valor não suportado retorna 400000.
  • O servidor encerra automaticamente a Travel assim que maxExperienceTimeSec é atingido; o cliente deve convergir seu estado local a partir de callbacks de status ou resultados de consulta de status.
  • Em um término normal, durationSec usa preferencialmente a duração real do vídeo finalizado disponível; pode ser null quando a duração do vídeo finalizado ainda não puder ser analisada.
  • Após um término normal atingir completed, os artefatos compostos ainda podem estar sendo processados; consulte-os e sonde-os conforme Consultar Artefatos da Travel.

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

Depois que a Viagem entrar em completed: