Obtenir PBX PBX Exemple

Obtenir PBX PBX Exemple #

Ce paramètre est utilisé pour 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 transmises comme {PBX_Instance_ID} :

  • ~.pbx.kazoo.name.~ => ~.pbx.kazoo.name.~ Identifiant du compte
  • Teams => Microsoft Numéro d'identification du locataire
  • 3CX => 3CX Clé de licence

Exemple #

Cette demande obtiendra les PbxConnectionProfiles spécifiques dans le client client.

Demande # 

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; charset=utf-8
Longueur du contenu : xx
{
	« données » : {
        « existe » : 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; charset=utf-8
Longueur du contenu : xx
{
	« données » : {
        « existe » : faux,
        « instanceId » : « {PBX_INSTANCE_ID} »
    },
    « status » : « succès »,
    « timestamp » : « 2025-02-20T14:57:51.2818600Z »
}

Erreurs #

Non autorisé #

Lorsque le jeton n'est pas fourni, invalide ou expiré 

HTTP/1.1 401 Non autorisé

Mauvaise demande #

Lorsque l'identifiant du locataire fourni n'est pas dans le bon format 

HTTP/1.1 400 Mauvaise demande
Date : Thu, 06 Feb 2020 12:45:27 GMT
Type de contenu : application/json; charset=utf-8
Longueur du contenu : 149
{
	« erreur » :400,
	« message » :"La valeur '<tenant id>' n'est pas valide.
	« status » :"erreur »,
	« timestamp » :"2020-02-06T12:45:27.5903465Z »
}

Non trouvé #

Lorsqu'il n'y a pas de clients ayant un identifiant de locataire correspondant ou d'utilisateurs avec l'identifiant d'utilisateur 

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