Aller au contenu

description: 'L'API HTTP vous permet d'accéder à la plupart des fonctions disponibles dans votre espace client : gestion des ordinateurs, création de connexions en attente.' hide: - navigation

HTTP API

L'API HTTP vous permet d'accéder à la plupart des fonctions disponibles dans votre espace client : gestion des ordinateurs, création de connexions en attente.

Demandes

Toutes les demandes doivent être effectuées via HTTPS (et non HTTP) avec la méthode appropriée pour chaque commande à https://api.getscreen.me/v1/

RĂ©ponses

Les réponses avec les données sont renvoyées au format JSON et encodées en UTF-8 depuis ContentType: application/json. Dans chaque réponse, les données sont encapsulées dans un conteneur JSON data

Le serveur API peut renvoyer les codes de réponse HTTP suivants :

Code de réponse HTTP Description
200 OK Demande acceptée et traitée
400 Bad Request Demande refusée, paramètres non valides, erreur
402 Payment Required Demande rejetée, limite de demande pour le plan tarfaire dépassée
403 Forbidden Demande refusée, pas d'accès aux données
404 Not Found Demande refusée, URL de demande inconnue

Authentification

L'API est une API RESTful — le serveur ne stocke pas l'état de la connexion client. Par conséquent, chaque fois qu'une demande est envoyée, le client doit envoyer ses données d'autorisation. Une clé API est utilisée comme ces données. Ajoutez la clé dans chaque demande dans le paramètre ?apikey= ou dans l'en-tête HTTP X-Api-Key

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

ℹ Votre clé API se trouve dans votre armoire personnelle dans la section « Intégrations » de l'onglet API HTTP

MĂ©thodes

Ce sont des commandes de gestion des ordinateurs et des connexions. Nous les avons divisés en plusieurs groupes :

Accès permanent

Liste des ordinateurs

Vous pouvez obtenir une liste complète des ordinateurs en utilisant la méthode agents/list

ℹ Dans le contexte des appels d'API, les ordinateurs seront appelés «Agents», car techniquement un ordinateur est contrôlé via le programme d'agent

Demande :

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

Paramètres de la demande :

Paramètre Type Valeur
apikey string Clé API pour l'autorisation de demande
search string Recherche par nom d'agent, adresse IP ou nom de groupe
group_id string Filtre par identifiant de groupe

RĂ©ponse :

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

Données de réponse :

Nom Type Description
id number Identifiant intra-système
name string Nom
group string Groupe
disabled boolean
L'agent est-il bloqué ?

⚠ Vous ne pouvez pas vous connecter aux agents bloqués. L'agent est bloqué en cas de dépassement de la limite du nombre d'ordinateurs dans le plan tarifaire.
limited boolean
L'agent est-il limité ?

ℹ L'agent est limité si la limite du plan tarifaire pour le nombre de fichiers joints est dépassée. 10 jours après avoir été ajouté, l'agent limité est bloqué.
link_time unixtime Date et heure de l'ajout Ă  espace client
last_time unixtime Date et heure du dernier Ă©tat en ligne
geo object GĂ©olocalisation
geo.ip string Adresse IP
geo.country string Pays
geo.region string RĂ©gion
geo.city string Ville
permanent_url string
URL de connexion permanente

ℹ Le champ peut être absent si l'accès pour les utilisateurs non autorisés est fermé
onetime_url string
URL pour une connexion unique

âš  Le lien change toutes les 45 secondes

ℹ Le champ peut être absent si les connexions via des liens uniques sont désactivées dans les paramètres de l'agent
preview_url string URL pour télécharger l'aperçu de l'écran d'accueil
os string Système d'exploitation. Valeurs possibles : win, mac, linux et android
version string Version du programme d'agent
online boolean Statut actuel «En ligne»
installed boolean L'agent est-il installé sur l'ordinateur ?
favorite boolean S'agit-il d'un ordinateur sélectionné dans la liste de votreespace client ?
owner string Compte de propriétaire d'accès à l'ordinateur dans le système
sessions object Informations sur les connexions
sessions.last object Dernière connexion
sessions.last.id number Identifiant de connexion intra-système
sessions.last.start_time unixtime Date et heure de début de connexion
sessions.last.stop_time unixtime Date et heure de fin de connexion

â„ą Le champ peut ĂŞtre absent si la connexion est active
sessions.last.client object Informations sur le client (auteur de la connexion)
sessions.last.client.ip string Adresse IP
sessions.last.client.country string Pays
sessions.last.client.region string RĂ©gion
sessions.last.client.city string Ville
sessions.last.client.user_agent string Agent utilisateur du navigateur du client
sessions.total object Nombre total de connexions

Informations sur l'ordinateur

Pour obtenir des informations sur un ordinateur à partir de la section Accès permanent, vous devez utiliser la méthode agents/info

Demande :

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

Paramètres de la demande :

Paramètre Type Valeur
apikey string Clé API pour l'autorisation de demande
agent_id number Identifiant d'agent intra-système

RĂ©ponse :

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

Données de réponse :

Nom Type Description
id number Identifiant intra-système
name string Nom
group string Groupe
disabled boolean
L'agent est-il bloqué ?

⚠ Vous ne pouvez pas vous connecter aux agents bloqués. L'agent est bloqué en cas de dépassement de la limite du nombre d'ordinateurs dans le plan tarifaire.
limited boolean
L'agent est-il limité ?

ℹ L'agent est limité si la limite du plan tarifaire pour le nombre de fichiers joints est dépassée. 10 jours après avoir été ajouté, l'agent limité est bloqué.
link_time unixtime Date et heure de l'ajout Ă  espace client
last_time unixtime Date et heure du dernier Ă©tat en ligne
geo object GĂ©olocalisation
geo.ip string Adresse IP
geo.country string Pays
geo.region string RĂ©gion
geo.city string Ville
permanent_url string
URL de connexion permanente

ℹ Le champ peut être absent si l'accès pour les utilisateurs non autorisés est fermé
onetime_url string
URL pour une connexion unique

âš  Le lien change toutes les 45 secondes

ℹ Le champ peut être absent si les connexions via des liens uniques sont désactivées dans les paramètres de l'agent
preview_url string URL pour télécharger l'aperçu de l'écran d'accueil
os string Système d'exploitation. Valeurs possibles : win, mac, linux et android
version string Version du programme d'agent
online boolean Statut actuel «En ligne»
installed boolean L'agent est-il installé sur l'ordinateur ?
favorite boolean S'agit-il d'un ordinateur sélectionné dans la liste de votreespace client ?
owner string Compte de propriétaire d'accès à l'ordinateur dans le système
hardware object Informations système
hardware.BIOS string Informations sur le BIOS
hardware.BIOSDate string Date de mise Ă  jour
hardware.BIOSVersion string Version
hardware.CPU string Processeur
hardware.CPUCores number Nombres de cœurs
hardware.CPUCoresLogical number Nombre de processeurs logiques
hardware.CPUFamily string Famille
hardware.CPUSpeed number Vitesse
hardware.ComputerDomain string Domaine
hardware.ComputerIP array Adresse IP
hardware.ComputerModel string Modèle
hardware.ComputerName string Nom de l'ordinateur
hardware.ComputerWorkgroup string Groupe de travail
hardware.HDD array Disques durs
hardware.HDD[].Model string Modèle
hardware.HDD[].Size number Taille
hardware.Locale string Paramètres régionaux
hardware.LocaleCountry string Pays
hardware.LocaleCurrency string Devise
hardware.LocaleFormatDate string Format de date
hardware.LocaleFormatTime string Format d'heure
hardware.LocaleOemPage string Encodage des pages
hardware.LocaleTimezone number Fuseau horaire
hardware.LogicalDisks array Lecteurs logiques
hardware.LogicalDisks[].Disk string Étiquette
hardware.LogicalDisks[].FileSystem string Type de système de fichiers
hardware.LogicalDisks[].FreeSpace number Espace libre (Mo)
hardware.LogicalDisks[].Name string Nom
hardware.LogicalDisks[].Size number Taille (Mo)
hardware.Monitors array Moniteurs
hardware.Monitors[].Name string Nom
hardware.Monitors[].ScreenHeight number Hauteur de l'Ă©cran
hardware.Monitors[].ScreenWidth number Largeur de l'Ă©cran
hardware.NetAdapters array Cartes réseau
hardware.NetAdapters[].Addresses string Adresse
hardware.NetAdapters[].Cable boolean Connexion Internet par câble LAN
hardware.NetAdapters[].DCHP string DCHP
hardware.NetAdapters[].DNS string DNS
hardware.NetAdapters[].MACAddress string Adresse MAC
hardware.NetAdapters[].Manufacturer string Fabricant
hardware.NetAdapters[].Name string Nom
hardware.NetAdapters[].Speed number Vitesse
hardware.NetAdapters[].WoL boolean Paramètre Wake-on-LAN activé
hardware.OSName string Nom du système d'exploitation
hardware.OSVersion string Version du système d'exploitation
hardware.RAMBanks array MĂ©moire RAM
hardware.RAMBanks[].Bank string Slot
hardware.RAMBanks[].Capacity number Capacité
hardware.RAMBanks[].Locator string Localisateur
hardware.RAMBanks[].Manufacturer string Fabricant
hardware.RAMBanks[].PartNumber string Lot
hardware.RAMBanks[].SerialNumber string SĂ©rie
hardware.SoundDevices array Cartes son
hardware.SoundDevices[].Name string Nom
hardware.VideoCards array Carte vidéo
hardware.VideoCards[].Integrated boolean Intégrée
hardware.VideoCards[].Name string Nom
hardware.VideoCards[].RAM number MĂ©moire
sessions object Informations sur les connexions
sessions.last object Dernière connexion
sessions.last.id number Identifiant de connexion intra-système
sessions.last.start_time unixtime Date et heure de début de connexion
sessions.last.stop_time unixtime Date et heure de fin de connexion

â„ą Le champ peut ĂŞtre absent si la connexion est active
sessions.last.client object Informations sur le client (auteur de la connexion)
sessions.last.client.ip string Adresse IP
sessions.last.client.country string Pays
sessions.last.client.region string RĂ©gion
sessions.last.client.city string Ville
sessions.last.client.user_agent string Agent utilisateur du navigateur du client
sessions.total object Nombre total de connexions

Modifier la propriété de l'appareil

Pour modifier une propriété d'un appareil lié à votre compte, vous pouvez utiliser la méthode devices/update

ℹ Il n'est pas nécessaire d'énumérer toutes les propriétés dans la demande. Seules celles que vous indiquez seront modifiées. Pour une liste des champs disponibles pour la mise à jour, voir les paramètres ci-dessous.

Demande :

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

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

Paramètres de la demande :

Paramètre Type Valeur
apikey string Clé API pour l'autorisation de demande
id number Identifiant d'agent intra-système
permanent_url object Lien permanent pour se connecter
permanent_url.enable boolean Activer/désactiver
permanent_url.url string Chemin du lien
permanent_url.password string Mot de passe pour la connexion (au moins 8 caractères, lettres et chiffres)

RĂ©ponse :

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

Données de réponse :

Nom Type Description
number status État du résultat. Valeurs possibles :
  • 0 - Sauvegarde rĂ©ussie des donnĂ©es
  • 1 - Demande incorrecte
  • 7 - Le chemin pour le lien permanent est pris
  • 8 - La modification des propriĂ©tĂ©s est interdite
  • 21 - Mot de passe invalide pour le lien permanent
data object Données modifiées

Obtenir un lien pour se connecter

Pour vous connecter à un ordinateur via l'API, vous devez obtenir un lien unique en utilisant la méthode agents/connect

ℹ Le lien obtenu expire immédiatement après la première utilisation. Vous devez l'obtenir à chaque fois que vous souhaitez vous connecter.

Demande :

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

Paramètres de la demande :

Paramètre Type Valeur
apikey string Clé API pour l'autorisation de demande
agent_id number Identifiant d'agent intra-système
device_id number L'identifiant public de l'agent. Disponible dans la carte de l'agent dans le compte personnel.

ℹ Utilisé si le paramètre agent_id n'est pas spécifié.
video bool Manual control of video recording on/off (optional)

RĂ©ponse :

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

Données de réponse :

Nom Type Description
url string URL de connexion

Request a wake-up call

To send a request to wake up a device using the Wake-on-LAN feature, you can use the agents/wake request.

â„ą This feature requires preconfiguration of the device and its environment to work. Read more in the article How to configure Wake-on-LAN?.

Demande :

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

  BODY: {
    "id": <number>
    }
  }

Paramètres de la demande :

Paramètre Type Valeur
apikey string Clé API pour l'autorisation de demande
id number Identifiant d'agent intra-système

RĂ©ponse :

{
    "status": 0,
}

Données de réponse :

Nom Type Description
number status Result status. Possible values:
  • 0 - Request accepted
  • 1 - Invalid request

DĂ©connexion du compte

Pour détacher l'appareil de votre compte et en supprimer l'accès permanent, utilisez la méthode agents/logout

⚠ Attention ! Une fois l'appareil détaché, vous ne pourrez plus le faire fonctionner.

Demande :

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

  BODY: {
    "id": <number>
  }

Paramètres de la demande :

Paramètre Type Valeur
apikey string Clé API pour l'autorisation de demande
id number Identifiant d'agent intra-système

RĂ©ponse :

{
    "status": 0
}

Données de réponse :

Nom Type Description
number status État du résultat. Valeurs possibles :
  • 0 - La dĂ©connexion de l'appareil est rĂ©ussie
  • 1 - Demande incorrecte
  • 6 - Dispositif non trouvĂ©
  • 8 - L'opĂ©ration est interdite

Assistance rapide

Liste des connexions ouvertes

Pour obtenir une liste des connexions ouvertes à partir de la section Assistance rapide, utilisez la méthode support/list

Demande :

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

Paramètres de la demande :

Paramètre Type Valeur
apikey string Clé API pour l'autorisation de demande

RĂ©ponse :

{
    "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":""
    } ]
}
Données d'enregistrement de connexion :

Nom Type Description
id number Identifiant de connexion intra-système
status number État de la connexion. Valeurs possibles :
  • 0 - Nouvelle connexion, connexion du client en attente
  • 1 - Client connectĂ©, connexion de l'opĂ©rateur en attente
  • 2 - Connexion active, tous les participants sont connectĂ©s
  • 3 - Connexion fermĂ©e
create_time unixtime Date et heure de création de la connexion
invite_code string Code d'invitation
invite_url string URL d'invitation
connect_url string URL pour connecter l'opérateur à la connexion
client_name string Nom du client
client_os string Système d'exploitation. Valeurs possibles : win, mac, linux et android

ℹ Le champ est rempli après la connexion du client
client_preview_url string Vignette de l'Ă©cran d'accueil du client

ℹ Le champ est rempli après la connexion du client

Informations complémentaires :

Nom Type Description
remain number Nombre de connexions restantes dans le plan tarifaire

Créer une connexion

Pour créer une connexion en attente pour l'assistance rapide, utilisez la méthode support/create

Demande :

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

Paramètres de la demande :

Paramètre Type Valeur
apikey string Clé API pour l'autorisation de demande
client_name string Nom du client (visible uniquement par vous). Paramètre facultatif.

RĂ©ponse :

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

Données de réponse :

Nom Type Description
id number Identifiant de connexion intra-système
status number État de la connexion. Valeurs possibles :
  • 0 - Nouvelle connexion, connexion du client en attente
  • 1 - Client connectĂ©, connexion de l'opĂ©rateur en attente
  • 2 - Connexion active, tous les participants sont connectĂ©s
  • 3 - Connexion fermĂ©e
create_time unixtime Date et heure de création de la connexion
invite_code string Code d'invitation
invite_url string URL d'invitation
connect_url string URL pour connecter l'opérateur à la connexion
client_name string Nom du client
client_os string Système d'exploitation. Valeurs possibles : win, mac, linux et android

ℹ Le champ est rempli après la connexion du client
client_preview_url string Vignette de l'Ă©cran d'accueil du client

ℹ Le champ est rempli après la connexion du client

Informations sur la connexion

Pour obtenir des informations sur une connexion spécifique, utilisez la méthode support/info

Demande :

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

Paramètres de la demande :

Paramètre Type Valeur
apikey string Clé API pour l'autorisation de demande
connection_id number* Identifiant de connexion intra-système

RĂ©ponse :

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

Données de réponse :

Nom Type Description
id number Identifiant de connexion intra-système
status number État de la connexion. Valeurs possibles :
  • 0 - Nouvelle connexion, connexion du client en attente
  • 1 - Client connectĂ©, connexion de l'opĂ©rateur en attente
  • 2 - Connexion active, tous les participants sont connectĂ©s
  • 3 - Connexion fermĂ©e
create_time unixtime Date et heure de création de la connexion
invite_code string Code d'invitation
invite_url string URL d'invitation
connect_url string URL pour connecter l'opérateur à la connexion
client_name string Nom du client
client_os string Système d'exploitation. Valeurs possibles : win, mac, linux et android

ℹ Le champ est rempli après la connexion du client
client_preview_url string Vignette de l'Ă©cran d'accueil du client

ℹ Le champ est rempli après la connexion du client

Fermer la connexion

Pour fermer la connexion, utilisez la méthode support/close

Demande :

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

Paramètres de la demande :

Paramètre Type Valeur
apikey string Clé API pour l'autorisation de demande
connection_id number* Identifiant de connexion intra-système

RĂ©ponse :

La réponse viendra avec un contenu vide. Utilisez uniquement le code de réponse HTTP pour analyser l'exécution de la commande.

Historique des connexions

Obtenir une liste de connexions

Pour obtenir une liste de vos connexions, utilisez la méthode history/list

Demande :

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>

Paramètres de la demande :

Paramètre Type Valeur
apikey string Clé API pour l'autorisation de demande
agent_id string Filtrer par ID d'agent
support_id number Filtrer par ID de connexion depuis l'Assistance rapide
date_from unixtime Filtrer par date et heure — début de période
date_to unixtime Filtrer par date et heure — fin de période
video boolean Filtrer par la présence d'un enregistrement vidéo
offset number Mettre en retrait la première position de la liste
limit number Le nombre d'éléments dans la liste. Par défaut — 20, valeur maximale — 100

RĂ©ponse :

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

Données de réponse :

Nom Type Description
id number Identifiant de connexion interne
start unixtime Date et heure de début de la connexion
stop unixtime Date et heure de fin de la connexion

ℹ Peut être vide si la connexion n'est pas terminée
support_id number ID de connexion depuis l'Assistance rapide

ℹ Le champ peut être vide si la connexion s'est faite avec un appareil de l'Accès permanent
clients array Liste des clients qui ont rejoint la connexion
clients[].user_agent string Agent utilisateur
clients[].login string Enregistrement de l'utilisateur

â„ą Peut ĂŞtre vide si la connexion Ă©tait anonyme
clients[].geo object GĂ©olocalisation
clients[].geo.ip string Adresse IP
clients[].geo.country string Pays
clients[].geo.region string RĂ©gion
clients[].geo.city string Ville
agent object Informations sur l'agent
agent.id number Identifiant d'agent intra-système
agent.name string Nom
agent.group string Groupe
agent.geo object GĂ©olocalisation
agent.geo.ip string Adresse IP
agent.geo.country string Pays
agent.geo.region string RĂ©gion
agent.geo.city string Ville
agent.os string Système d'exploitation. Valeurs possibles : win, mac, linux et android
agent.version string Version du programme
agent.owner string Login du compte propriétaire d'un accès permanent
video object Informations sur l'enregistrement vidéo

ℹ Peuvent être absentes s'il n'y avait pas d'enregistrement vidéo
video.url string Adresse de chargement du fichier d'enregistrement vidéo

⚠ Pour charger le fichier vidéo de l'enregistrement de connexion, il faut ajouter un paramètre ?apikey= avec la valeur de votre clé API.
video.size number Taille du fichier vidéo d'enregistrement en octets

Dernière mise à jour: 27 novembre 2024