Referensi API HappyOyster-Directing-End Travel

​

Cakupan

• Autentikasi: Kunci API utama tidak wajib; kunci API utama atau sementara dapat digunakan untuk memanggilnya. Untuk cara mendapatkannya, lihat Mendapatkan kredensial autentikasi.
• Prasyarat: Travel belum boleh memasuki status terminal dan harus berada dalam status yang dapat diakhiri oleh server. Konfirmasikan melalui Kueri Status Travel.
• Pemanggil: Server atau klien Anda dapat memanggilnya.

​

Permintaan HTTP

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
    }
}

​

Status prasyarat dan catatan pemanggilan

• Klien harus melakukan polling Query Travel Status setelah memasuki room. Jika rtcStatus belum memasuki status streaming dalam noStreamAutoEndTimeoutSec, akhiri dengan TRAVEL_NO_STREAM_AUTO_END.
• Setelah melewati TRAVEL_NO_STREAM_AUTO_END, Travel menjadi failed dan tidak ada artefak pemutaran ulang yang dapat dikueri.
• Pada akhir normal, durationSec secara prioritas menggunakan durasi file video akhir; ketika video akhir belum tersedia, sistem menggunakan durationMs dari hasil generasi terbaru yang tersedia saat ini. Ketika keduanya tidak tersedia, nilainya adalah null.
• Setelah akhir normal mencapai completed, komposisi artefak mungkin masih berlangsung; tentukan apakah akan terus melakukan polling berdasarkan status yang dikembalikan dari Query Travel Artifacts.

​

Kode kesalahan

​

Langkah selanjutnya

• Kueri Artefak Travel: melakukan polling untuk mendapatkan varian asli dan komposit yang telah direkam.
• Kueri Daftar Travel: melihat riwayat Travel.