Skip to main content

Referência da API HappyOyster-Directing-End Travel

Encerre uma Viagem de Direção. Após um término normal, o status muda para completed e entra no processamento de artefatos; em um término por tempo limite sem fluxo, muda para failed e nenhum artefato de replay é gerado.

Escopo

Encerre uma Viagem de Direção. Após um término normal, o status muda para completed e entra no processamento de artefatos; em um término por tempo limite sem fluxo, muda para failed e nenhum artefato de replay é gerado. 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
  • EUA (Virgínia)
POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/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-directing/openapi/v1/travels/end' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
    -H 'Content-Type: application/json' \
    -d '{
    "encryptedTravelId": "{encryptedTravelId}",
    "userAgent": "your-client/1.2.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 de Viagem criptografado de Direção a ser encerrado. Retornado por Entrar na Viagem.
failCode string (Opcional)O motivo de término por falha. 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",
        "endedAt": "2026-06-04T00:03:00Z",
        "durationSec": 180
    }
}
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 de término: 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 cliente deve consultar Consultar Status da Viagem após entrar na sala. Se rtcStatus não tiver entrado no estado de streaming dentro de noStreamAutoEndTimeoutSec, encerre-o com TRAVEL_NO_STREAM_AUTO_END.
  • Após passar TRAVEL_NO_STREAM_AUTO_END, a Viagem torna-se failed e nenhum artefato de replay pode ser consultado.
  • Em um término normal, durationSec usa preferencialmente a duração do arquivo de vídeo final; quando o vídeo final ainda não está disponível, usa o durationMs do resultado de geração mais recente atualmente disponível. Quando nenhum dos dois estiver disponível, será null.
  • Depois que um término normal atinge completed, a composição de artefatos ainda pode estar em andamento; decida se deve continuar consultando com base no status retornado de Consultar Artefatos da Viagem.

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: