Erfahren Sie, wie Sie Geräteeinstellungen über die HTTP-API mit Postman konfigurieren, einschließlich SIP-Registrierung, DSS-Schlüssel, Netzwerkoptionen, XML-Anfrageformat und unterstützter Parameterabfrage
Diese Anleitung erklärt, wie Sie Geräteparameter über die HTTP-API konfigurieren, einschließlich SIP-Servereinstellungen, SIP-Konto-Registrierungsdetails, DSS-Tastenparameter und andere Geräteoptionen. Das Gerät fungiert als HTTP-Server, während der Client spezifische HTTP-Anfragen sendet, um Konfigurationsänderungen anzuwenden, wie im folgenden Diagramm dargestellt.
In diesem Beispiel wird Postman verwendet, um an das Gerät gesendete HTTP-Anfragen zu simulieren.
Alle derzeit verfügbaren Telefonmodelle unserer Produktlinie.
① Ein BHP-SOS11V-Gegensprechgerät, das auf die neueste Firmware-Version aktualisiert und an einen PoE-Switch angeschlossen ist.
② Ein Konfigurations-PC mit installiertem Postman, der mit demselben Switch verbunden ist, mit bestätigter normaler Netzwerkkommunikation.
Laden Sie Postman herunter von:
https://www.postman.com/downloads/
Befolgen Sie dann die Installationsanweisungen, um die Einrichtung abzuschließen.
Klicken Sie auf File – New, und wählen Sie dann HTTP Request.
Wählen Sie im neuen Anfragefenster die Methode POST und geben Sie die Geräte-HTTP-URL im folgenden Format ein:
http://ip/xmlservice
Beachten Sie, dass die URL Groß-/Kleinschreibung beachtet. Ersetzen Sie ip durch die tatsächliche IP-Adresse des Geräts, wie unten gezeigt.
Konfigurieren Sie dann die erforderlichen HTTP-Anfrageparameter:
Authentifizierungsmethode: Basic Auth
Header: Content-Type: xml/text
Klicken Sie auf Body, wählen Sie raw und geben Sie dann den XML-Inhalt in den Nachrichtenkörper ein. Ein Beispielformat wird unten gezeigt.
Die Struktur ist wie folgt:
Dies ist der XML-Deklarationskopf und ist in jeder Anfrage erforderlich.
Dies definiert die XML-Befehlsstruktur. Das Attribut cmd kann entweder get sein, um aktuelle Parameter abzurufen, oder set, um neue Parameter zu schreiben.
Dies gibt das eigentliche Konfigurationselement an. In diesem Beispiel ruft die Anfrage SIP-Leitungs-bezogene Parameter vom Gerät ab.
Bei der tatsächlichen Verwendung muss der folgende Abschnitt gemäß dem tatsächlichen Parameter, den Sie abfragen oder konfigurieren möchten, angepasst werden:
Verschiedene Modelle können unterschiedliche HTTP-API-Parameter unterstützen. Sie können eine der folgenden Methoden verwenden, um die Liste der unterstützten Parameter für ein bestimmtes Gerät zu erhalten.
Methode 1: Gehen Sie in der WEB-Oberfläche des Geräts zu System – System Configuration und exportieren Sie dann die Konfigurationsdatei vom Typ nc.
Sie können mit der rechten Maustaste klicken, um die Datei zu speichern, oder mit der linken Maustaste, um die Konfiguration direkt anzuzeigen. Häufige Parameter sind im nächsten Abschnitt aufgeführt.
Methode 2: Einige Modelle bieten den Link zur nc-Konfigurationsdatei nicht direkt in der Weboberfläche. In diesem Fall können Sie die entsprechende URL in die Adressleiste des Browsers eingeben, um die nc-Konfigurationsdatei manuell abzurufen.
Hinweis: Diese Methode kann länger brauchen, um zu antworten.
Dieser Abschnitt listet mehrere häufige Parameter als Referenz auf. In zukünftigen Updates können weitere Parameter hinzugefügt werden.
Beispiel für SIP-Leitungsparameter (vom i30-Zutrittskontrollgerät):
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. zeigt an, dass diese Parameter zur SIP-Leitung 1 gehören.
PhoneNumber entspricht dem Feld Telefonnummer in der Weboberfläche.
DisplayName entspricht dem Anzeigenamen.
RegAddr ist die SIP-Proxy-Server-Adresse.
RegPort ist der SIP-Proxy-Server-Port.
RegUser ist der Benutzername für die Authentifizierung, normalerweise derselbe wie die Telefonnummer.
RegPswd ist das Passwort.
RegTTL ist die Registrierungsablaufzeit, mit einem Standardwert von 3600 Sekunden.
RegEnabled definiert, ob die Leitung aktiviert ist: 0 bedeutet deaktiviert, 1 bedeutet aktiviert.
Beispiel für DSS-Tastenparameter für das i30:
Es wird empfohlen, die DSS-Taste zuerst in der Weboberfläche zu konfigurieren und dann die HTTP-API mit dem Befehl get zu verwenden, um die entsprechenden Parameterwerte auszulesen und die genaue Zuordnung zu bestätigen.
Type=1 zeigt an, dass der DSS-Tastentyp Hotkey für Geräte wie das i30 oder i12 ist. Für andere Modelle überprüfen Sie den tatsächlichen Typwert mit der oben empfohlenen Methode.
Value=125@1/f bedeutet:
125 = Zielnummer
@1 = Leitung 1
/f = Untertyp: Kurzwahl
Beispiel für Netzwerkparameter für Geräte wie das i30 und i12:
WANMode gibt den Netzwerkmodus an, der DHCP oder static sein kann. Dieser Parameter kann nicht direkt mit dem Befehl set geschrieben werden. Er ändert sich automatisch entsprechend dem Wert von dhcp.Enabled.
static.IP ist die statische IP-Adresse. Sie ist nur wirksam, wenn sich das Gerät im statischen Modus befindet. Im DHCP-Modus kann der Befehl get weiterhin verwendet werden, um die aktuelle IP-Adresse abzurufen.
static.SubnetMask ist die Subnetzmaske.
static.Gateway ist das Standard-Gateway.
static.PrimaryDNS ist der primäre DNS-Server.
static.SecondaryDNS ist der sekundäre DNS-Server.
dhcp.Enabled definiert, ob DHCP aktiviert ist: 1 bedeutet, dass der DHCP-Modus aktiv ist, während 0 bedeutet, dass der statische IP-Modus verwendet wird.
Beispiel für Lautstärkeparameter für das BHP-SOS11V:
phone.volume.HandFreeVol ist die Lautsprecherlautstärke. Der Bereich ist 1-9, wobei 9 die höchste Lautstärke ist.
phone.volume.HandFreeRingVol ist die Klingeltonlautstärke für eingehende Anrufe. Der Bereich ist 1-9, wobei 9 die höchste Lautstärke ist.
phone.volume.HandFreeToneVol ist die Tonlautstärke für Hinweistöne wie Alarme und Benachrichtigungstöne. Der Bereich ist 1-9, wobei 9 die höchste Lautstärke ist.
Systeminformationsparameter sind schreibgeschützt, was bedeutet, dass sie nur mit dem Befehl get abgefragt werden können.
Beispiel:
Dieser Parameter gibt alle Systeminformationen zurück. Wenn Sie nur einen bestimmten Artikel benötigen, erweitern Sie den Parameterpfad auf die nächste Knotenebene.
Um beispielsweise die MAC-Adresse des Geräts abzurufen:
