Skip to main content
QwenCloud home page
Docs
Acting (Invitational Preview)

HappyOyster-Acting-Enter Travel API Reference

The client uses the ticket to create an actual Travel and obtain the RTC join configuration, the Acting capability version, and the player aspect ratio. A successful call creates the Travel.

POST
/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travels/enter-travel
cURL - Enter travel (client)
curl --location 'https://dashscope-intl.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/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": 3,
    "creationModel": "simple",
    "playUrl": null,
    "firstFrame": "https://cdn.happyoyster.com/frames/acting_world_xyz789.jpg",
    "rtcConfig": {
      "channelId": "stream_abc123",
      "appId": "18bca2e3218c46aebf8ff3a32fb12311",
      "token": "007eJxTYOh...",
      "userId": "user_1"
    },
    "version": "actingV2",
    "aspectRatio": "9:16",
    "noStreamAutoEndTimeoutSec": 30,
    "maxExperienceTimeSec": null
  }
}

Scope

The client uses the ticket to create an actual Travel and obtain the RTC join configuration, the Acting capability version, and the player aspect ratio. Before calling, confirm the following:
  • Authentication: The primary API Key is not required; the ticket completes the enter-room validation.
  • Prerequisites: The ticket is obtained from Get Travel Credential, unexpired and unused, and its World status is ready.
  • Caller: Called by your client.
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 obtained from Get Travel Credential. Reusing the same ticket returns 401011.

​
enum<integer>

Maximum experience duration. Acting does not use this value; the successful response is still null. If passed, it can only be one of the current configuration tiers (60/90/120). The parameter is validated before model routing; an invalid tier returns 400000. Omitting it is recommended.

Available options:60,90,120

Response

200-application/json
​
integer

Return code. 0 means success; non-zero is an error code.

​
string

Error message. null on success.

​
object

Response data. null on failure.