Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
# Referensi API
**Topics**
+ [WebSocket titik akhir APIs](api-endpoint.md)
+ [Penerimaan pesan asinkron](async-message-reception-api.md)
# WebSocket titik akhir APIs
Berikut ini adalah Amazon Kinesis Video Streams WebSocket dengan APIs endpoint WebRTC:
**Topics**
+ [ConnectAsMaster](ConnectAsMaster.md)
+ [ConnectAsViewer](ConnectAsViewer.md)
# ConnectAsMaster
Terhubung sebagai master ke saluran pensinyalan yang ditentukan oleh titik akhir. Pustaka WebSocket -complaint apa pun dapat digunakan untuk terhubung ke titik akhir websocket (WSS) aman yang diperoleh dari panggilan API. `GetSignalingChannelEndpoint` Nama Sumber Daya Amazon (ARN) dari saluran pensinyalan harus disediakan sebagai parameter string kueri. Ada titik akhir terpisah untuk menghubungkan sebagai master dan sebagai penampil. Jika lebih dari satu klien terhubung sebagai master ke saluran tertentu, maka permintaan terbaru diutamakan. Metadata koneksi yang ada ditimpa oleh yang baru.
## Permintaan
```
"X-Amz-ChannelARN": "string"
```
+ **X-AMZ-channelarn - ARN** dari saluran pensinyalan.
+ Jenis: string
+ Panjang batasan: Panjang minimum 1. Panjang maksimum 1024.
+ Pola: `arn:aws:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`
+ Wajib: Ya
## Respons
200 OK kode status HTTP dengan badan kosong.
## Kesalahan
+ InvalidArgumentException
Parameter yang ditentukan melebihi batasannya, tidak didukung, atau tidak dapat digunakan. Untuk informasi selengkapnya, lihat pesan yang dikembalikan.
Kode Status HTTP: 400
+ AccessDeniedException
Penelepon tidak berwenang untuk mengakses saluran yang diberikan atau token telah kedaluwarsa.
Kode Status HTTP: 403
+ ResourceNotFoundException
Saluran itu tidak ada.
Kode Status HTTP: 404
+ ClientLimitExceededException
Ketika API dipanggil pada tingkat yang terlalu tinggi. Untuk informasi selengkapnya, lihat [Amazon Kinesis Video Streams dengan kuota layanan WebRTC](kvswebrtc-limits.md) dan [Error Retries dan Exponential Backoff](https://docs.aws.amazon.com/general/latest/gr/api-retries.html) di. AWS
Kode Status HTTP: 400
## Batas/Pelambatan
API ini dibatasi pada tingkat akun jika API dipanggil pada tingkat yang terlalu tinggi. Kesalahan kembali saat dibatasi dengan. `ClientLimitExceededException`
## Idempoten
Jika koneksi sudah ada untuk clientID dan saluran yang ditentukan, metadata koneksi diperbarui dengan informasi baru.
## Coba lagi perilaku
Ini dihitung sebagai panggilan API baru.
## Panggilan bersamaan
Panggilan bersamaan diizinkan, metadata koneksi diperbarui untuk setiap panggilan.
# ConnectAsViewer
Terhubung sebagai penampil ke saluran pensinyalan yang ditentukan oleh titik akhir. Pustaka WebSocket yang sesuai dapat digunakan untuk terhubung ke titik akhir websocket (WSS) aman yang diperoleh dari panggilan API. `GetSignalingChannelEndpoint` Nama Sumber Daya Amazon (ARN) dari saluran pensinyalan dan ID klien harus disediakan sebagai parameter string kueri. Ada titik akhir terpisah untuk menghubungkan sebagai master dan sebagai penampil. Jika ada koneksi yang ada dengan sama `ClientId` seperti yang ditentukan dalam permintaan, koneksi baru diutamakan. Metadata koneksi ditimpa dengan informasi baru.
## Permintaan
```
"X-Amz-ChannelARN": "string",
"X-Amz-ClientId": "string"
```
+ **X-AMZ-channelarn - ARN** dari saluran pensinyalan.
+ Jenis: string
+ Panjang batasan: Panjang minimum 1. Panjang maksimal 1024
+ Pola: `arn:aws:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`
+ Wajib: Ya
+ **X-Amz- ClientId** - Pengidentifikasi unik untuk klien.
+ Jenis: string
+ Panjang batasan: Panjang minimum 1. Panjang maksimum 256.
+ Pola: `^(?!(?i)AWS_.*)[a-zA-Z0-9_.-]`
**catatan**
`X-Amz-ClientId`Tidak bisa mulai dengan`AWS_`.
+ Wajib: Ya
## Respons
200 OK kode status HTTP dengan badan kosong.
## Kesalahan
+ InvalidArgumentException
Parameter yang ditentukan melebihi batasannya, tidak didukung, atau tidak dapat digunakan. Untuk informasi selengkapnya, lihat pesan yang dikembalikan.
Kode Status HTTP: 400
+ AccessDeniedException
Penelepon tidak berwenang untuk mengakses saluran yang diberikan atau token telah kedaluwarsa.
Kode Status HTTP: 403
+ ResourceNotFoundException
Saluran itu tidak ada.
Kode Status HTTP: 404
+ ClientLimitExceededException
Ketika API dipanggil pada tingkat yang terlalu tinggi atau ketika ada lebih dari jumlah maksimum pemirsa yang didukung yang terhubung ke saluran. Untuk informasi selengkapnya, lihat [Amazon Kinesis Video Streams dengan kuota layanan WebRTC](kvswebrtc-limits.md) dan [Error Retries dan Exponential Backoff](https://docs.aws.amazon.com/general/latest/gr/api-retries.html) di. AWS
Kode Status HTTP: 400
## Batas/Pelambatan
API ini dibatasi pada tingkat akun jika API dipanggil pada tingkat yang terlalu tinggi atau ketika jumlah maksimum penonton yang didukung terhubung ke saluran lebih dari jumlah maksimum yang didukung. Kesalahan kembali saat dibatasi dengan. `ClientLimitExceededException`
## Idempoten
Jika koneksi sudah ada untuk yang ditentukan `ClientId` dan saluran, metadata koneksi diperbarui dengan informasi baru.
## Coba lagi perilaku
Ini dihitung sebagai panggilan API baru.
## Panggilan bersamaan
Panggilan bersamaan diizinkan, metadata koneksi diperbarui untuk setiap panggilan.
# Penerimaan pesan asinkron
Semua pesan respons dikirim secara asinkron ke penerima sebagai peristiwa (misalnya, penawaran SDP atau pengiriman jawaban SDP). Berikut ini adalah struktur pesan acara.
## Peristiwa
```
{
"senderClientId": "string",
"messageType": "string",
"messagePayload": "string",
"statusResponse": {
"correlationId": "string",
"errorType": "string",
"statusCode": "string",
"description": "string"
}
}
```
+ **senderClientId**- Pengidentifikasi unik untuk klien pengirim.
+ Tipe: String
+ Panjang batasan: Panjang minimum 1. Panjang maksimum 256.
+ Pola: `[a-zA-Z0-9_.-]+`
+ Wajib: Tidak
+ **MessageType** - Jenis acara.
+ Jenis: ENUM
+ Jenis yang Valid: `SDP_OFFER``SDP_ANSWER`,`ICE_CANDIDATE`,`GO_AWAY`,,`RECONNECT_ICE_SERVER`, `STATUS_RESPONSE`
+ Panjang batasan: Panjang minimum 1. Panjang maksimum 256.
+ Pola: `[a-zA-Z0-9_.-]+`
+ Wajib: Ya
+ **MessagePayLoad** - Konten pesan yang dikodekan base64.
+ Tipe: String
+ Panjang batasan: Panjang minimum 1. Panjang maksimum 10K.
+ Wajib: Tidak
+ **CorrelationID** - Pengidentifikasi unik dari pesan yang statusnya dimaksudkan. Ini adalah CorrelationID yang sama yang disediakan dalam pesan klien (misalnya, penawaran SDP, jawaban SDP, atau kandidat ICE).
+ Tipe: String
+ Panjang batasan: Panjang minimum 1. Panjang maksimum 256.
+ Pola: `[a-zA-Z0-9_.-]+`
+ Wajib: Ya
+ **ErrorType** - Nama untuk mengidentifikasi kesalahan secara unik.
+ Tipe: String
+ Panjang batasan: Panjang minimum 1. Panjang maksimum 256.
+ Pola: `[a-zA-Z0-9_.-]+`
+ Wajib: Tidak
+ **StatusCode** - kode status HTTP sesuai dengan sifat respon.
+ Tipe: String
+ Panjang batasan: Panjang minimum 1. Panjang maksimum 256.
+ Pola: `[a-zA-Z0-9_.-]+`
+ Wajib: Tidak
+ **description** - Deskripsi string yang menjelaskan status.
+ Tipe: String
+ Panjang batasan: Panjang minimum 1. Panjang maksimum 1K.
+ Wajib: Tidak
# SendSdpOffer
Mengirim penawaran ke penerima target. Prasyaratnya adalah klien harus sudah terhubung ke WebSocket titik akhir yang diperoleh dari API. `GetSignalingChannelEndpoint`
Jika jenis pengirim adalah penampil, maka ia mengirimkan penawaran ke master. Juga, tidak perlu menentukan `RecipientClientId` dan nilai tertentu untuk `RecipientClientId` diabaikan. Jika jenis pengirim adalah master, penawaran dikirim ke penampil target yang ditentukan oleh. `RecipientClientId` `RecipientClientId`adalah masukan yang diperlukan dalam kasus ini.
Aplikasi klien master diizinkan mengirim penawaran ke penampil mana pun, sedangkan aplikasi klien penampil hanya diizinkan mengirim penawaran ke aplikasi klien utama. Jika aplikasi klien penampil mencoba mengirim penawaran ke aplikasi klien penampil lain, permintaan tersebut TIDAK akan dihormati. Jika ada penawaran luar biasa untuk klien yang sama yang belum dikirimkan, itu ditimpa dengan penawaran baru.
## Permintaan
```
{
"action": "SDP_OFFER",
"recipientClientId": "string",
"messagePayload": "string",
"correlationId": "string"
}
```
+ **action** - Jenis pesan yang sedang dikirim.
+ Jenis: ENUM
+ Nilai valid: `SDP_OFFER`, `SDP_ANSWER`, `ICE_CANDIDATE`
+ Panjang batasan: Panjang minimum 1. Panjang maksimum 256.
+ Pola: `[a-zA-Z0-9_.-]+`
+ Wajib: Ya
+ **recipientClientId**- Pengidentifikasi unik untuk penerima.
+ Tipe: String
+ Panjang batasan: Panjang minimum 1. Panjang maksimum 256.
+ Pola: `[a-zA-Z0-9_.-]+`
+ Wajib: Ya
+ **MessagePayLoad** - Konten pesan yang disandikan basis-64.
+ Tipe: String
+ Panjang batasan: Panjang minimum 1. Panjang maksimum 10K.
+ Wajib: Ya
+ **CorrelationID** - Sebuah identifier unik untuk pesan. Ini adalah parameter opsional.
+ Tipe: String
+ Panjang batasan: Panjang minimum 1. Panjang maksimum 256.
+ Pola: `[a-zA-Z0-9_.-]+`
+ Wajib: Tidak
## Respons
Jika pesan berhasil diterima oleh backend pensinyalan, tidak ada respons yang dikembalikan. Jika layanan mengalami kesalahan dan jika `correlationId` ditentukan dalam permintaan, rincian kesalahan dikembalikan sebagai `STATUS_RESPONSE` pesan. Untuk informasi selengkapnya, lihat [Penerimaan pesan asinkron](async-message-reception-api.md).
## Kesalahan
+ InvalidArgumentException
Parameter yang ditentukan melebihi batasannya, tidak didukung, atau tidak dapat digunakan. Untuk informasi selengkapnya, lihat pesan yang dikembalikan.
Kode Status HTTP: 400
+ ClientLimitExceededException
Ketika API dipanggil pada tingkat yang terlalu tinggi. Untuk informasi selengkapnya, lihat [Amazon Kinesis Video Streams dengan kuota layanan WebRTC](kvswebrtc-limits.md) dan [Error Retries dan Exponential Backoff](https://docs.aws.amazon.com/general/latest/gr/api-retries.html) di. AWS
Kode Status HTTP: 400
## Batas/Pelambatan
API ini dibatasi pada tingkat akun jika API dipanggil pada tingkat yang terlalu tinggi. Kesalahan kembali saat dibatasi dengan. `ClientLimitExceededException`
## Idempoten
API ini tidak idempoten.
## Coba lagi perilaku
Ini dihitung sebagai panggilan API baru.
## Panggilan bersamaan
Panggilan bersamaan diizinkan. Penawaran dikirim satu kali per setiap panggilan.
# SendSdpAnswer
Mengirimkan jawaban ke penerima target. Prasyaratnya adalah klien harus sudah terhubung ke WebSocket titik akhir yang diperoleh dari API. `GetSignalingChannelEndpoint`
Jika jenis pengirim adalah penampil, maka ia mengirimkan jawaban ke master. Juga, tidak perlu menentukan `RecipientClientId` dan nilai tertentu untuk `RecipientClientId` diabaikan. Jika jenis pengirim adalah master, jawabannya dikirim ke penampil target yang ditentukan oleh. `RecipientClientId` `RecipientClientId`adalah masukan yang diperlukan dalam kasus ini.
Aplikasi klien master diizinkan mengirim jawaban ke penampil mana pun, sedangkan aplikasi klien penampil hanya diizinkan mengirim jawaban ke aplikasi klien utama. Jika aplikasi klien penampil mencoba mengirim jawaban ke aplikasi klien penampil lain, permintaan tersebut TIDAK akan dihormati. Jika ada jawaban yang luar biasa untuk klien yang sama yang belum disampaikan, itu ditimpa dengan jawaban baru.
## Permintaan
```
{
"action": "SDP_ANSWER",
"recipientClientId": "string",
"messagePayload": "string",
"correlationId": "string"
}
```
+ **action** - Jenis pesan yang sedang dikirim.
+ Jenis: ENUM
+ Nilai valid: `SDP_OFFER`, `SDP_ANSWER`, `ICE_CANDIDATE`
+ Panjang batasan: Panjang minimum 1. Panjang maksimum 256.
+ Pola: `[a-zA-Z0-9_.-]+`
+ Wajib: Ya
+ **recipientClientId**- Pengidentifikasi unik untuk penerima.
+ Tipe: String
+ Panjang batasan: Panjang minimum 1. Panjang maksimum 256.
+ Pola: `[a-zA-Z0-9_.-]+`
+ Wajib: Ya
+ **MessagePayLoad** - Konten pesan yang disandikan basis-64.
+ Tipe: String
+ Panjang batasan: Panjang minimum 1. Panjang maksimum 10K.
+ Wajib: Ya
+ **CorrelationID** - Sebuah identifier unik untuk pesan.
+ Tipe: String
+ Panjang batasan: Panjang minimum 1. Panjang maksimum 256.
+ Pola: `[a-zA-Z0-9_.-]+`
+ Wajib: Tidak
## Respons
Tidak ada respons yang dikembalikan jika pesan berhasil diterima oleh backend pensinyalan. Jika layanan mengalami kesalahan dan jika `correlationId` ditentukan dalam permintaan, rincian kesalahan dikembalikan sebagai `STATUS_RESPONSE` pesan. Untuk informasi selengkapnya, lihat [Penerimaan pesan asinkron](async-message-reception-api.md).
## Kesalahan
+ InvalidArgumentException
Parameter yang ditentukan melebihi batasannya, tidak didukung, atau tidak dapat digunakan. Untuk informasi selengkapnya, lihat pesan yang dikembalikan.
Kode Status HTTP: 400
+ ClientLimitExceededException
Dikembalikan ketika API dipanggil pada tingkat yang terlalu tinggi. Untuk informasi selengkapnya, lihat [Amazon Kinesis Video Streams dengan kuota layanan WebRTC](kvswebrtc-limits.md) dan [Error Retries dan Exponential Backoff](https://docs.aws.amazon.com/general/latest/gr/api-retries.html) di. AWS
Kode Status HTTP: 400
## Batas/Pelambatan
API ini dibatasi pada tingkat akun jika API dipanggil pada tingkat yang terlalu tinggi. Kesalahan dikembalikan saat dibatasi dengan. `ClientLimitExceededException`
## Idempoten
API ini tidak idempoten.
## Coba lagi perilaku
Ini dihitung sebagai panggilan API baru.
## Panggilan bersamaan
Panggilan bersamaan diizinkan. Penawaran dikirim satu kali per setiap panggilan.
# SendIceCandidate
Mengirim kandidat ICE ke penerima target. Prasyaratnya adalah klien harus sudah terhubung ke WebSocket titik akhir yang diperoleh dari API. `GetSignalingChannelEndpoint`
Jika jenis pengirim adalah penampil, maka ia mengirim kandidat ICE ke master. Juga, tidak perlu menentukan `RecipientClientId` dan nilai tertentu untuk `RecipientClientId` diabaikan. Jika jenis pengirim adalah master, kandidat ICE dikirim ke target yang ditentukan oleh. `RecipientClientId` `RecipientClientId`adalah masukan yang diperlukan dalam kasus ini.
Aplikasi klien master diizinkan mengirim kandidat ICE ke penampil mana pun, sedangkan aplikasi klien penampil hanya diizinkan mengirim kandidat ICE ke aplikasi klien utama. Jika aplikasi klien penampil mencoba mengirim kandidat ICE ke aplikasi klien penampil lain, permintaan tersebut TIDAK akan dihormati.
## Permintaan
```
{
"action": "ICE_CANDIDATE",
"recipientClientId": "string",
"messagePayload": "string",
"correlationId": "string"
}
```
+ **action** - Jenis pesan yang sedang dikirim.
+ Jenis: ENUM
+ Nilai valid: `SDP_OFFER`, `SDP_ANSWER`, `ICE_CANDIDATE`
+ Panjang batasan: Panjang minimum 1. Panjang maksimum 256.
+ Pola: `[a-zA-Z0-9_.-]+`
+ Wajib: Ya
+ **recipientClientId**- Pengidentifikasi unik untuk penerima.
+ Tipe: String
+ Panjang batasan: Panjang minimum 1. Panjang maksimum 256.
+ Pola: `[a-zA-Z0-9_.-]+`
+ Wajib: Tidak
+ **MessagePayLoad** - Konten pesan yang dikodekan base64.
+ Tipe: String
+ Panjang batasan: Panjang minimum 1. Panjang maksimum 10K.
+ Wajib: Ya
+ **CorrelationID** - Sebuah identifier unik untuk pesan.
+ Tipe: String
+ Panjang batasan: Panjang minimum 1. Panjang maksimum 256.
+ Pola: `[a-zA-Z0-9_.-]+`
+ Wajib: Tidak
## Respons
Tidak ada respons yang dikembalikan jika pesan berhasil diterima oleh backend pensinyalan. Jika layanan mengalami kesalahan dan jika `correlationId` ditentukan dalam permintaan, rincian kesalahan dikembalikan sebagai `STATUS_RESPONSE` pesan. Untuk informasi selengkapnya, lihat [Penerimaan pesan asinkron](async-message-reception-api.md).
## Kesalahan
+ InvalidArgumentException
Parameter yang ditentukan melebihi batasannya, tidak didukung, atau tidak dapat digunakan. Untuk informasi selengkapnya, lihat pesan yang dikembalikan.
Kode Status HTTP: 400
+ ClientLimitExceededException
Ketika API dipanggil pada tingkat yang terlalu tinggi. Untuk informasi selengkapnya, lihat [Amazon Kinesis Video Streams dengan kuota layanan WebRTC](kvswebrtc-limits.md) dan [Error Retries dan Exponential Backoff](https://docs.aws.amazon.com/general/latest/gr/api-retries.html) di. AWS
Kode Status HTTP: 400
## Batas/Pelambatan
API ini dibatasi pada tingkat akun jika API dipanggil pada tingkat yang terlalu tinggi. Kesalahan kembali saat dibatasi dengan. `ClientLimitExceededException`
## Idempoten
API ini tidak idempoten.
## Coba lagi perilaku
Ini dihitung sebagai panggilan API baru.
## Panggilan bersamaan
Panggilan bersamaan diizinkan. Penawaran dikirim satu kali per setiap panggilan.
# Putuskan sambungan
Klien dapat menutup koneksi kapan saja. WebSocket-pustaka yang sesuai mendukung fungsionalitas dekat. Ketika koneksi ditutup, layanan menandai klien sebagai offline untuk saluran pensinyalan tertentu dan tidak mencoba mengirimkan pesan apa pun. Perilaku yang sama juga berlaku jika terjadi batas waktu koneksi idle.
Layanan ini juga mengirimkan indikasi pemutusan ke klien, misalnya, selama penerapan atau pemeliharaan server. Berikut ini adalah pesan indikasi yang ditentukan:
+ **GO\$1AWAY**: Pesan ini digunakan untuk memulai shutdown koneksi. Ini memungkinkan klien untuk memproses pesan sebelumnya dengan anggun, memutuskan sambungan, dan menyambung kembali ke saluran pensinyalan jika diperlukan.
+ **RECONNECT\$1ICE\$1SERVER**: Pesan ini digunakan untuk memulai shutdown koneksi relay dan memungkinkan klien untuk memutuskan sambungan dengan anggun, mendapatkan konfigurasi server ICE baru, dan menyambung kembali ke server relai jika diperlukan.