El endpoint de sesiones de Screen Share proporciona acceso al servicio de Screen Share.
Extremo de sesiones de uso compartido de pantalla
| Parámetro | Obligatorio | Tipo de datos | Definición |
|---|---|---|---|
| ext_session_id | TRUE | String | ID de la sesión de pantalla compartida externa |
Endpoint:
Method: POST
Type: RAW
URL: https://{{subdomain}}.{{domain}}/apps/api/v1/cobrowse_sessions/
Encabezados:
| Clave | Valor | Descripción |
|---|---|---|
| Content-Type | application/json |
Cuerpo:
{}
Ejemplo de solicitud y respuestas
En las siguientes secciones, se proporcionan ejemplos de solicitudes al extremo.
Finaliza una sesión de pantalla compartida con un ID de sesión externo
En este ejemplo, se muestra cómo finalizar una sesión actual de Compartir pantalla.
Solicitud
Puedes finalizar una sesión de Compartir pantalla con un ID de sesión externo.
Encabezados:
| Clave | Valor | Descripción |
|---|---|---|
| Content-Type | application/json |
Consulta:
| Parámetro | Obligatorio | Tipo de datos | Definición |
|---|---|---|---|
| ext_session_id | TRUE | String | ID de la sesión de pantalla compartida externa |
URL de la solicitud:
POST https://SUBDOMAIN.DOMAIN/apps/api/v1/cobrowse_sessions/EXTERNAL_SESSION_ID/end
Reemplaza lo siguiente:
SUBDOMAIN: Es el nombre de tu usuario de CCAI Platform.DOMAIN: Es el dominio de tu instancia.EXTERNAL_SESSION_ID: Es el ID de sesión externo de la sesión de Screen Share que deseas finalizar.
Respuesta: Se finalizó la sesión
{
"message": "Session terminated"
}
Código de estado: 200