Skip to main content

Referencia de la API de HappyOyster-Directing-Pause Travel

Solicita pausar un Viaje de Dirección en ejecución. Una vez completada la pausa, puede llamar a reanudar o rebobinar.

Ámbito

Solicita pausar un Viaje de Dirección en ejecución. Una vez completada la pausa, puede llamar a reanudar o rebobinar. Antes de realizar la llamada, confirme lo siguiente:
  • Autenticación: La clave de API principal no es obligatoria; pueden invocarla tanto la clave principal como una temporal. Para saber cómo obtenerlas, consulte Obtener credenciales de autenticación.
  • Prerequisites: El estado del viaje debe ser running. Confírmelo mediante Query Travel Status.
  • Solicitante: Puede invocarla su servidor o su cliente.

Solicitud HTTP

  • Singapore
  • EE. UU. (Virginia)
POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/pauseReemplace {WorkspaceId} con su ID de espacio de trabajo real.

Parámetros de solicitud

  • 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(Requerido)Tipo de contenido de la solicitud. Este parámetro debe establecerse en application/json.
Authorization string (Requerido)Autenticación mediante clave de API. No se requiere la clave de API principal; pueden invocarla tanto la clave principal como una temporal.
  • Clave de API principal: comienza con sk-, por ejemplo, sk-xxx.
  • Clave de API temporal: comienza con st-, por ejemplo, st-xxx.
Cuerpo de la solicitud
encryptedTravelId string (Obligatorio)El ID de Viaje cifrado de Dirección a pausar. Devuelto por Entrar al viaje.
userAgent string (Opcional)Identificador de versión del SDK o del cliente. Una cadena no vacía; tiene prioridad sobre el User-Agent HTTP.

Parámetros de respuesta

  • Pausa exitosa
{
    "code": 0,
    "message": null,
    "data": {
        "encryptedTravelId": "trvl_a1b2****",
        "status": "paused"
    }
}
code integerCódigo de retorno. 0 indica éxito; un valor distinto de cero es un código de error.
message stringMensaje de error. null en caso de éxito.
data objectDatos de respuesta. null en caso de fallo.

Propiedades

encryptedTravelId stringEl ID de viaje cifrado.status stringEl estado de pausa objetivo; devuelve paused.

Estados previos y notas de llamada

  • El estado actual del viaje debe ser running.
  • El version en la respuesta de entrada a la sala debe ser storyV2; entrar a la sala para este modelo siempre devuelve este valor.
  • La confirmación del estado de pausa en el servidor es un proceso asíncrono. Cuando necesite llamar inmediatamente a rebobinar o reanudar, sondee Consultar estado del viaje hasta que el estado sea paused.

Códigos de error

Si la llamada al modelo falla y devuelve un error, consulte Códigos de error de HappyOyster para resolverlo.

Siguientes pasos

Después de pausar, puede realizar lo siguiente: