Skip to main content
QwenCloud home page
Docs
Directing

HappyOyster-Directing-Enter Travel (Client) API Reference

The client uses the ticket to create an actual Travel and obtain the RTC join configuration and the Directing capability version. creationModel determines the control interfaces the Travel can call.

POST
/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/enter-travel
cURL - Enter travel (client)
curl --location 'https://dashscope-intl.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/enter-travel' \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "ticket": "{ticket}"
}'
{
  "code": 0,
  "message": null,
  "data": {
    "encryptedTravelId": "trvl_a1b2****",
    "encryptedWorldId": "enc_a1b2****",
    "mode": 2,
    "creationModel": "simple",
    "playUrl": null,
    "firstFrame": "https://cdn.happyoyster.com/frames/world_xyz789.jpg",
    "rtcConfig": {
      "channelId": "stream_abc123",
      "appId": "18bca2e3218c46aebf8ff3a32fb12311",
      "token": "007eJxTYOh...",
      "userId": "user_1"
    },
    "version": "storyV2",
    "aspectRatio": null,
    "noStreamAutoEndTimeoutSec": 30,
    "maxExperienceTimeSec": null
  }
}

Scope

  • The primary API Key is not required; the ticket completes the enter-room validation.
  • The ticket must be unexpired, unused, and its World status must be ready.
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

An unexpired, unused single-use credential. Reusing the same ticket returns 401011.

​
enum<integer>

Directing does not use this value; the successful response is still null. If passed, it can only be 60/90/120.

Available options:60,90,120

Response

200-application/json
​
integer
​
string
​
object
HappyOyster-Directing-Enter Travel (Client) API Reference - QwenCloud