Kueri progres pembangunan Acting World. API ini mengembalikan ID World terenkripsi, status pembangunan, dan URL frame pertama; klien melakukan polling hingga World memasuki status ready.
Cakupan
Kueri progres pembangunan Acting World. Sebelum memanggil, pastikan hal berikut:
- Autentikasi: primary API Key tidak wajib; primary API Key atau temporary API Key dapat memanggil endpoint ini. Untuk cara mendapatkannya, lihat Mendapatkan kredensial autentikasi.
- Prasyarat: Lakukan kueri dengan
encryptedWorldIdyang dikembalikan oleh Create World. Anda dapat mulai melakukan kueri dari statusgenerating; World tidak harus dibangun sepenuhnya. - Pemanggil: Server atau klien Anda dapat memanggilnya.
Permintaan HTTP
- Singapore
- AS (Virginia)
GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/worlds/build-statusGanti {WorkspaceId} dengan ID Workspace Anda yang sebenarnya.Parameter permintaan |
|
Authorization string (Wajib)Autentikasi Kunci API. Kunci API utama tidak wajib; kunci API utama atau sementara dapat digunakan untuk memanggilnya.
| |
Parameter kueri | |
encryptedWorldId string (Wajib)ID World terenkripsi Acting yang dikembalikan oleh Create World. |
Parameter respons |
|
code integerKode pengembalian. 0 berarti berhasil; bukan nol adalah kode kesalahan. | |
message stringPesan kesalahan. null jika berhasil. | |
data objectData respons. null jika gagal.
Properti encryptedWorldId stringID World terenkripsi.status stringStatus pembangunan:
stringURL frame pertama World; null jika belum dibuat atau jika pembangunan gagal.name stringNama World. Hanya dikembalikan ketika status=ready.mode integerSelalu 3 untuk Acting. Hanya dikembalikan ketika status=ready. |
Status prasyarat dan catatan pemanggilan
- Lakukan polling setiap 3–5 detik hingga
statusbernilaireadyataufailed. - Hanya World
readyyang dapat menukarkan kredensial travel dan memasuki ruangan. - Ketika gambar URL gagal divalidasi setelah penyimpanan asinkron, World dapat berubah dari
generatingmenjadifailed. - Endpoint ini tidak mengembalikan
aspectRatio; orientasi pemutar ditentukan olehaspectRatiodalam respons Enter the room.
Kode kesalahan
Jika pemanggilan model gagal dan mengembalikan kesalahan, lihat Kode Kesalahan HappyOyster untuk menyelesaikannya.
Langkah selanjutnya
Setelah World memasuki ready:
- Get Travel Credential: tukarkan dengan
ticketsekali pakai. - Query World Detail: kueri metadata pembuatan lengkap.