Skip to main content

Référence de l'API HappyOyster-Directing-Resume Travel

Reprendre un Voyage Directing en pause afin qu'il revienne à l'état running.

Scope

Reprendre un Voyage Directing en pause afin qu'il revienne à l'état running. Avant d'appeler, confirmez les points suivants :

Requête HTTP

  • Singapore
  • États-Unis (Virginie)
POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/resumeRemplacez {WorkspaceId} par votre véritable ID d'espace de travail.

Paramètres de la requête

  • Reprendre le Travel
curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/resume' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
    -H 'Content-Type: application/json' \
    -d '{
    "encryptedTravelId": "{encryptedTravelId}",
    "userAgent": "your-client/1.2.0"
}'
Content-Typestring(Requis)Type de contenu de la requête. Ce paramètre doit être défini sur application/json.
Authorization string (Requis)Authentification par clé API. La clé API principale n'est pas requise ; la clé principale ou une clé API temporaire peut l'appeler.
  • Clé API principale : commence par sk-, par ex. sk-xxx.
  • Clé API temporaire : commence par st-, par exemple st-xxx.
Corps de la requête
encryptedTravelId string (Obligatoire)L'ID de Voyage chiffré Directing à reprendre. Retourné par Entrer dans le voyage.
userAgent string (Facultatif)Identifiant de version du SDK ou du client. Une chaîne non vide ; prévaut sur le User-Agent HTTP.

Paramètres de réponse

  • Reprise réussie
{
    "code": 0,
    "message": null,
    "data": {
        "encryptedTravelId": "trvl_a1b2****",
        "status": "running"
    }
}
code integerCode de retour. 0 indique un succès ; une valeur non nulle correspond à un code d'erreur.
message stringMessage d'erreur. null en cas de succès.
data objectDonnées de réponse. null en cas d'échec.

Propriétés

encryptedTravelId stringL'identifiant de voyage chiffré.status stringLe statut après la reprise ; retourne running.

États préalables et notes d'appel

  • Le Travel doit être confirmé comme paused via Interroger le statut du Travel.
  • La version dans la réponse d'entrée en salle doit être storyV2.
  • Un Travel déjà terminé ou ayant échoué ne peut pas être repris.

Codes d'erreur

Si l'appel du modèle échoue et renvoie une erreur, consultez Codes d'erreur HappyOyster pour la résoudre.

Étapes suivantes

Après la reprise, vous pouvez :