Ir para o conteúdo

HTTP API

A API HTTP permite obter acesso programático à maioria das funções disponíveis dentro da área pessoal: gerenciamento de computadores, criação de conexões pendentes.

Solicitações

Todas as solicitações devem ser realizadas por meio do protocolo HTTPS (não HTTP) usando o devido método para cada comando em https://api.getscreen.me/v1/

Respostas

As respostas de dados são dadas em formato JSON, codificação UTF-8 e ContentType: application/json . Em cada resposta, os dados são embrulhados em um contêiner JSON data

O servidor API pode retornar os seguintes códigos de resposta HTTP:

Códigos de resposta HTTP Descrição
200 OK Solicitação aceita e processada
400 Bad Request Solicitação rejeitada, parâmetros errados, erro
402 Payment Required Solicitação rejeitada, excedido o limite de solicitações do plano tarifário
403 Forbidden Solicitação rejeitada, não é possível acessar os dados
404 Not Found Solicitação rejeitada, URL desconhecida

Autenticação

A API é uma API RESTful, o que significa que o servidor não armazena o estado da conexão com o cliente. Por isso, cada vez que uma solicitação é enviada, o cliente tem que enviar dados de autorização. Esses dados são utilizados como chave API. Adicione a chave em cada solicitação no parâmetro ?apikey=

https://api.getscreen.me/v1/?apikey=YOUR_API_KEY

ℹ Sua chave API pode ser encontrada em sua área pessoal na seção "Integrações" na guia API HTTP

Métodos

São comandos para o gerenciamento de computadores e conexões. Nós os dividimos em vários grupos:


Acesso permanente

Lista de computadores

Você pode obter uma lista completa de computadores usando o método agents/list

ℹ No contexto das chamadas API, os computadores serão chamados de "Agentes" porque, tecnicamente, o computador é controlado através do programa agente de controle

Solicitação:

GET https://api.getscreen.me/v1/agents/list
 ?apikey=<string>

Parâmetros da solicitação:

Parâmetro Tipo Valor
apikey string Chave API para autorização da solicitação
search string Pesquisar por nome de agente, endereço IP ou nome de grupo
group_id string Filtrar por ID de grupo

Resposta:

{
    "data":[ {
        "id":1001,
        "name":"Allesandro Paci",
        "group":"Accounting",
        "disabled":false,
        "limited":false,
        "link_time":1587837997,
        "last_time":1600374761,
        "geo":{
            "ip":"2.21.31.68",
            "country":"USA",
            "region":"California",
            "city":"Los Angeles"
        },
        "permanent_url":"https://go.getscreen.me/paci",
        "preview_url":"https://getscreen.me/preview/1245273f5448a704379da46f476564a592efb17c6a7695adde96247cd7874416GbBzRm6SRLMqrP0YoYFMxCopL6NTzvn8.png",
        "os":"win",
        "version":"1.9.4",
        "online":true,
        "installed":true,
        "favorite":false,
        "owner":"john.smith@gmail.com",
        "sessions":{
            "last":{
                "id":148505,
                "start_time":1600343858,
                "stop_time":1600343900,
                "client":{
                    "ip":"188.162.195.82",
                    "country":"Russian Federation",
                    "region":"Tatarstan",
                    "city":"Kazan",
                    "user_agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/85.0.4183.102 Safari/537.36"
                }
            },
            "total":121
        }
    }, ... ]
}

Dados da resposta:

Nome Tipo Descrição
id number Identificador intrassistema
name string Nome
group string Grupo
disabled boolean
O agente está bloqueado?

⚠ Os agentes bloqueados não podem ser acessados. O bloqueio ocorre quando o número de computadores no plano é excedido.
limited boolean
O agente está limitado?

ℹ O agente é limitado se o número de arquivos anexos que corresponde ao plano atual for excedido. Após 10 dias de ser adicionado, o agente limitado é bloqueado.
link_time unixtime Data e hora da adição à área pessoal
last_time unixtime Data e hora do último status "on-line"
geo object Localização
geo.ip string Endereço IP
geo.country string País
geo.region string Região
geo.city string Cidade
permanent_url string
URL de conexão permanente

ℹ Este campo pode não estar presente se o acesso para usuários não autorizados for restrito
onetime_url string
URL de conexão uma única vez

⚠ O link muda a cada 45 segundos

ℹ Este campo pode não estar presente se as conexões via links descartáveis estiverem desabilitadas nas configurações do agente
preview_url string URL para carregamento das prévias da área de trabalho
os string Sistema operacional. Possíveis valores: win, mac, linux e android
version string Versão do agente de controle
online boolean Status atual "On-line"
installed boolean O agente está instalado no computador?
favorite boolean Este é o computador preferido na lista de sua área pessoal?
owner string Conta do proprietário do acesso ao computador dentro do sistema
sessions object Informações sobre conexões
sessions.last object Última conexão
sessions.last.id number Identificador de conexão intrassistema
sessions.last.start_time unixtime Data e hora de início da conexão
sessions.last.stop_time unixtime Data e hora de término da conexão

ℹ O campo pode não estar presente se a conexão estiver ativa
sessions.last.client object Informações sobre o cliente (autor da conexão)
sessions.last.client.ip string Endereço IP
sessions.last.client.country string País
sessions.last.client.region string Região
sessions.last.client.city string Cidade
sessions.last.client.user_agent string Agente de usuário do navegador do cliente
sessions.total object Número total de conexões

Informações do computador

Para consultar informações do computador na seção Acesso permanente, você precisa usar o método agents/info

Solicitação:

GET https://api.getscreen.me/v1/agents/info
  ?apikey=<string>
  &agent_id=<number>

Parâmetros da solicitação:

Parâmetro Tipo Valor
apikey string Chave API para autorização da solicitação
agent_id number ID intrassistema do agente

Resposta:

{
    "data": {
        "id": 1001,
        "name": "Allesandro Paci",
        "group": "Accounting",
        "disabled": false,
        "limited": false,
        "link_time": 1587837997,
        "last_time": 1600374761,
        "geo": {
            "ip": "2.21.31.68",
            "country": "USA",
            "region": "California",
            "city": "Los Angeles"
        },
        "permanent_url": "https://go.getscreen.me/paci",
        "onetime_url": "https://go.getscreen.me/am2-l2g",
        "preview_url": "https://getscreen.me/preview/1245273f5448a704379da46f476564a592efb17c6a7695adde96247cd7874416GbBzRm6SRLMqrP0YoYFMxCopL6NTzvn8.png",
        "os": "win",
        "version": "2.7.6",
        "online": true,
        "installed": true,
        "favorite": false,
        "owner": "john.smith@gmail.com",
        "hardware": {
            "BIOS": "ALASKA - 1072009 - F51 - American Megatrends - 5000E",
            "BIOSDate": "",
            "BIOSVersion": "20191218",
            "CPU": "AMD Ryzen 5 2600X Six-Core Processor",
            "CPUCores": 6,
            "CPUCoresLogical": 12,
            "CPUFamily": "AMD64 Family 23 Model 8 Stepping 2",
            "CPUSpeed": 3600,
            "ComputerDomain": "WORKGROUP",
            "ComputerIP": [
                "10.66.65.3",
                "fe80::35da:bb0:c661:fff9"
            ],
            "ComputerModel": "B450 AORUS ELITE",
            "ComputerName": "DESKTOP-AU0VQEE",
            "ComputerWorkgroup": "WORKGROUP",
            "HDD": [ {
                "Model": "INTEL SSDPEKNW512G8",
                "Size": 488382
            } ],
            "Locale": "0419",
            "LocaleCountry": "USA",
            "LocaleCurrency": "USD",
            "LocaleFormatDate": "MM-DD-YYYY",
            "LocaleFormatTime": "H:mm:ss",
            "LocaleOemPage": "437",
            "LocaleTimezone": -420,
            "LogicalDisks": [ {
                "Disk": "C:",
                "FileSystem": "NTFS",
                "FreeSpace": 13668,
                "Name": "",
                "Size": 487757
            } ],
            "Monitors": [ {
                "Name": "Universal PnP monitor",
                "ScreenHeight": 1080,
                "ScreenWidth": 1920
            } ],
            "NetAdapters": [ {
                "Addresses": "",
                "Cable": true,
                "DCHP": "",
                "DNS": "",
                "MACAddress": "18:C0:4D:44:F0:61",
                "Manufacturer": "Realtek",
                "Name": "Realtek Gaming GbE Family Controller",
                "Speed": 953,
                "WoL": true
            } ],
            "OSName": "Microsoft Windows 10 Pro",
            "OSVersion": "10.0.19044",
            "RAMBanks": [ {
                "Bank": "P0 CHANNEL A",
                "Capacity": 8192,
                "DataWidth": 64,
                "Locator": "DIMM 0",
                "Manufacturer": "Unknown",
                "PartNumber": "F4-3200C16-8GSXFB",
                "SerialNumber": "00000000"
            } ],
            "RAMPageFile": 51264,
            "RAMPhys": 32716,
            "RAMPhysAvail": 9380,
            "RAMVirt": 134217727,
            "RAMVirtAvail": 134213282,
            "SoundDevices": [ {
                "Name": "NVIDIA High Definition Audio"
            } ],
            "VideoCards": [ {
                "Integrated": true,
                "Name": "NVIDIA GeForce GT 710",
                "RAM": 1024
            } ],
            "VideoName": "NVIDIA GeForce GT 710",
            "VideoRAM": 1024
        },
        "sessions": {
            "last": {
                "id":148505,
                "start_time":1600343858,
                "stop_time":1600343900,
                "client":{
                    "ip":"188.162.195.82",
                    "country":"Russian Federation",
                    "region":"Tatarstan",
                    "city":"Kazan",
                    "user_agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/85.0.4183.102 Safari/537.36"
                }
            },
            "total": 1
        }
    }
}

Dados da resposta:

Nome Tipo Descrição
id number Identificador intrassistema
name string Nome
group string Grupo
disabled boolean
O agente está bloqueado?

⚠ Os agentes bloqueados não podem ser acessados. O bloqueio ocorre quando o número de computadores no plano é excedido.
limited boolean
O agente está limitado?

ℹ O agente é limitado se o número de arquivos anexos que corresponde ao plano atual for excedido. Após 10 dias de ser adicionado, o agente limitado é bloqueado.
link_time unixtime Data e hora da adição à área pessoal
last_time unixtime Data e hora do último status "on-line"
geo object Localização
geo.ip string Endereço IP
geo.country string País
geo.region string Região
geo.city string Cidade
permanent_url string
URL de conexão permanente

ℹ Este campo pode não estar presente se o acesso para usuários não autorizados for restrito
onetime_url string
URL de conexão uma única vez

⚠ O link muda a cada 45 segundos

ℹ Este campo pode não estar presente se as conexões via links descartáveis estiverem desabilitadas nas configurações do agente
preview_url string URL para carregamento das prévias da área de trabalho
os string Sistema operacional. Possíveis valores: win, mac, linux e android
version string Versão do agente de controle
online boolean Status atual "On-line"
installed boolean O agente está instalado no computador?
favorite boolean Este é o computador preferido na lista de sua área pessoal?
owner string Conta do proprietário do acesso ao computador dentro do sistema
hardware object Informações do sistema
hardware.BIOS string Informações da BIOS
hardware.BIOSDate string Data de atualização
hardware.BIOSVersion string Versão
hardware.CPU string Processador
hardware.CPUCores number Número de núcleos
hardware.CPUCoresLogical number Número de processadores lógicos
hardware.CPUFamily string Família
hardware.CPUSpeed number Velocidade
hardware.ComputerDomain string Domínio
hardware.ComputerIP array Endereço IP
hardware.ComputerModel string Modelo
hardware.ComputerName string Nome do computador
hardware.ComputerWorkgroup string Grupo de trabalho
hardware.HDD array Discos rígidos
hardware.HDD[].Model string Modelo
hardware.HDD[].Size number Tamanho
hardware.Locale string Locale
hardware.LocaleCountry string País
hardware.LocaleCurrency string Moeda
hardware.LocaleFormatDate string Formato de data
hardware.LocaleFormatTime string Formato de tempo
hardware.LocaleOemPage string Codificação de página
hardware.LocaleTimezone number Fuso horário
hardware.LogicalDisks array Discos lógicos
hardware.LogicalDisks[].Disk string Rótulo
hardware.LogicalDisks[].FileSystem string Tipo de arquivo de sistema
hardware.LogicalDisks[].FreeSpace number Espaço livre (MB)
hardware.LogicalDisks[].Name string Nome
hardware.LogicalDisks[].Size number Tamanho (MB)
hardware.Monitors array Monitores
hardware.Monitors[].Name string Nome
hardware.Monitors[].ScreenHeight number Altura de tela
hardware.Monitors[].ScreenWidth number Largura de tela
hardware.NetAdapters array Placas de rede
hardware.NetAdapters[].Addresses string Endereço
hardware.NetAdapters[].Cable boolean Conexão à Internet via cabo LAN
hardware.NetAdapters[].DCHP string DCHP
hardware.NetAdapters[].DNS string DNS
hardware.NetAdapters[].MACAddress string Endereço MAC
hardware.NetAdapters[].Manufacturer string Fabricante
hardware.NetAdapters[].Name string Nome
hardware.NetAdapters[].Speed number Velocidade
hardware.NetAdapters[].WoL boolean Wake-on-LAN habilitado
hardware.OSName string Nome do sistema operacional
hardware.OSVersion string Versão do sistema operacional
hardware.RAMBanks array Memória RAM
hardware.RAMBanks[].Bank string Slot
hardware.RAMBanks[].Capacity number Capacidade
hardware.RAMBanks[].Locator string Localizador
hardware.RAMBanks[].Manufacturer string Fabricante
hardware.RAMBanks[].PartNumber string Lote
hardware.RAMBanks[].SerialNumber string Série
hardware.SoundDevices array Placas de som
hardware.SoundDevices[].Name string Nome
hardware.VideoCards array Placa de vídeo
hardware.VideoCards[].Integrated boolean Integrada
hardware.VideoCards[].Name string Nome
hardware.VideoCards[].RAM number Memória
sessions object Informações sobre conexões
sessions.last object Última conexão
sessions.last.id number Identificador de conexão intrassistema
sessions.last.start_time unixtime Data e hora de início da conexão
sessions.last.stop_time unixtime Data e hora de término da conexão

ℹ O campo pode não estar presente se a conexão estiver ativa
sessions.last.client object Informações sobre o cliente (autor da conexão)
sessions.last.client.ip string Endereço IP
sessions.last.client.country string País
sessions.last.client.region string Região
sessions.last.client.city string Cidade
sessions.last.client.user_agent string Agente de usuário do navegador do cliente
sessions.total object Número total de conexões

Alterar propriedade do dispositivo

Para alterar propriedades de algum dispositivo vinculado à sua conta, use o método devices/update

ℹ Você não precisa listar todas as propriedades na solicitação. Só as que você especificar serão alteradas. Consulte os parâmetros a seguir para obter uma lista dos campos que podem ser atualizados.

Solicitação:

POST https://api.getscreen.me/v1/agents/update
  ?apikey=<string>

  BODY: {
    "id": <number>,
    "permanent_url": {
      "enable": <boolean>,
      "url": <string>,
      "password": <string>
    }
  }

Parâmetros da solicitação:

Parâmetro Tipo Valor
apikey string Chave API para autorização da solicitação
id number ID intrassistema do agente
permanent_url object Link permanente para conexão
permanent_url.enable boolean Ativar/desativar
permanent_url.url string Caminho do link
permanent_url.password string Senha de conexão (pelo menos 8 caracteres, letras e dígitos)

Resposta:

{
    "status": 0,
    "data": { ... }
}

Dados da resposta:

Nome Tipo Descrição
number status Status do resultado. Valores possíveis:
  • 0 - Dados salvos com sucesso
  • 1 - Solicitação inválida
  • 7 - Esse caminho para o link permanente já está sendo usado
  • 8 - Alteração de propriedades restrita
  • 21 - Senha de link permanente inválida
data object Dados modificados

Obtendo o link para conexão

Para se conectar a um computador através da API, você precisa obter um link descartável usando o método agents/connect

ℹ O link recebido expira imediatamente após o primeiro uso. Você precisa obter um toda vez que quiser se conectar.

Solicitação:

POST https://api.getscreen.me/v1/agents/connect
  ?apikey=<string>
  &agent_id=<number>

Parâmetros da solicitação:

Parâmetro Tipo Valor
apikey string Chave API para autorização da solicitação
agent_id number ID intrassistema do agente
device_id number Identificador público do agente. Disponível no cartão do agente em sua área pessoal.

ℹ Usado se o parâmetro agent_id não for especificado.

Resposta:

{
    "data":{
        "url": "https://go.getscreen.me/john.smith/?connect=20177&amp;llt=66b4kj671pm3abpp5xh17elpnpze245382m9pxbrx313l2xp52hmxqe4e1dekpej&amp;s=c2c5ca25eb4fca787b74a97648e0856951e2b9c7aa02cbf83ac62c81e21a9bab"
    }
}

Dados da resposta:

Nome Tipo Descrição
url string URL para conexão

Sair da conta

Para desvincular o dispositivo de sua conta e removê-lo do acesso permanente, use o método agents/logout

⚠ Cuidado! Após desvinculado o dispositivo, você não poderá mais controlá-lo.

Solicitação:

POST https://api.getscreen.me/v1/agents/logout
  ?apikey=<string>
  &agent_id=<number>

Parâmetros da solicitação:

Parâmetro Tipo Valor
apikey string Chave API para autorização da solicitação
agent_id number ID intrassistema do agente

Resposta:

{
    "status": 0
}

Dados da resposta:

Nome Tipo Descrição
number status Status do resultado. Valores possíveis:
  • 0 - Desconexão do dispositivo bem-sucedida
  • 1 - Solicitação incorreta
  • 6 - Dispositivo não encontrado
  • 8 - Operação restrita

Suporte rápido

Lista de conexões abertas

Para obter a lista de conexões abertas a partir da seção Suporte rápido, use o método support/list

Solicitação:

GET https://api.getscreen.me/v1/support/list
  ?apikey=<string>

Parâmetros da solicitação:

Parâmetro Tipo Valor
apikey string Chave API para autorização da solicitação

Resposta:

{
    "remain":100,
    "data":[ {
        "id":328,
        "status":0,
        "create_time":1600262268,
        "invite_code":"408080316",
        "invite_url":"https://go.getscreen.me/invite/408080316",
        "connect_url":"https://go.getscreen.me/turbo/nrhaStVwQSQ1J4DW0cL4wc1ADUeyug8BZjFaCgEqT4wuFXSPXQrGoRRBUxK1uFTU1Sr7bYlsviZ0djTophpmnIhpaZuMfGSKdSefcDzOWCgJuGeHGA5hFkcflhAXhBrx",
        "client_name":"Jacob Williams",
        "client_os":"",
        "client_preview_url":""
    } ]
}
Dados de gravação de conexão:

Nome Tipo Descrição
id number Identificador de conexão intrassistema
status number Status da conexão. Possíveis valores:
  • 0 - Nova conexão, à espera de que o cliente ingresse
  • 1 - Cliente conectado, à espera de que o operador ingresse
  • 2 - Conexão ativa, todos os participantes ingressaram
  • 3 - Conexão fechada
create_time unixtime Data e hora de criação de conexão
invite_code string Código de convite
invite_url string URL de convite
connect_url string URL para o operador ingressar
client_name string Nome do cliente
client_os string Sistema operacional. Possíveis valores: win, mac, linux e android

ℹ Campo a ser preenchido após o cliente ingressar
client_preview_url string Miniatura da área de trabalho do cliente

ℹ Campo a ser preenchido após o cliente ingressar

Dados adicionais:

Nome Tipo Descrição
remain number Número de conexões restantes aplicáveis ao plano tarifário

Criando conexão

Para criar uma conexão pendente para suporte remoto, use o método support/create

Solicitação:

POST https://api.getscreen.me/v1/support/create
  ?apikey=<string>
  &client_name=<string>

Parâmetros da solicitação:

Parâmetro Tipo Valor
apikey string Chave API para autorização da solicitação
client_name string Nome do cliente (visível só para você). Parâmetro opcional.

Resposta:

{
    "data":{
        "id":328,
        "status":0,
        "create_time":1600262268,
        "invite_code":"408080316",
        "invite_url":"https://go.getscreen.me/invite/408080316",
        "connect_url":"https://go.getscreen.me/turbo/nrhaStVwQSQ1J4DW0cL4wc1ADUeyug8BZjFaCgEqT4wuFXSPXQrGoRRBUxK1uFTU1Sr7bYlsviZ0djTophpmnIhpaZuMfGSKdSefcDzOWCgJuGeHGA5hFkcflhAXhBrx",
        "client_name":"Jacob Williams",
        "client_os":"",
        "client_preview_url":""
    }
}

Dados da resposta:

Nome Tipo Descrição
id number Identificador de conexão intrassistema
status number Status da conexão. Possíveis valores:
  • 0 - Nova conexão, à espera de que o cliente ingresse
  • 1 - Cliente conectado, à espera de que o operador ingresse
  • 2 - Conexão ativa, todos os participantes ingressaram
  • 3 - Conexão fechada
create_time unixtime Data e hora de criação de conexão
invite_code string Código de convite
invite_url string URL de convite
connect_url string URL para o operador ingressar
client_name string Nome do cliente
client_os string Sistema operacional. Possíveis valores: win, mac, linux e android

ℹ Campo a ser preenchido após o cliente ingressar
client_preview_url string Miniatura da área de trabalho do cliente

ℹ Campo a ser preenchido após o cliente ingressar

Informações sobre a conexão

Para obter informações sobre uma conexão específica, use o método support/info

Solicitação:

GET https://api.getscreen.me/v1/support/info
  ?apikey=<string>
  &connection_id=<number>

Parâmetros da solicitação:

Parâmetro Tipo Valor
apikey string Chave API para autorização da solicitação
connection_id number* Identificador de conexão intrassistema

Resposta:

{
    "data":{
        "id":328,
        "status":2,
        "create_time":1600262268,
        "invite_code":"408080316",
        "invite_url":"https://go.getscreen.me/invite/408080316",
        "connect_url":"https://go.getscreen.me/turbo/nrhaStVwQSQ1J4DW0cL4wc1ADUeyug8BZjFaCgEqT4wuFXSPXQrGoRRBUxK1uFTU1Sr7bYlsviZ0djTophpmnIhpaZuMfGSKdSefcDzOWCgJuGeHGA5hFkcflhAXhBrx",
        "client_name":"Jacob Williams",
        "client_os":"win",
        "client_preview_url":"https://getscreen.me/preview/f90d07668bccd418a5a8922f2ee455f1eb004c2bbeb5f9fe05ed6970c3389114Zl5PgknTWlU0fWBe4b9YoHNvRlD5Iwl5.png"
    }
}

Dados da resposta:

Nome Tipo Descrição
id number Identificador de conexão intrassistema
status number Status da conexão. Possíveis valores:
  • 0 - Nova conexão, à espera de que o cliente ingresse
  • 1 - Cliente conectado, à espera de que o operador ingresse
  • 2 - Conexão ativa, todos os participantes ingressaram
  • 3 - Conexão fechada
create_time unixtime Data e hora de criação de conexão
invite_code string Código de convite
invite_url string URL de convite
connect_url string URL para o operador ingressar
client_name string Nome do cliente
client_os string Sistema operacional. Possíveis valores: win, mac, linux e android

ℹ Campo a ser preenchido após o cliente ingressar
client_preview_url string Miniatura da área de trabalho do cliente

ℹ Campo a ser preenchido após o cliente ingressar

Encerrando conexão

Para encerrar a conexão, use o método support/close

Solicitação:

POST https://api.getscreen.me/v1/support/close
  ?apikey=<string>
  &connection_id=<number>

Parâmetros da solicitação:

Parâmetro Tipo Valor
apikey string Chave API para autorização da solicitação
connection_id number* Identificador de conexão intrassistema

Resposta:

A resposta chegará com o conteúdo vazio. Para analisar a execução do comando, utilize apenas o código de resposta HTTP.

Histórico de conexões

Obtendo a lista de conexões

Veja sua lista de conexões, usando o método history/list

Solicitação:

GET https://api.getscreen.me/v1/history/list
  ?apikey=<string>
  &agent_id=<number>
  &support_id=<number>
  &date_from=<unixtime>
  &date_to=<unixtime>
  &video=<boolean>
  &offset=<number>
  &limit=<number>

Parâmetros da solicitação:

Parâmetro Tipo Valor
apikey string Chave API para autorização da solicitação
agent_id string Filtrar por ID do agente
support_id number Filtrar pelo identificador de conexão do Suporte rápido
date_from unixtime Filtrar por data e hora - início do período
date_to unixtime Filtrar por data e hora - fim do período
video boolean Filtrar por gravação de vídeo
offset number Recuo do primeiro item da lista
limit number O número de itens na lista. O valor padrão é 20, o valor máximo, 100

Resposta:

{
    "offset": 0,
    "limit": 10,
    "total": 15,
    "filter": {
        "date_from": 1608660281,
        "date_to": 1608660389,
        "agent_id": 1001,
        "support_id": 1002,
        "video": true
    },
    "data": [ {
        "id": 27233,
        "start": 1608660273,
        "stop": 1608660281,
        "support_id": 1002,
        "clients": [ {
            "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.88 Safari/537.36",
            "login": "john.smith@gmail.com",
            "geo": {
                "ip": "2.21.31.68",
                "country": "USA",
                "region": "California",
                "city": "Los Angeles"
            }
        } ],
        "agent": {
            "id": 1001,
            "name": "DESKTOP-SJBU5PO",
            "group": "Accounting",
            "geo": {
                "ip": "2.21.31.68",
                "country": "USA",
                "region": "California",
                "city": "Los Angeles"
            },
            "os": "win",
            "version": "2.1.5",
            "owner": "john.smith@gmail.com"
        },
        "video": {
            "url": "https://st1.getscreen.me/video/2/27233.mp4",
            "size": 428652
        }
    }, ... ]
}

Dados da resposta:

Nome Tipo Descrição
id number Identificador de conexão intrassistema
start unixtime Data e hora de início da conexão
stop unixtime Data e hora de término da conexão

ℹ Pode ficar em branco se a conexão não for completada
support_id number Identificador de conexão do Suporte rápido

ℹ Pode estar em branco se a conexão foi feita a um dispositivo do Acesso permanente
clients array Lista de clientes que ingressaram
clients[].user_agent string Agente de usuário
clients[].login string Nome de usuário

ℹ Pode estar em branco se a conexão foi anônima
clients[].geo object Localização
clients[].geo.ip string Endereço IP
clients[].geo.country string País
clients[].geo.region string Região
clients[].geo.city string Cidade
agent object Informações sobre o agente
agent.id number ID intrassistema do agente
agent.name string Nome
agent.group string Grupo
agent.geo object Localização
agent.geo.ip string Endereço IP
agent.geo.country string País
agent.geo.region string Região
agent.geo.city string Cidade
agent.os string Sistema operacional. Possíveis valores: win, mac, android e linux
agent.version string Versão do programa
agent.owner string Usuário da conta do proprietário do acesso permanente
video object Informações sobre gravação de vídeo

ℹ Pode não estar presente se não houver gravação em vídeo da conexão
video.url string Endereço para baixar o arquivo de vídeo da gravação

⚠ Para baixar o arquivo de vídeo da gravação da conexão, você deve adicionar o parâmetro ?apikey= com o valor de sua chave API.
video.size number Tamanho do arquivo de vídeo da gravação em bytes

Last update: 26 de março de 2024