Skip to main content
Referensi Open API Acting

Referensi API HappyOyster-Acting-Enter Travel

Klien menggunakan tiket untuk membuat Travel aktual dan mendapatkan konfigurasi bergabung RTC, versi kapabilitas Acting, serta rasio aspek pemutar. Pemanggilan yang berhasil akan membuat Travel.

Cakupan

Klien menggunakan ticket untuk membuat Travel aktual dan mendapatkan konfigurasi bergabung RTC, versi kapabilitas Acting, serta rasio aspek pemutar. Sebelum memanggil, konfirmasikan 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-acting/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-acting/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.
Acting tidak mengonsumsi maxExperienceTimeSec; jangan meneruskannya. Jika tier yang tidak valid tetap diteruskan, 400000 akan dikembalikan sebelum perutean model.

Parameter respons

  • Berhasil masuk
{
    "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
    }
}
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 Status Travel, jeda, lanjutkan, akhiri, dan kueri artefak selanjutnya.encryptedWorldId stringID World terenkripsi yang sesuai dengan Travel ini.mode integerSelalu 3 untuk Acting.creationModel stringSelalu simple untuk Acting.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 masuk room Acting, ditetapkan ke actingV2. Antarmuka kontrol harus dipanggil sesuai dengan versi ini.aspectRatio stringRasio aspek. Klien harus mengatur orientasi pemutar sesuai dengan nilai ini sebelum menarik stream:
  • 9:16 (potret)
  • 16:9 (lanskap)
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 nullActing tidak menggunakan durasi pengalaman maksimum; ditetapkan ke null.

Status prasyarat dan catatan pemanggilan

  • World yang sesuai dengan ticket harus berstatus ready, dan tiket harus belum kedaluwarsa serta belum digunakan.
  • Pemanggilan yang berhasil akan membuat Travel; menggunakan ulang ticket yang sama akan mengembalikan 401011.
  • Jika fitur atau spesifikasi Acting tidak diaktifkan, 403007 akan dikembalikan, dan tidak ada Travel yang dibuat.
  • version harus ditangani sebagai actingV2; jangan memanggil antarmuka kontrol berdasarkan versi kapabilitas lain.
  • Klien sebaiknya membaca aspectRatio sebelum menetapkan penarikan stream atau kontainer rendering: gunakan kontainer potret untuk 9:16 dan kontainer lanskap untuk 16:9.
  • Jangan meneruskan maxExperienceTimeSec. Acting tidak mengakhiri sesi secara otomatis berdasarkan field ini, dan klien tidak boleh menggunakannya untuk menerapkan hitung mundur.
  • 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
Referensi API HappyOyster-Acting-Enter Travel - Alibaba Cloud Model Studio