Codes d’appairage

Le code à usage unique qui relie un poste à votre organisation.

Le cycle de vie et les pièges : Postes.

Routes

Route	Effet
`POST /v1/workstation-pairing-codes`	Créer un code d’appairage
`GET /v1/workstation-pairing-codes/{code}`	Lire un code d’appairage
`POST /v1/workstation-pairing-codes/{code}/confirm-transfer`	Confirmer le rattachement d’un poste déjà appairé
`POST /v1/workstation-pairing-codes/{code}/cancel`	Annuler un code d’appairage

L’objet

idtexte
L'identifiant de l'objet, préfixé par son type.
objecttexte
Le nom du type d'objet.
codetexte
À saisir dans l'agent. Rendu seulement à la création.
statusénumération
L'état du code.
pendingpairedexpiredcancelled
stageénumérationou null
Où en est le poste, tant que status vaut pending.
waitingconnectingstalledagent_outdatedalready_paired
previewed_atentierou null
La saisie du code sur le poste.
agentobjetou null
Ce que l'agent a dit de lui en présentant le code. Vide avant.
Champs de agent
- nametexteobligatoireou null
  Le nom affiché.
- platformtexteobligatoireou null
- os_versiontexteobligatoireou null
- versiontexteobligatoireou null
- statusénumérationobligatoireou null
  up_to_dateupdate_availableoutdated
- minimum_versiontexteobligatoire
- latest_versiontexteobligatoire
current_organizationtexteou null
L'organisation que le poste quitterait, tant que stage vaut already_paired.
expires_atentierou null
L'échéance du code, en secondes Unix.
workstationtexteou null
Le poste appairé par ce code : son identifiant, ou l'objet par expand[]=workstation.
createdentierou null
La création de l'objet, en secondes Unix.
livemodebooléen
true en production, false en mode test.

L'objet


{
  "id": "wpc_034t7hCZcEgoE0r0ABaKuL",
  "object": "workstation_pairing_code",
  "code": "RB7K-4Q2M",
  "status": "pending",
  "stage": "waiting",
  "previewed_at": null,
  "agent": null,
  "current_organization": null,
  "expires_at": 1794005296,
  "workstation": null,
  "created": 1794004696,
  "livemode": false
}