Découvrez comment configurer les paramètres de l‘appareil via l‘API HTTP à l‘aide de Postman, y compris l‘enregistrement SIP, les clés DSS, les options réseau, le format de requête XML et la récupération des paramètres p
Ce guide explique comment configurer les paramètres de l'appareil via l'API HTTP, y compris les paramètres du serveur SIP, les détails d'enregistrement du compte SIP, les paramètres de la touche DSS et d'autres options de l'appareil. L'appareil agit comme un serveur HTTP, tandis que le client envoie des requêtes HTTP spécifiques pour appliquer les modifications de configuration, comme illustré dans le diagramme ci-dessous.
Dans cet exemple, Postman est utilisé pour simuler les requêtes HTTP envoyées à l'appareil.
Tous les modèles de téléphones actuellement disponibles dans notre gamme de produits.
① Un appareil d'interphone BHP-SOS11V, mis à jour vers la dernière version de firmware et connecté à un commutateur PoE.
② Un PC de configuration avec Postman installé, connecté au même commutateur, avec une communication réseau normale confirmée.
Téléchargez Postman depuis :
https://www.postman.com/downloads/
Ensuite, suivez les instructions d'installation pour terminer la configuration.
Cliquez sur File – New, puis sélectionnez HTTP Request.
Dans la fenêtre de nouvelle requête, sélectionnez la méthode POST et entrez l'URL HTTP de l'appareil au format suivant :
http://ip/xmlservice
Notez que l'URL est sensible à la casse. Remplacez ip par l'adresse IP réelle de l'appareil, comme indiqué ci-dessous.
Ensuite, configurez les paramètres de requête HTTP requis :
Méthode d'authentification : Basic Auth
En-tête : Content-Type: xml/text
Cliquez sur Body, sélectionnez raw, puis entrez le contenu XML dans le corps du message. Un exemple de format est présenté ci-dessous.
La structure est la suivante :
Il s'agit de l'en-tête de déclaration XML et est requis dans chaque requête.
Cela définit la structure de la commande XML. L'attribut cmd peut être get pour récupérer les paramètres actuels ou set pour écrire de nouveaux paramètres.
Cela spécifie l'élément de configuration réel. Dans cet exemple, la requête récupère les paramètres liés à la ligne SIP de l'appareil.
Dans l'utilisation réelle, la section suivante doit être ajustée en fonction du paramètre réel que vous souhaitez interroger ou configurer :
Différents modèles peuvent prendre en charge différents paramètres d'API HTTP. Vous pouvez utiliser l'une des méthodes suivantes pour obtenir la liste des paramètres pris en charge pour un appareil spécifique.
Méthode 1 : Dans l'interface WEB de l'appareil, allez dans System – System Configuration, puis exportez le fichier de configuration de type nc.
Vous pouvez cliquer avec le bouton droit pour enregistrer le fichier, ou cliquer avec le bouton gauche pour afficher directement la configuration. Les paramètres courants sont répertoriés dans la section suivante.
Méthode 2 : Certains modèles ne fournissent pas le lien du fichier de configuration nc directement dans l'interface web. Dans ce cas, vous pouvez saisir l'URL correspondante dans la barre d'adresse du navigateur pour récupérer manuellement le fichier de configuration nc.
Remarque : Cette méthode peut prendre plus de temps à répondre.
Cette section énumère plusieurs paramètres courants à titre de référence. D'autres paramètres peuvent être ajoutés dans les futures mises à jour.
Exemple de paramètres de ligne SIP (provenant du dispositif de contrôle d'accès i30) :
sip.line.1.PhoneNumber = 112
sip.line.1.DisplayName = 112
sip.line.1.SipName =
sip.line.1.RegAddr = 172.18.1.45
sip.line.1.RegPort = 2066
sip.line.1.RegUser = 112
sip.line.1.RegPswd = abc123
sip.line.1.RegTTL = 3600
sip.line.1.RegEnabled = 0
sip.line.1. indique que ces paramètres appartiennent à la ligne SIP 1.
PhoneNumber correspond au champ du numéro de téléphone dans l'interface web.
DisplayName correspond au nom affiché.
RegAddr est l'adresse du serveur proxy SIP.
RegPort est le port du serveur proxy SIP.
RegUser est le nom d'utilisateur d'authentification, généralement le même que le numéro de téléphone.
RegPswd est le mot de passe.
RegTTL est la durée d'expiration de l'enregistrement, avec une valeur par défaut de 3600 secondes.
RegEnabled définit si la ligne est activée : 0 signifie désactivée, 1 signifie activée.
Exemple de paramètres de touche DSS pour le i30 :
Il est recommandé de configurer d'abord la touche DSS dans l'interface web, puis d'utiliser l'API HTTP avec la commande get pour lire les valeurs de paramètres correspondantes et confirmer le mappage exact.
Type=1 indique que le type de touche DSS est Hotkey pour des appareils tels que le i30 ou i12. Pour d'autres modèles, vérifiez la valeur de type réelle en utilisant la méthode recommandée ci-dessus.
Value=125@1/f signifie :
125 = numéro de destination
@1 = ligne 1
/f = sous-type : numérotation abrégée
Exemple de paramètres réseau pour des appareils tels que le i30 et i12 :
WANMode indique le mode réseau, qui peut être DHCP ou static. Ce paramètre ne peut pas être écrit directement avec la commande set. Il change automatiquement en fonction de la valeur de dhcp.Enabled.
static.IP est l'adresse IP statique. Elle n'est effective que lorsque l'appareil est en mode statique. En mode DHCP, la commande get peut toujours être utilisée pour récupérer l'adresse IP actuelle.
static.SubnetMask est le masque de sous-réseau.
static.Gateway est la passerelle par défaut.
static.PrimaryDNS est le serveur DNS principal.
static.SecondaryDNS est le serveur DNS secondaire.
dhcp.Enabled définit si DHCP est activé : 1 signifie que le mode DHCP est actif, tandis que 0 signifie que le mode IP statique est utilisé.
Exemple de paramètres de volume pour le BHP-SOS11V :
phone.volume.HandFreeVol est le volume du haut-parleur. La plage est 1-9, où 9 est le volume le plus élevé.
phone.volume.HandFreeRingVol est le volume de la sonnerie pour les appels entrants. La plage est 1-9, où 9 est le volume le plus élevé.
phone.volume.HandFreeToneVol est le volume des tonalités d'alerte comme les alarmes et les sons de notification. La plage est 1-9, où 9 est le volume le plus élevé.
Les paramètres d'informations système sont en lecture seule, ce qui signifie qu'ils ne peuvent être interrogés qu'avec la commande get.
Exemple :
Ce paramètre renvoie toutes les informations système. Si vous n'avez besoin que d'un élément spécifique, étendez le chemin du paramètre au niveau de nœud suivant.
Par exemple, pour obtenir l'adresse MAC de l'appareil :
