Skip to main content

Referência da API HappyOyster-Acting-Resume Travel

Retome uma Acting Travel pausada para que ela retorne ao estado de execução.

Escopo

Retome uma Acting Travel pausada para que ela retorne ao estado de 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: A Travel deve ser confirmada como paused 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-acting/openapi/v1/travels/resumeSubstitua {WorkspaceId} pelo seu ID do Workspace real.

Parâmetros da solicitação

  • Retomar Travel
curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travels/resume' \
    -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 ID criptografado da Acting Travel a ser retomado. Retornado por Entrar na 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

  • Retomada bem-sucedida
{
    "code": 0,
    "message": null,
    "data": {
        "encryptedTravelId": "trvl_a1b2****",
        "status": "running"
    }
}
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 após a retomada; retorna running.

Estados pré-requisitos e notas de chamada

  • A Travel deve ser confirmada como paused via Consultar Status da Travel.
  • O version na resposta de entrada na sala deve ser actingV2.
  • Uma viagem que já terminou ou falhou não pode ser retomada.
  • Após retomar, você pode continuar a enviar instruções de processo de texto; o cliente deve convergir seu estado de execução local com base no resultado da consulta de status.
  • A retomada não altera o aspectRatio retornado ao entrar 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 retomar, você pode: