Skip to main content
QwenCloud home page
Docs
Directing

HappyOyster-Directing-Pause Travel API Reference

Request to pause a running Directing Travel. After the pause completes, you can call resume or rewind.

POST
/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/pause
cURL - Pause Travel
curl --location 'https://dashscope-intl.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"
}'
{
  "code": 0,
  "message": null,
  "data": {
    "encryptedTravelId": "trvl_a1b2****",
    "status": "paused"
  }
}

Scope

  • The primary API Key is not required; either the primary or a temporary API Key can call it.
  • The Travel status must be running before pausing. After pausing, you can call resume or rewind.
If the model call fails and returns an error, see HappyOyster Error Codes to resolve it.

Authorizations

​
string
header
required

QwenCloud API Key. Only the primary API Key (sk- prefix) is supported. See Get an API Key.

Header Parameters

​
string
default"application/json"
required

Request content type. This parameter must be set to application/json.

​
string
required

API Key authentication. The primary API Key is not required; either the primary or a temporary API Key can call it.

  • Primary API Key: starts with sk-, e.g. sk-xxx.
  • Temporary API Key: starts with st-, e.g. st-xxx.

Body

application/json
​
string
required

The encrypted Travel ID.

​
string

SDK or client version identifier.

Response

200-application/json
​
integer
​
string
​
object