Mettre à jour l'appareil de l'utilisateur

Mettre à jour l'appareil de l'utilisateur #

Ce point de terminaison permet d'attribuer (ou de supprimer) des périphériques existants en tant que périphériques softphone pour un utilisateur de ~.UcClient.~ Ordinateurs de bureau, mobiles et WebRTC.

Attribuer un appareil

PUT /v1.0/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID}/devices/pbx/{DEVICE_ID}/assign

Annuler l'attribution d'un appareil

PUT /v1.0/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID}/devices/pbx/{DEVICE_ID}/unassign

Le Corps de la demande doit contenir un seul JSON pour indiquer le type de client auquel le périphérique est attribué :

{
	« clientType » : « bureau »
}

Valeurs clientType valides :

  • bureau
  • mobile
  • WebRTC
  • Le CRM

Le {DEVICE_ID} fourni doit être l'identifiant de l'appareil sur la plate-forme de communication, par exemple ~.pbx.kazoo.name.~.

Document note
L'appareil attribué en tant que softphone doit déjà être attribué à l'utilisateur sur la plate-forme de communication.
Color Wand tip
Si l'ID de périphérique fourni est déjà attribué à un autre type de client, le fait de l'attribuer à nouveau aurait pour effet de le déplacer d'un client à un autre.

Remarques #

Lorsque vous attribuez un softphone à un utilisateur, assurez-vous que celui-ci a d'abord reçu les bons rôles. Les deux conditions suivantes sont des conditions préalables à l'attribution d'un appareil softphone :

  • customer_user_uc
  • customer_user_uc_softphone

Exemple d'affectation #

Demander # 

POST <https://api.na.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID}/devices/pbx/{DEVICE_ID}/assign> HTTP/1.1
Type de contenu : application/json
accept-charges : true
Autorisation : Porteur {TOKEN}
Connexion : keep-alive
{
	« clientType » : « bureau »
}

Réponse # 

HTTP/1.1 201 Créé
Type de contenu : application/json ; jeu de caractères=utf-8
Contenu-Longueur : xx
Lieu : <https://api.na.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID}/devices/pbx/{DEVICE_ID}/assign>
{
	« status » : « succès »,
	« timestamp » : « 2019-11-29T16:03:23.9251680Z »
}

Exemple d'annulation d'affectation #

Demander # 

POST <https://api.na.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID}/devices/pbx/{DEVICE_ID}/unassign> HTTP/1.1
Type de contenu : application/json
accept-charges : true
Autorisation : Porteur {TOKEN}
Connexion : keep-alive

Réponse # 

HTTP/1.1 201 Créé
Type de contenu : application/json ; jeu de caractères=utf-8
Contenu-Longueur : xx
Lieu : <https://api.na.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID}/devices/pbx/{DEVICE_ID}/unassign>
{
	« status » : « succès »,
	« timestamp » : « 2019-11-29T16:03:23.9251680Z »
}

Erreurs #

Non autorisée #

Lorsque le jeton n'est pas fourni, qu'il n'est pas valide ou qu'il a expiré 

HTTP/1.1 401 Non autorisé

Mauvaise demande #

Lorsque l'ID de locataire fourni n'est pas au format correct 

HTTP/1.1 400 Requête incorrecte
Date : Thu, 06 Feb 2020 12:45:27 GMT
Type de contenu : application/json ; jeu de caractères=utf-8
Contenu-Longueur : 149
{
	« error » : 400,
	« message » : « La valeur '<tenant id>' n'est pas valide.",
	« status » : « erreur »,
	« timestamp » : « 2020-02-06T12:45:27.5903465Z »
}

Introuvable #

Lorsqu'il n'y a aucun client disposant d'un ID de locataire correspondant 

HTTP/1.1 404 Introuvable
Date : Thu, 06 Feb 2020 12:46:58 GMT
Type de contenu : application/json ; jeu de caractères=utf-8
Contenu-Longueur : 95
{
	« error » : 404,
	« message » : « Introuvable »,
	« status » : « erreur »,
	« timestamp » : « 2020-02-06T12:46:58.7669535Z »
}

Lorsque l'appareil référencé n'est pas déjà attribué à l'utilisateur sur la plateforme de communication. 

HTTP/1.1 404 Introuvable
Date : Thu, 06 Feb 2020 12:46:58 GMT
Type de contenu : application/json ; jeu de caractères=utf-8
Contenu-Longueur : 95
{
	« error » : 404,
	« message » : « Appareil introuvable »,
	« status » : « erreur »,
	« timestamp » : « 2020-02-06T12:46:58.7669535Z »
}

Paiement requis #

Si cette demande peut entraîner des frais supplémentaires, reportez-vous à la section Frais. 

HTTP/1.1 402 Paiement requis
Date : Thu, 06 Feb 2020 13:01:00 GMT
Type de contenu : application/json ; jeu de caractères=utf-8
Contenu-Longueur : 274
{
	« données » : {
	« clientType » : « bureau »
	},
	« error » : 402,
	« message » : « Des frais supplémentaires s'appliquent »,
	« status » : « erreur »,
	« timestamp » : « 2020-02-06T13:01:01.1302340Z »
}