Endpoint Berbagi Layar

Endpoint sesi Berbagi Layar memberikan akses ke layanan Berbagi Layar.

Endpoint sesi Berbagi Layar

Parameter Wajib Jenis Data Definisi
ext_session_id TRUE String ID sesi Berbagi Layar eksternal

Endpoint:

Method: POST
Type: RAW
URL: https://{{subdomain}}.{{domain}}/apps/api/v1/cobrowse_sessions/

Header:

Kunci Nilai Deskripsi
Content-Type application/json

Isi:

{}

Contoh permintaan dan respons

Bagian berikut memberikan contoh permintaan ke endpoint.

Mengakhiri sesi Berbagi Layar menggunakan ID sesi eksternal

Contoh ini menunjukkan cara mengakhiri sesi Berbagi Layar saat ini.

Permintaan

Anda dapat mengakhiri sesi Berbagi Layar menggunakan ID sesi eksternal.

Header:

Kunci Nilai Deskripsi
Content-Type application/json

Kueri:

Parameter Wajib Jenis Data Definisi
ext_session_id TRUE String ID sesi Berbagi Layar eksternal

URL permintaan:

POST https://SUBDOMAIN.DOMAIN/apps/api/v1/cobrowse_sessions/EXTERNAL_SESSION_ID/end

Ganti kode berikut:

  • SUBDOMAIN: Nama tenant CCAI Platform Anda.

  • DOMAIN: Domain untuk instance Anda.

  • EXTERNAL_SESSION_ID: ID sesi eksternal untuk sesi Berbagi Layar yang ingin Anda akhiri.

Respons: Sesi dihentikan
{
    "message": "Session terminated"
}

Kode Status: 200