Zum Inhalt

HTTP API

HTTP API ermöglicht es Ihnen einen Programmzugriff zu den meisten in Ihrem persönlichen Konto verfügbaren Funktionen zu erhalten: Computer verwalten, ausstehende Verbindungen erstellen.

Anfragen

Alle Anfragen müssen nach HTTPS Protokoll (nicht HTTP) mit der entsprechenden Methode für jeden Befehl unter https://api.getscreen.me/v1/ ausgeführt werden

Antworten

Antworten mit Daten werden im JSON-Format in UTF-8-Codierung mit ContentType: application/json zurückgegeben. In jeder Antwort werden die Daten in einen JSON-Container verpackt data

Der API-Server kann die folgenden HTTP-Antwortcodes zurückgeben:

HTTP-Antwortcode Beschreibung
200 OK Anfrage angenommen und bearbeitet
400 Bad Request Anfrage abgelehnt, ungültige Parameter, Fehler
402 Payment Required Die Anfrage wurde abgelehnt, das Anfragelimit für Ihr Abo wurde überschritten
403 Forbidden Anfrage abgelehnt, kein Zugriff auf Daten
404 Not Found Anfrage abgelehnt, unbekannter URL-Request

Authentifizierung

Die API ist eine RESTful-API – der Server speichert den Status der Kundenverbindung nicht. Daher muss der Kunde bei jeder Anfrage Autorisierungsdaten senden. Für solche Daten wird ein API-Schlüssel verwendet. Fügen Sie den Schlüssel in jeder Anfrage im Parameter hinzu ?apikey=

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

ℹ Ihr API-Schlüssel befindet sich im Benutzerkonto unter "Integration" in der Registerkarte HTTP API

Methoden

Dies sind Befehle zum Verwalten von Computern und Verbindungen. Wir haben sie in mehrere Gruppen eingeteilt:

Dauerhafter Zugriff

Liste der Computer

Sie können eine vollständige Liste der Computer mit der Methode agents/list abrufen

ℹ Im Zusammenhang mit API-Aufrufen werden Computer als "Agenten" bezeichnet, da der Computer im technischen Sinn durch das Agentenprogramm gesteuert wird

Anfrage:

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

Parameter der Anfrage:

Parameter Typ Wert
apikey string API-Schlüssel zum Autorisieren der Anfrage
search string Search by agent name, IP address or group name
group_id string Filter by group ID

Antwort:

{
    "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
        }
    }, ... ]
}

Antwortdaten:

Bezeichnung Typ Beschreibung
id number Systeminterne Kennung
name string Bezeichnung
group string Gruppe
disabled boolean
Agent blockiert?

⚠ Eine Verbindung zu blockierten Agenten ist nicht möglich. Die Sperrung erfolgt bei Überschreitung der Computeranzahl des Abonnements.
limited boolean
Ist der Agent beschränkt?

ℹ Der Software-Agent wird beschränkt, wenn die Grenze des Abonnements für die Anzahl der angehängten Dateien überschritten wird. 10 Tage nach dem Hinzufügen wird der eingeschränkte Agent gesperrt.
link_time unixtime Hinzufügungsdatum und Uhrzeit zu Ihrem Benutzerkonto
last_time unixtime Datum und Uhrzeit des zuletzt "Online" Status
geo object Standort
geo.ip string IP-Adresse
geo.country string Land
geo.region string Region
geo.city string Stadt
permanent_url string
Dauerhafte Verbindungs-URL

ℹ Das Feld kann fehlen, wenn unbefugten Benutzern der Zugriff verweigert wird
onetime_url string
URL für eine einmalige Verbindung

⚠ Der Link ändert sich alle 45 Sekunden

ℹ Das Feld kann fehlen, wenn Verbindungen über Einmal-Links in den Agenteneinstellungen deaktiviert sind
preview_url string URL zum Herunterladen der Desktop-Vorschau
os string Betriebssystem. Mögliche Werte: win, mac, linux und android
version string Programmversion des Agenten
online boolean Aktueller Status «Online»
installed boolean Ist der Software-Agent auf dem Computer installiert?
favorite boolean Ist dieser Computer ein Favorit in der Liste in Ihrem Benutzerkonto?
owner string Benutzerkonto des Inhabers des Zugriffs auf den Computer innerhalb des Systems
sessions object Information zu den Verbindungen
sessions.last object Letzte Verbindung
sessions.last.id number Systeminterne Kennung der Verbindung
sessions.last.start_time unixtime Datum und Uhrzeit des Verbindungsbeginns
sessions.last.stop_time unixtime Datum und Uhrzeit des Verbindungsendes

ℹ Das Feld kann fehlen, wenn die Verbindung aktiv ist
sessions.last.client object Kundeninformationen (Ersteller der Verbindung)
sessions.last.client.ip string IP-Adresse
sessions.last.client.country string Land
sessions.last.client.region string Region
sessions.last.client.city string Stadt
sessions.last.client.user_agent string User Agent des Kunden-Browsers
sessions.total object Gesamtanzahl an Verbindungen

Information zum Computer

Um Informationen über einen Computer aus dem Abschnitt Dauerhafter Zugriff zu erhalten, müssen Sie die Methode agents/info verwenden

Anfrage:

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

Parameter der Anfrage:

Parameter Typ Wert
apikey string API-Schlüssel zum Autorisieren der Anfrage
agent_id number Systeminterne Kennung des Agenten

Antwort:

{
    "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
        }
    }
}

Antwortdaten:

Bezeichnung Typ Beschreibung
id number Systeminterne Kennung
name string Bezeichnung
group string Gruppe
disabled boolean
Agent blockiert?

⚠ Eine Verbindung zu blockierten Agenten ist nicht möglich. Die Sperrung erfolgt bei Überschreitung der Computeranzahl des Abonnements.
limited boolean
Ist der Agent beschränkt?

ℹ Der Software-Agent wird beschränkt, wenn die Grenze des Abonnements für die Anzahl der angehängten Dateien überschritten wird. 10 Tage nach dem Hinzufügen wird der eingeschränkte Agent gesperrt.
link_time unixtime Hinzufügungsdatum und Uhrzeit zu Ihrem Benutzerkonto
last_time unixtime Datum und Uhrzeit des zuletzt "Online" Status
geo object Standort
geo.ip string IP-Adresse
geo.country string Land
geo.region string Region
geo.city string Stadt
permanent_url string
Dauerhafte Verbindungs-URL

ℹ Das Feld kann fehlen, wenn unbefugten Benutzern der Zugriff verweigert wird
onetime_url string
URL für eine einmalige Verbindung

⚠ Der Link ändert sich alle 45 Sekunden

ℹ Das Feld kann fehlen, wenn Verbindungen über Einmal-Links in den Agenteneinstellungen deaktiviert sind
preview_url string URL zum Herunterladen der Desktop-Vorschau
os string Betriebssystem. Mögliche Werte: win, mac, linux und android
version string Programmversion des Agenten
online boolean Aktueller Status «Online»
installed boolean Ist der Software-Agent auf dem Computer installiert?
favorite boolean Ist dieser Computer ein Favorit in der Liste in Ihrem Benutzerkonto?
owner string Benutzerkonto des Inhabers des Zugriffs auf den Computer innerhalb des Systems
hardware object Systeminformation
hardware.BIOS string BIOS-Information
hardware.BIOSDate string Aktualisierungsdatum
hardware.BIOSVersion string Version
hardware.CPU string Prozessor
hardware.CPUCores number Anzahl der Kerne
hardware.CPUCoresLogical number Anzahl der Logikeinheiten
hardware.CPUFamily string Familie
hardware.CPUSpeed number Geschwindigkeit
hardware.ComputerDomain string Domain
hardware.ComputerIP array IP-Adresse
hardware.ComputerModel string Modell
hardware.ComputerName string Computername
hardware.ComputerWorkgroup string Arbeitsgruppe
hardware.HDD array Festplatten
hardware.HDD[].Model string Modell
hardware.HDD[].Size number Größe
hardware.Locale string Gebietsschema
hardware.LocaleCountry string Land
hardware.LocaleCurrency string Währung
hardware.LocaleFormatDate string Datumsformat
hardware.LocaleFormatTime string Zeitformat
hardware.LocaleOemPage string Seitencodierung
hardware.LocaleTimezone number Zeitzone
hardware.LogicalDisks array Logische Laufwerke
hardware.LogicalDisks[].Disk string Etikett
hardware.LogicalDisks[].FileSystem string Dateisystemtyp
hardware.LogicalDisks[].FreeSpace number Freier Speicherplatz (MB)
hardware.LogicalDisks[].Name string Bezeichnung
hardware.LogicalDisks[].Size number Größe (MB)
hardware.Monitors array Bildschirme
hardware.Monitors[].Name string Bezeichnung
hardware.Monitors[].ScreenHeight number Bildschirmhöhe
hardware.Monitors[].ScreenWidth number Bildschirmbreite
hardware.NetAdapters array Netzwerkkarten
hardware.NetAdapters[].Addresses string Adresse
hardware.NetAdapters[].Cable boolean Internetverbindung über LAN-Kabel
hardware.NetAdapters[].DCHP string DCHP
hardware.NetAdapters[].DNS string DNS
hardware.NetAdapters[].MACAddress string MAC-Adresse
hardware.NetAdapters[].Manufacturer string Hersteller
hardware.NetAdapters[].Name string Bezeichnung
hardware.NetAdapters[].Speed number Geschwindigkeit
hardware.NetAdapters[].WoL boolean Wake-on-LAN-Einstellung aktiviert
hardware.OSName string Name des Betriebssystems
hardware.OSVersion string Betriebssystemversion
hardware.RAMBanks array RAM-Speicher
hardware.RAMBanks[].Bank string Slot
hardware.RAMBanks[].Capacity number Kapazität
hardware.RAMBanks[].Locator string Ortung
hardware.RAMBanks[].Manufacturer string Hersteller
hardware.RAMBanks[].PartNumber string Partie
hardware.RAMBanks[].SerialNumber string Seriennummer
hardware.SoundDevices array Soundkarten
hardware.SoundDevices[].Name string Bezeichnung
hardware.VideoCards array Grafikkarte
hardware.VideoCards[].Integrated boolean Integriert
hardware.VideoCards[].Name string Bezeichnung
hardware.VideoCards[].RAM number Speicher
sessions object Information zu den Verbindungen
sessions.last object Letzte Verbindung
sessions.last.id number Systeminterne Kennung der Verbindung
sessions.last.start_time unixtime Datum und Uhrzeit des Verbindungsbeginns
sessions.last.stop_time unixtime Datum und Uhrzeit des Verbindungsendes

ℹ Das Feld kann fehlen, wenn die Verbindung aktiv ist
sessions.last.client object Kundeninformationen (Ersteller der Verbindung)
sessions.last.client.ip string IP-Adresse
sessions.last.client.country string Land
sessions.last.client.region string Region
sessions.last.client.city string Stadt
sessions.last.client.user_agent string User Agent des Kunden-Browsers
sessions.total object Gesamtanzahl an Verbindungen

Change device property

To change some property of a device bound to your account, you can use the devices/update method

ℹ You do not have to list all properties in the query. Only the ones you specify will be changed. See the parameters below for a list of fields available for updating.

Anfrage:

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

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

Parameter der Anfrage:

Parameter Typ Wert
apikey string API-Schlüssel zum Autorisieren der Anfrage
id number Internal system identifier of the agent
permanent_url object Permanent link to connect
permanent_url.enable boolean Enable/disable
permanent_url.url string Link path
permanent_url.password string Password for connection (at least 8 characters including letters and numbers)

Antwort:

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

Antwortdaten:

Bezeichnung Typ Beschreibung
number status Result status. Possible values:
  • 0 - Data successfully saved
  • 1 - Invalid request
  • 7 - The path for the permanent link is taken
  • 8 - Changing properties is prohibited
  • 21 - Invalid password for permanent link
data object Modified data

Link zum Verbinden erhalten

Um eine Verbindung zu einem Computer über die API herzustellen, müssen Sie einen einmaligen Link mithilfe der Methode agents/connect generieren

ℹ Der erhaltene Link ist verfällt sofort nach der ersten Anwendung. Sie müssen für jeden Anschluss einen neuen Link generieren.

Anfrage:

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

Parameter der Anfrage:

Parameter Typ Wert
apikey string API-Schlüssel zum Autorisieren der Anfrage
agent_id number Systeminterne Kennung des Agenten
device_id number The public identifier of the agent. Available in the agent's card in the personal account.

ℹ Used if agent_id parameter is not specified.

Antwort:

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

Antwortdaten:

Bezeichnung Typ Beschreibung
url string URL zum Verbinden

Logout of the account

To detach the device from your account and remove it from permanent access, use the agents/logout method

⚠ Be careful! Once the device is detached, you will not be able to operate it.

Anfrage:

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

  BODY: {
    "id": <number>
  }

Parameter der Anfrage:

Parameter Typ Wert
apikey string API-Schlüssel zum Autorisieren der Anfrage
id number Systeminterne Kennung des Agenten

Antwort:

{
    "status": 0
}

Antwortdaten:

Bezeichnung Typ Beschreibung
number status Result status. Possible values:
  • 0 - The logout of the device is successful
  • 1 - Incorrect request
  • 6 - Device not found
  • 8 - Operation prohibited

Schneller Support

Liste der offenen Verbindungen

Um eine Liste der offenen Verbindungen aus dem Abschnitt Schneller Support zu erhalten, verwenden Sie die Methode support/list

Anfrage:

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

Parameter der Anfrage:

Parameter Typ Wert
apikey string API-Schlüssel zum Autorisieren der Anfrage

Antwort:

{
    "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":""
    } ]
}
Verbindungsdatensatz:

Bezeichnung Typ Beschreibung
id number Systeminterne Kennung der Verbindung
status number Verbindungsstatus. Mögliche Bedeutung:
  • 0 - Neue Verbindung, warte auf Anschluss des Kunden
  • 1 - Kunde ist verbunden, warte auf Anschluss des Nutzers
  • 2 - Aktive Verbindung, alle Teilnehmer sind beigetreten
  • 3 - Geschlossene Verbindung
create_time unixtime Datum und Uhrzeit des Verbindungsaufbaus
invite_code string Einladungscode
invite_url string URL zum Einladen
connect_url string URL zum Beitreteten des Nutzers zur Verbindung
client_name string Kundenname
client_os string Betriebssystem. Mögliche Werte: win, mac, linux und android

ℹ Das Feld wird nach dem Anschluss des Kunden gefüllt
client_preview_url string Miniaturansicht des Kunden-Desktops

ℹ Das Feld wird nach dem Anschluss des Kunden gefüllt

Zusätzliche Information:

Bezeichnung Typ Beschreibung
remain number Anzahl der verbleibenden Verbindungen innerhalb Ihres Abos

Verbindung herstellen

Um eine zeitverzögerte Verbindung für den Remote Support zu erstellen verwenden Sie die Methode support/create

Anfrage:

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

Parameter der Anfrage:

Parameter Typ Wert
apikey string API-Schlüssel zum Autorisieren der Anfrage
client_name string Kundenname (dieser ist nur für Sie sichtbar). Optionaler Parameter.

Antwort:

{
    "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":""
    }
}

Antwortdaten:

Bezeichnung Typ Beschreibung
id number Systeminterne Kennung der Verbindung
status number Verbindungsstatus. Mögliche Bedeutung:
  • 0 - Neue Verbindung, warte auf Anschluss des Kunden
  • 1 - Kunde ist verbunden, warte auf Anschluss des Nutzers
  • 2 - Aktive Verbindung, alle Teilnehmer sind beigetreten
  • 3 - Geschlossene Verbindung
create_time unixtime Datum und Uhrzeit des Verbindungsaufbaus
invite_code string Einladungscode
invite_url string URL zum Einladen
connect_url string URL zum Beitreteten des Nutzers zur Verbindung
client_name string Kundenname
client_os string Betriebssystem. Mögliche Werte: win, mac, linux und android

ℹ Das Feld wird nach dem Anschluss des Kunden gefüllt
client_preview_url string Miniaturansicht des Kunden-Desktops

ℹ Das Feld wird nach dem Anschluss des Kunden gefüllt

Information zur Verbindung

Um Information zu einer konkreten Verbindung zu erhalten, verwenden Sie die Methode support/info

Anfrage:

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

Parameter der Anfrage:

Parameter Typ Wert
apikey string API-Schlüssel zum Autorisieren der Anfrage
connection_id number* Systeminterne Kennung der Verbindung

Antwort:

{
    "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"
    }
}

Antwortdaten:

Bezeichnung Typ Beschreibung
id number Systeminterne Kennung der Verbindung
status number Verbindungsstatus. Mögliche Bedeutung:
  • 0 - Neue Verbindung, warte auf Anschluss des Kunden
  • 1 - Kunde ist verbunden, warte auf Anschluss des Nutzers
  • 2 - Aktive Verbindung, alle Teilnehmer sind beigetreten
  • 3 - Geschlossene Verbindung
create_time unixtime Datum und Uhrzeit des Verbindungsaufbaus
invite_code string Einladungscode
invite_url string URL zum Einladen
connect_url string URL zum Beitreteten des Nutzers zur Verbindung
client_name string Kundenname
client_os string Betriebssystem. Mögliche Werte: win, mac, linux und android

ℹ Das Feld wird nach dem Anschluss des Kunden gefüllt
client_preview_url string Miniaturansicht des Kunden-Desktops

ℹ Das Feld wird nach dem Anschluss des Kunden gefüllt

Verbindung schließen

Um die Verbindung zu schließen, verwenden Sie die Methode support/close

Anfrage:

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

Parameter der Anfrage:

Parameter Typ Wert
apikey string API-Schlüssel zum Autorisieren der Anfrage
connection_id number* Systeminterne Kennung der Verbindung

Antwort:

Die Antwort wird mit leerem Inhalt ankommen. Verwenden Sie zum Analysieren der Befehlsausführung nur den HTTP-Antwortcode.

Verbindungsverlauf

Verbindungsliste erhalten

Um eine Liste aller Ihrer Verbindungen zu erhalten, verwenden Sie die Methode history/list

Anfrage:

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>

Parameter der Anfrage:

Parameter Typ Wert
apikey string API-Schlüssel zum Autorisieren der Anfrage
agent_id string Nach Agenten-ID filtern
support_id number Filtern nach Verbindungs-ID von Schneller Support
date_from unixtime Nach Datum und Uhrzeit filtern - Beginn der Periode
date_to unixtime Nach Datum und Uhrzeit filtern - Ende der Periode
video boolean Nach vorhandener Videoaufzeichnung filtern
offset number Die erste Position in der Liste einrücken
limit number Anzahl der Elemente in der Liste. Standardmäßig - 20, Maximalwert - 100

Antwort:

{
    "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
        }
    }, ... ]
}

Antwortdaten:

Bezeichnung Typ Beschreibung
id number Systeminterne Kennung der Verbindung
start unixtime Datum und Uhrzeit des Verbindungsbeginns
stop unixtime Datum und Uhrzeit des Verbindungsendes

ℹ Darf leer sein, wenn die Verbindung noch nicht beendet ist
support_id number Verbindungs-ID aus Schneller Support

ℹ Das Feld kann leer sein, wenn Sie mit einem Gerät des Dauerhaften Zugriffs verbunden waren
clients array Liste der Kunden, die der Sitzung beigetreten sind
clients[].user_agent string User Agent
clients[].login string Benutzeranmeldung

ℹ Darf leer sein, wenn die Verbindung anonym war
clients[].geo object Standort
clients[].geo.ip string IP-Adresse
clients[].geo.country string Land
clients[].geo.region string Region
clients[].geo.city string Stadt
agent object Information zum Agenten
agent.id number Systeminterne Kennung des Agenten
agent.name string Bezeichnung
agent.group string Gruppe
agent.geo object Standort
agent.geo.ip string IP-Adresse
agent.geo.country string Land
agent.geo.region string Region
agent.geo.city string Stadt
agent.os string Betriebssystem. Mögliche Werte: win, mac, android und linux
agent.version string Programmversion
agent.owner string Login des Kontos des Benutzers des dauerhaften Zugriffs
video object Information zur Videoaufzeichnung

ℹ Kann fehlen, wenn es keine Videoaufzeichnung der Sitzung gab
video.url string Adresse zum Hochladen der Videoaufzeichnung

⚠ Um eine Videodatei der Sitzung hochzuladen müssen Sie den Parameter ?apikey= mit dem Wert Ihres API-Schlüssels angeben.
video.size number Größe der Videoaufzeichnung in Byte

Last update: 24. Juli 2024