HappyOyster-Directing-End Travel API Reference

​

Scope

• Authentication: The primary API Key is not required; either the primary or a temporary API Key can call it. For how to obtain them, see Obtain authentication credentials.
• Prerequisites: The Travel must not yet have entered a terminal state and must be in a state the server can end. Confirm via Query Travel Status.
• Caller: Either your server or your client can call it.

​

HTTP request

curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/end' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
    -H 'Content-Type: application/json' \
    -d '{
    "encryptedTravelId": "{encryptedTravelId}",
    "userAgent": "your-client/1.2.0"
}'

curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/end' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
    -H 'Content-Type: application/json' \
    -d '{
    "encryptedTravelId": "{encryptedTravelId}",
    "failCode": "TRAVEL_NO_STREAM_AUTO_END",
    "userAgent": "your-client/1.2.0"
}'

{
    "code": 0,
    "message": null,
    "data": {
        "encryptedTravelId": "trvl_a1b2****",
        "status": "completed",
        "endedAt": "2026-06-04T00:03:00Z",
        "durationSec": 180
    }
}

{
    "code": 0,
    "message": null,
    "data": {
        "encryptedTravelId": "trvl_a1b2****",
        "status": "failed",
        "errorCode": "TRAVEL_NO_STREAM_AUTO_END",
        "errorMessage": "Something went wrong.",
        "endedAt": "2026-06-04T00:03:00Z",
        "durationSec": null
    }
}

​

Prerequisite states and call notes

• The client should poll Query Travel Status after entering the room. If rtcStatus has not entered the streaming state within noStreamAutoEndTimeoutSec, end it with TRAVEL_NO_STREAM_AUTO_END.
• After passing TRAVEL_NO_STREAM_AUTO_END, the Travel becomes failed and no replay artifacts can be queried.
• On a normal end, durationSec preferentially uses the final video file duration; when the final video is not yet available, it uses the durationMs of the latest currently available generation result. When neither is available, it is null.
• After a normal end reaches completed, artifact composition may still be in progress; decide whether to keep polling based on the returned status of Query Travel Artifacts.

​

Error codes

​

Next steps

• Query Travel Artifacts: poll to obtain the recorded original and composited variants.
• Query Travel List: view historical Travels.