Placetel Schnittstelle: Unterschied zwischen den Versionen

Aus infra-struktur AdminWiki 2.10
Zur Navigation springenZur Suche springen
Keine Bearbeitungszusammenfassung
Keine Bearbeitungszusammenfassung
 
(14 dazwischenliegende Versionen von 3 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
<pre style="color: red">
Achtung!! Placetel stellt die API-Version im Januar 2022 um. Es ändert sich nur die URL. Die Änderung bitte beachten.
</pre>
Um einen Placetel-Anschluss in infra-struktur zu integrieren müssen sie folgendes tun.<br>
Um einen Placetel-Anschluss in infra-struktur zu integrieren müssen sie folgendes tun.<br>


Zeile 4: Zeile 7:


In der Administration Wählhilfe verwenden sie die Option [[cURL /w POST]]<br>
In der Administration Wählhilfe verwenden sie die Option [[cURL /w POST]]<br>
Die in das Feld einzutregende URL sieht in dem Fall dann so aus:<br>
Die in das Feld einzutragende URL sieht in dem Fall dann so aus:<br>
https://api.placetel.de/api/initiateCall.xml?api_key=APIKEY_den_sie_von_Placetel_bekommen&target=#NUM#&sipuid=#MSN#<br>
https://api.placetel.de/v2/calls?api_key=APIKEY_den_sie_von_Placetel_bekommen&target=#NUM#&sipuid=#MSN#<br>
Als MSN trägt der Benutzer dann seine SipUID eine. Diese sieht z.B. so aus: 123456789@fpbx.de
Als MSN trägt der Benutzer dann seine SipUID eine. Diese sieht z.B. so aus: 123456789@fpbx.de
<br/>
<br>
 
* APIKEY erstellen
Auf der Placetel-Seite unter AppStore zur Web API gehen (oder https://web.placetel.de/integrations/web_api). <br>
Dort auf die Schaltfläche "Neuen API-Token erstellen" klicken.
Links der Schaltfläche wird der API Token dann dargestellt. <br>
Wenn man mir dem Mauszeiger darauf fährt kann man den Token mit Klick der linken Maustaste kopieren. <br>
<pre style="color: red">Achtung!</pre>
Dieser Schlüssel ist nur einmalig sichtbar und muss von Ihnen sicher verwahrt werden.
Es ist nicht möglich, diesen Schlüssel erneut anzuzeigen.<br>
Falls dieser Schlüssel verloren geht, so muss er neu generiert werden.
<br>
<br>
* Für die Einrichtung der eingehende Signale
* Für die Einrichtung der eingehende Signale


Zeile 14: Zeile 27:
<br>
<br>
Sollten sie über keinen Server mit Zertifikat verfügen, sprechen sie uns an.<br>
Sollten sie über keinen Server mit Zertifikat verfügen, sprechen sie uns an.<br>
[[Datei:infra-struktur.de/unterlagen/placetel.zip]]
[https://info.infra-struktur.de/unterlagen/placetel.zip placetel.zip]<br>
1.In dem Script passen sie in den ersten Zeilen die Werte für Instanz, ISDNKey und Standort an.<br>
1.Das Script sollten sie auf einem Server mit gültigem Zertifikat hosten. Bei bedarf wenden sie sich an NETZkultur bezüglich der Bereitstellung<br>
2.Im Placetel-Backend in den Bereich Stammdaten / Einstellungen gehen.<br>
2.Das Script wird aufgerufen mit den Parametern instanz,isdnkey und standort als GET-Parameter.<br>
3.Dort auf den Reiter "Externe API" klicken.<br>
Also:
4.Die Checkbox aktivieren anklicken.<br>
<code>https://ihredomain.de/pfadzumscript/placetel.php?instanz=demo&isdnkey=12345&standort=placetel</code> <br>
5.Die genaue URL des Skriptes unter 1. im Feld URI hinterlegen.<br>
Den Parameter "isdnkey" Finden Sie in der infra-struktur unter "Administration" - "Anrufliste" im Reiter "Anrufliste" im Punkt<br>
6.Benutzername und Passwort des Admins des Placetelkontos hinterlegen.<br>
"Allgemein" im Feld "API-Call-Key".<br>
7.Die Telefonnummern aktivieren, für die die API zugreifen soll.<br>
3.Im Placetel auf den Bereich AppStore gehen und dort die kostenlose Notify API buchen / auswählen.<br>
8.Mit ändern bestätigen.<br>
<br>
[[Datei:Placetel-Api-Schritt1.jpg|700px]]
<br>
4.Dort den Bereich "API" auswählen oder über die Suche nach "Notify API" suchen <br>
5.Piktogramm der "Notify API" anklicken.<br>
6.Die Checkbox "Call Control-/Notify-API aktivieren " aktivieren.<br>
7.Die genaue URL des Skriptes unter 2. im Feld "URL Ihres API-Endpoints" hinterlegen.<br>
8.Die Telefonnummern aktivieren, für die die API zugreifen soll.<br>
9.Mit "Eigenen API-Endpoint speichern" bestätigen.<br><br>
[[Datei:Placetel-Api-Schritt2.jpg|700px]]

Aktuelle Version vom 7. März 2024, 08:32 Uhr

Achtung!! Placetel stellt die API-Version im Januar 2022 um. Es ändert sich nur die URL. Die Änderung bitte beachten.

Um einen Placetel-Anschluss in infra-struktur zu integrieren müssen sie folgendes tun.

  • Für die Einrichtung der Wählhilfe

In der Administration Wählhilfe verwenden sie die Option cURL /w POST
Die in das Feld einzutragende URL sieht in dem Fall dann so aus:
https://api.placetel.de/v2/calls?api_key=APIKEY_den_sie_von_Placetel_bekommen&target=#NUM#&sipuid=#MSN#
Als MSN trägt der Benutzer dann seine SipUID eine. Diese sieht z.B. so aus: 123456789@fpbx.de

  • APIKEY erstellen

Auf der Placetel-Seite unter AppStore zur Web API gehen (oder https://web.placetel.de/integrations/web_api).
Dort auf die Schaltfläche "Neuen API-Token erstellen" klicken. Links der Schaltfläche wird der API Token dann dargestellt.
Wenn man mir dem Mauszeiger darauf fährt kann man den Token mit Klick der linken Maustaste kopieren.

Achtung!

Dieser Schlüssel ist nur einmalig sichtbar und muss von Ihnen sicher verwahrt werden. Es ist nicht möglich, diesen Schlüssel erneut anzuzeigen.
Falls dieser Schlüssel verloren geht, so muss er neu generiert werden.

  • Für die Einrichtung der eingehende Signale

Hierzu wird folgendes Script benötigt daß sie auf einem Server der SSL-Verschlüsselung unterstützt ablegen und erreichbar machen müssen.
Sollten sie über keinen Server mit Zertifikat verfügen, sprechen sie uns an.
placetel.zip
1.Das Script sollten sie auf einem Server mit gültigem Zertifikat hosten. Bei bedarf wenden sie sich an NETZkultur bezüglich der Bereitstellung
2.Das Script wird aufgerufen mit den Parametern instanz,isdnkey und standort als GET-Parameter.
Also: https://ihredomain.de/pfadzumscript/placetel.php?instanz=demo&isdnkey=12345&standort=placetel
Den Parameter "isdnkey" Finden Sie in der infra-struktur unter "Administration" - "Anrufliste" im Reiter "Anrufliste" im Punkt
"Allgemein" im Feld "API-Call-Key".
3.Im Placetel auf den Bereich AppStore gehen und dort die kostenlose Notify API buchen / auswählen.


4.Dort den Bereich "API" auswählen oder über die Suche nach "Notify API" suchen
5.Piktogramm der "Notify API" anklicken.
6.Die Checkbox "Call Control-/Notify-API aktivieren " aktivieren.
7.Die genaue URL des Skriptes unter 2. im Feld "URL Ihres API-Endpoints" hinterlegen.
8.Die Telefonnummern aktivieren, für die die API zugreifen soll.
9.Mit "Eigenen API-Endpoint speichern" bestätigen.