Permintaan untuk menjeda Directing Travel yang sedang berjalan. Setelah jeda selesai, Anda dapat memanggil resume atau rewind.
Cakupan
Permintaan untuk menjeda Directing Travel yang sedang berjalan. Setelah jeda selesai, Anda dapat memanggil resume atau rewind. Sebelum memanggil, konfirmasi hal berikut:
- Autentikasi: Kunci API utama tidak wajib; kunci API utama atau sementara dapat digunakan untuk memanggilnya. Untuk cara mendapatkannya, lihat Mendapatkan kredensial autentikasi.
- Prasyarat: Status Travel harus
running. Konfirmasikan melalui Query Travel Status. - Pemanggil: Server atau klien Anda dapat memanggilnya.
Permintaan HTTP
- Singapore
- AS (Virginia)
POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/pauseGanti {WorkspaceId} dengan ID Workspace Anda yang sebenarnya.Parameter permintaan |
|
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.
| |
Request Body | |
encryptedTravelId string (Wajib)ID Travel terenkripsi Directing yang akan dijeda. Dikembalikan oleh Enter Travel. | |
userAgent string (Opsional)Pengidentifikasi versi SDK atau klien. String tidak kosong; didahulukan daripada HTTP User-Agent. |
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 encryptedTravelId stringID Travel yang terenkripsi.status stringStatus jeda target; mengembalikan paused. |
Status prasyarat dan catatan pemanggilan
- Status Travel saat ini harus
running. versiondalam respons enter-room harusstoryV2; memasuki room untuk model ini selalu mengembalikan nilai ini.- Konfirmasi status jeda di sisi server adalah proses asinkron. Ketika Anda perlu segera memanggil rewind atau resume, lakukan polling Query Travel Status hingga statusnya
paused.
Kode kesalahan
Jika pemanggilan model gagal dan mengembalikan kesalahan, lihat Kode Kesalahan HappyOyster untuk menyelesaikannya.
Langkah selanjutnya
Setelah menjeda, Anda dapat melakukan hal berikut:
- Resume Travel: lanjutkan Travel yang dijeda dan teruskan eksekusi.
- Rewind Travel: kembali ke timestamp video tertentu.
- End Travel: akhiri Travel secara langsung.