Skip to main content
Referensi Open API Directing

Referensi API HappyOyster-Directing-Enter Travel

Klien menggunakan ticket untuk membuat Travel aktual dan mendapatkan konfigurasi join RTC serta versi kapabilitas Directing. creationModel menentukan antarmuka kontrol yang dapat dipanggil oleh Travel.

Cakupan

Klien menggunakan ticket untuk membuat Travel aktual dan mendapatkan konfigurasi join RTC. Sebelum memanggil, konfirmasi hal berikut:
  • Autentikasi: API KeyAPI Key utama tidak wajib; ticket menyelesaikan validasi masuk room. Untuk cara mendapatkannya, lihat Mendapatkan kredensial autentikasi.
  • Prasyarat: ticket diperoleh dari Dapatkan Kredensial Travel, belum kedaluwarsa dan belum digunakan, serta status World-nya adalah ready.
  • Pemanggil: Dipanggil oleh klien Anda.

Permintaan HTTP

  • Singapore
  • AS (Virginia)
POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/enter-travelGanti {WorkspaceId} dengan ID Workspace Anda yang sebenarnya.

Parameter permintaan

  • Masuk travel (klien)
curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.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}"
}'
Content-Typestring(Wajib)Tipe konten permintaan. Parameter ini harus diatur ke application/json.
Authorization string (Wajib)Autentikasi Kunci API. Kunci API utama tidak wajib; kunci API utama atau sementara dapat digunakan untuk memanggilnya.
  • API Key Utama: dimulai dengan sk-, misalnya sk-xxx.
  • Kunci API Sementara: diawali dengan st-, misalnya st-xxx.
Request Body
ticket string (Wajib)Kredensial sekali pakai yang belum kedaluwarsa dan belum digunakan, yang diperoleh dari Dapatkan Kredensial Travel. Menggunakan ulang ticket yang sama akan mengembalikan 401011.
Enter-travel Directing tidak mengonsumsi maxExperienceTimeSec; jangan meneruskannya. Bidang ini hanya berlaku untuk Adventure; jika tier yang tidak valid diteruskan, 400000 dikembalikan sebelum perutean model. Respons yang berhasil tetap null.

Parameter respons

Entered successfully
{
    "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
    }
}
code integerKode pengembalian. 0 berarti berhasil; bukan nol adalah kode kesalahan.
message stringPesan kesalahan. null jika berhasil.
data objectData respons. null jika gagal.

Properti

encryptedTravelId stringID Travel terenkripsi yang baru dibuat. Digunakan untuk kueri Query Travel Status, rewind, pause, resume, end, dan artefak selanjutnya.encryptedWorldId stringID World terenkripsi yang sesuai dengan Travel ini.mode integerSelalu 2 untuk Directing.creationModel stringsimple atau scriptlist; menentukan antarmuka kontrol yang dapat dipanggil oleh Travel:
  • simple: instruct, pause, resume, rewind, end
  • scriptlist: update-script, pause, resume, rewind, end (instruct tidak didukung)
playUrl nullBelum tersedia; ditetapkan ke null.firstFrame stringURL frame pertama World.rtcConfig objectKonfigurasi bergabung RTC; bernilai null ketika tidak ada channel streaming yang tersedia, sehingga klien tidak dapat memulai pemutaran berdasarkan konfigurasi tersebut.
  • channelId: ID channel RTC
  • appId: ID aplikasi RTC yang ditetapkan oleh platform
  • token: Token bergabung RTC
  • userId: ID pengguna bergabung RTC, ditetapkan ke user_1
version stringVersi enter-room Directing, ditetapkan ke storyV2.aspectRatio nullDitetapkan ke null untuk model Directing.noStreamAutoEndTimeoutSec integerBatas waktu pengakhiran otomatis tanpa stream dalam detik, defaultnya 30; respons aktual yang berlaku. Jika rtcStatus tidak memasuki status streaming dalam waktu ini setelah masuk ke room, panggil Akhiri Travel dengan failCode=TRAVEL_NO_STREAM_AUTO_END.maxExperienceTimeSec nullDitetapkan ke null untuk model Directing.

Status prasyarat dan catatan pemanggilan

  • World yang sesuai dengan ticket harus berstatus ready, dan tiket harus belum kedaluwarsa serta belum digunakan.
  • Jangan meneruskan maxExperienceTimeSec. Directing tidak membatasi waktu pengalaman berdasarkan bidang ini.
  • Pemanggilan yang berhasil akan membuat Travel; menggunakan ulang ticket yang sama akan mengembalikan 401011.
  • Ketika creationModel=scriptlist, jangan memanggil instruct; gunakan Pembaruan skrip lengkap sebagai gantinya.
  • rtcConfig=null berarti saat ini tidak ada channel streaming yang tersedia, sehingga klien tidak dapat memulai pemutaran berdasarkan konfigurasi tersebut.

Kode kesalahan

Jika pemanggilan model gagal dan mengembalikan kesalahan, lihat Kode Kesalahan HappyOyster untuk menyelesaikannya.

Langkah selanjutnya

Setelah berhasil masuk ke room:
Penggunaan API
Generasi teks
Pembuatan Gambar
  • FAQ
Video Generation
Model Dunia
Audio
  • Pembuatan audio
Real-time multimodal
Realtime API
Penyematan Teks
Lainnya Model
Toolkit/Framework
TokenPlan
Model production
Manajemen file
Penagihan
Manajemen Model
Lebih Banyak Tentang Model