Skip to main content

Referência da API HappyOyster-Acting-Pause Travel

Solicitação para pausar um Travel do Acting em execução. Após a pausa, a geração de vídeo é interrompida e você pode continuar através do endpoint Resume Travel.

Escopo

Solicitação para pausar um Travel do Acting em execução. 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: O status do Travel deve ser running. Confirme via Query Travel Status.
  • 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-acting/openapi/v1/travels/pauseSubstitua {WorkspaceId} pelo seu ID do Workspace real.

Parâmetros da solicitação

  • Pause Travel
curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travels/pause' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
    -H 'Content-Type: application/json' \
    -d '{
    "encryptedTravelId": "{encryptedTravelId}",
    "userAgent": "HappyOyster-Web/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 Travel ID criptografado do Acting a ser pausado. Retornado por Enter Travel.
userAgent string (Opcional)Identificador de versão do SDK ou cliente. Uma string não vazia; tem precedência sobre o User-Agent HTTP, usado para estatísticas de versão do SDK e plataforma.

Parâmetros de resposta

  • Pausa bem-sucedida
{
    "code": 0,
    "message": null,
    "data": {
        "encryptedTravelId": "trvl_a1b2****",
        "status": "paused"
    }
}
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 Travel ID criptografado.status stringO status de pausa alvo; retorna paused.

Estados pré-requisitos e notas de chamada

  • O status atual do Travel deve ser running.
  • O version na resposta de entrada na sala deve ser actingV2; entrar na sala para Acting sempre retorna este valor.
  • A confirmação de pausa é um processo assíncrono. Após receber uma resposta de sucesso, se você precisar retomar imediatamente ou enviar uma operação que dependa do estado pausado, continue consultando Consultar status da viagem até que o status consultado seja paused.
  • A confirmação de pausa geralmente tem uma barreira de status de cerca de 3 segundos; o status real está sujeito ao resultado da consulta.
  • Pausar não altera aspectRatio; o cliente mantém a orientação do player determinada no momento da entrada na sala.

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 pausar, você pode fazer o seguinte:
  • Resume Travel: retomar um Travel pausado e continuar a geração.
  • Send Process Instruction: enviar uma instrução no estado paused apenas aceita a instrução e não retoma automaticamente.
  • End Travel: encerrar o Travel diretamente.