Endpoint de compartilhamento de tela

O endpoint de sessões de compartilhamento de tela dá acesso ao serviço de compartilhamento de tela.

Endpoint de sessões de compartilhamento de tela

Parâmetro	Obrigatório	Tipo de dados	Definição
ext_session_id	TRUE	String	O ID da sessão externa de compartilhamento de tela

Endpoint:

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

Cabeçalhos:

Chave	Valor	Descrição
Content-Type	application/json

Corpo:

{}

Exemplo de solicitação e respostas

As seções a seguir fornecem exemplos de solicitações ao endpoint.

Encerrar uma sessão de compartilhamento de tela usando um ID de sessão externa

Este exemplo mostra como encerrar uma sessão de Compartilhamento de tela em andamento.

Solicitação

É possível encerrar uma sessão de compartilhamento de tela usando um ID de sessão externa.

Cabeçalhos:

Chave	Valor	Descrição
Content-Type	application/json

Consulta

Parâmetro	Obrigatório	Tipo de dados	Definição
ext_session_id	TRUE	String	O ID da sessão externa de compartilhamento de tela

URL de solicitação:

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

Substitua:

• SUBDOMAIN: o nome do locatário da plataforma CCAI.

• DOMAIN: o domínio da instância.

• EXTERNAL_SESSION_ID: o ID da sessão externa da sessão de compartilhamento de tela que você quer encerrar.

Resposta: sessão encerrada

{
    "message": "Session terminated"
}

Código de status:200