Einführung

Das IVR-Objekt CRM+ Query wird verwendet, um das CRM+-System über die REST-API abzufragen.

Die Abfragen, die verwendet werden, sind sehr generisch und benötigen das Coden von tatsächlichen SQL-Anweisungen. 

Der Vorteil ist, dass Sie so gut wie alles abfragen können.

Es erfordert jedoch ein wenig Vorarbeit, um herauszufinden, wie die Datenbank strukturiert ist.

Postman

Um herauszufinden, welche Tabellen und Felder vorhanden sind, haben wir eine Postman-Collection bereitgestellt, die hier heruntergeladen werden kann. Dies vereinfacht das Testen erheblich.

Collection Download

Variablen

Bearbeiten Sie zunächst die Sammlung, und richten Sie die erforderlichen Variablen ein. Dies sind die Einstellungen, die Sie in diesem Schritt hier abgerufen haben: CRM+ First Steps.

Sie müssen folgende Variablen ändern:

• accessKey (vom CRM+ Konto)
• userName (der Anmeldename des CRM+ - Kontos)
• baseURL (die URL Ihrer CRM+ - Instanz)

Funktionen

Die Postman-Collection bietet die folgenden Funktionen:

Skripte

Die Postman-Collection enthält Skripte, die das Ergebnis parsen und Variablen in der Sammlung aktualisieren, damit die nächste Funktion ausgeführt werden kann.

Die Skripte finden Sie im Abschnitt testsTests:

Erkunden der Struktur von CRM+

Abrufen aller Tabellennamen

Um alle Tabellennamen abzurufen, müssen Sie die REST-Funktionen ausführen:

• 1. Getchallenge
• 2. Login
• 3. Listtypes

Dadurch erhalten Sie ein JSON-Ergebnis, das alle Tabellennamen enthält, auf die Sie zugreifen können.

Zum Beispiel:

{
    "success": true,
    "result": {
    "types": [
        "Leads",
        "Accounts",
        "Contacts",
        ...

Ermitteln der Feldnamen

Der einfachste Weg, alle Feldnamen in einer bestimmten Tabelle herauszufinden, besteht darin, eine SELECT * FROM <Tabellenname>; Abfrage auszuführen.

Die Beispielabfrage tut dies für die Tabelle "Contacts".

Um diese in Postman auszuführen, führen Sie die folgenden Funktionen aus:

• 1. Getchallenge
• 2. Login
• 4. Query

Praktische Abfragen

Eine praktische Abfrage hängt natürlich ganz davon ab, was Sie erreichen wollen.

Um z. B. alle Kontakte mit einer bestimmten Telefonnummer abzurufen, könnten Sie dies wie folgt tun:

# Find a contact by telephone number
SELECT * FROM Contacts WHERE phone = '%2B$caller';

Beachten Sie, dass das Pluszeichen als %2B kodiert ist. Hier verwenden wir die Variable $caller, welche die die Anrufer-ID ohne Pluszeichen im vollqualifizierten E.164-Format enthält, um die Anrufernummer an das CRM-System zu übergeben.

URLs erstellen

IDs in CRM+

CRM+ gibt IDs in der REST-API unter Verwendung einer Kombination aus dem Modul zurück, in dem der Datensatz gespeichert ist, und der ID selbst zurück.

Zum Beispiel:

Dieser Datensatz befindet sich in Modul 4 und hat die ID 9.

Das Modul kann mit der Funktion 3. Listentypen abgerufen werden.

Hier ist das Snippet, das vom Modul "Contacts" zurückgegeben wird:

Nur den Datensatz-ID extrahieren

Im jtel IVR-Skript-Editor muss dazu die rechte Seite der ID extrahiert werden, was mit den dem IVR Objekt String-Funktionen erreicht werden kann.

Aufbau der URL

Der Aufbau einer URL für die Verwendung im jtel System umfasst die folgenden Komponenten:

Die URL hat folgenden folgendes Format:

{{baseURL}}/index.php?action=DetailView&module={{module}}&record={{ID}}

Um z. B. den Kontakt mit der ID 1234 anzuzeigen, könnte die folgende URL verwendet werden:

https://mycompany.brain-app.com/index.php?action=DetailView&module=Contacts&record=1234