Obtenez PBX PBX Instance

Obtenez PBX PBX Instance #

Ce point de terminaison permet de vérifier si la cible PBX est déjà associé à un locataire client quelque part dans le système.

GET /v1.0/pbxs ?instanceId={PBX_INSTANCE_ID}

Selon le type de Pbx, les valeurs suivantes doivent être passées en tant que {PBX_Instance_ID} :

  • ~.pbx.kazoo.name.~ => ~.pbx.kazoo.name.~ ID de compte
  • Teams => Microsoft ID du locataire
  • 3CX => 3CX Clé de licence

Exemple #

Cette demande permet d'obtenir les PbxConnectionProfiles spécifiques au sein du locataire Client.

Demander # 

GET <https://api.na.myreports.cloud/api/v1.0/pbxs?instanceId={PBX_INSTANCE_ID}> HTTP/1.1
Autorisation : Porteur {TOKEN}

Réponse (existe) # 

HTTP/1.1 200 OK
Type de contenu : application/json ; jeu de caractères=utf-8
Contenu-Longueur : xx
{
	« données » : {
        « exists » : vrai,
        « instanceId » : « {PBX_INSTANCE_ID} »,
        « id » : « {PBX_ID} »,
        « tenantId » : « {CUSTOMER_TENANT_ID} »
    },
    « status » : « succès »,
    « timestamp » : « 2025-02-20T14:57:51.2818600Z »
}

Réponse (n'existe pas) # 

HTTP/1.1 200 OK
Type de contenu : application/json ; jeu de caractères=utf-8
Contenu-Longueur : xx
{
	« données » : {
        « exists » : false,
        « instanceId » : « {PBX_INSTANCE_ID} »
    },
    « status » : « succès »,
    « timestamp » : « 2025-02-20T14:57:51.2818600Z »
}

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 pas de clients disposant d'un ID de locataire correspondant ou d'utilisateurs avec l'ID d'utilisateur 

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 »
}