Endpoint de compartilhamento de tela

O endpoint de sessões do Compartilhamento de tela oferece acesso ao serviço de Compartilhamento de tela.

Endpoint de sessões do Compartilhamento de tela

Parâmetro	Obrigatório	Tipo de dados	Definição
ext_session_id	TRUE	String	O ID externo da sessão do 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	aplicativo/json

Corpo:

{}

Exemplo de solicitação e respostas

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

Encerrar uma sessão do Compartilhamento de tela usando um ID de sessão externo

Este exemplo mostra como encerrar uma sessão atual do Compartilhamento de tela.

Solicitação

Você pode encerrar uma sessão do Compartilhamento de tela usando um ID de sessão externo.

Cabeçalhos:

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

Query:

Parâmetro	Obrigatório	Tipo de dados	Definição
ext_session_id	TRUE	String	O ID externo da sessão do 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 CCAI Platform.

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

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

Resposta: sessão encerrada

{
    "message": "Session terminated"
}

Código de status: 200