Skip to main content

Referência da API HappyOyster-Directing-Pause Travel

Solicite a pausa de uma Viagem de Direção em execução. Após a conclusão da pausa, você pode chamar retomar ou retroceder.

Escopo

Solicite a pausa de uma Viagem de Direção em execução. Após a conclusão da pausa, você pode chamar retomar ou retroceder. 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-directing/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-directing/openapi/v1/travels/pause' \
    -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 pausado. Retornado por Entrar na Viagem.
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

  • 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 storyV2; entrar na sala para este modelo sempre retorna este valor.
  • A confirmação de status de pausa no lado do servidor é um processo assíncrono. Quando você precisar chamar imediatamente retroceder ou retomar, consulte Consultar Status da Viagem até que o status seja paused.

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: