Im Folgenden finden Sie eine Liste der APIs, die wir zur Integration in Anwendungen von Drittanbietern bereitstellen, um eine vollständige Automatisierung und nahtlose Funktionalität zu erreichen.

REST API

Dadurch REST API bietet eine externe Schnittstelle zum Aufrufen einiger wichtiger Funktionen von ICTBroadcast. ICTBroadcast definiert drei Klassen API_User, API_contact und API_Campaign in der REST-API, die alle Funktionen definieren, auf die von außerhalb des Anwendungsbereichs zugegriffen werden muss. Das folgende Codebeispiel beschreibt, wie diese Funktionen aufgerufen werden:

User_Create

Diese Funktion erstellt einen neuen Benutzer in ICTBroadcast. Der folgende Code beschreibt, wie diese Funktion aufgerufen wird.

Parameter

$ user: serialisiertes Array mit Benutzerdaten

Rückgabewert

Gibt bei Erfolg ein Array mit Benutzerdaten zurück. Andernfalls wird ein Array mit einem falschen Wert zurückgegeben.

User_Update

Diese Funktion aktualisiert die Benutzerdaten.

Parameter


$ user_id: ID des Benutzers, dessen Daten aktualisiert werden sollen


$ user: Daten des Benutzers

Rückgabewert


Gibt bei Erfolg eine json-codierte Zeichenfolge mit Benutzerdaten zurück. Andernfalls wird ein Array mit einem falschen Wert zurückgegeben.

User_Get

Diese Funktion gibt Daten des Benutzers zurück, dessen ID als Argument angegeben ist.

Parameter


$ user_id: ID des Benutzers


$ search: Suche


$ value: value

Rückgabewert


Gibt bei Erfolg eine json-codierte Zeichenfolge mit Benutzerdaten zurück. Andernfalls wird ein Array mit einem falschen Wert zurückgegeben.

User_Delete

Diese Funktion löscht einen Benutzer, dessen ID angegeben ist.

Parameter


$ user_id: ID des Benutzers

Rückgabewert


Gibt true zurück, wenn das Löschen erfolgreich ist. Andernfalls wird false zurückgegeben.

User_Extension_Create

Diese Funktion erstellt eine Erweiterung für den angegebenen Benutzer.

Parameter


$ user_id: ID des Benutzers


$ extension: Array mit Daten für die neue Erweiterung

Rückgabewert


Gibt bei Erfolg eine json-codierte Zeichenfolge mit Erweiterungsdaten zurück. Andernfalls wird ein Array mit einem falschen Wert zurückgegeben.

User_Role_List

Diese Funktion gibt alle verfügbaren Rollen zurück.

Parameter


Keines

Rückgabewert


Gibt bei Erfolg eine json-codierte Zeichenfolge mit Benutzerrollen zurück.

User_Payment_Create

Diese Funktion fügt dem Benutzerkonto Guthaben hinzu

Parameter


$ user_id: ID des Benutzers


$ value: bezahlter Betrag zum Hinzufügen


$ description: kurze Beschreibung


$ type: Zahlungsart

Rückgabewert


Gibt true zurück, wenn das Hinzufügen eines Guthabens erfolgreich ist. Andernfalls wird false zurückgegeben.

Benutzer-Anmeldung

Diese Funktion meldet einen Benutzer an.

Parameter


$ session_id: Sitzungs-ID

Rückgabewert


Gibt den Sitzungsnamen zurück, wenn erfolgreich, andernfalls wird false zurückgegeben.

User_Logout

Diese Funktion zerstört die Benutzersitzung, um ihn abzumelden.

Parameter


$ session_id: Sitzungs-ID

Rückgabewert


Gibt den Sitzungsnamen zurück, wenn erfolgreich, andernfalls wird false zurückgegeben.

Campaign_Status

Diese Funktion gibt den Status der Kampagne an, deren ID angegeben ist.

Parameter


$aign_id: ID der Kampagne, deren Status erforderlich ist

Rückgabewert


Gibt bei Erfolg eine json-codierte Zeichenfolge mit Kampagnenstatusdaten zurück.

Campaign_Start

Diese Funktion startet eine Kampagne, deren ID angegeben wird.

Parameter


$aign_id: ID der Kampagne

Rückgabewert


Gibt bei Erfolg eine json-codierte Zeichenfolge mit Kampagnenstatusdaten zurück.

Campaign_Stop

Diese Funktion stoppt eine Kampagne, deren ID angegeben ist.

Parameter


$aign_id: ID der Kampagne

Rückgabewert


Gibt bei Erfolg eine json-codierte Zeichenfolge mit Kampagnenstatusdaten zurück.

Campaign_Contact_Create

Diese Funktion fügt einen bestimmten Kontakt hinzu, der von der Kampagne gewählt wird, deren ID angegeben wird.

Parameter


$ contact_id: Array mit Kontaktdaten, die erstellt werden.


$aign_id: ID der Kampagne

Rückgabewert


Gibt bei Erfolg eine json-codierte Zeichenfolge mit Kampagnendaten zurück.

Campaign_Summary

Diese Funktion gibt die Zusammenfassung der Kampagne zurück. Es wird der Status (beschäftigt, Überlastung, keine Antwort, fehlgeschlagen) jedes Kontakts in der Kampagne aufgelistet.

Parameter


$aign_id: ID der Kampagne, deren Status erforderlich ist


$ usr_id: Die ID des Benutzers besitzt diese Kampagne

Rückgabewert


Gibt bei Erfolg eine json-codierte Zeichenfolge mit Kampagnendaten zurück.

Campaign_Result

Diese Funktion aktualisiert eine Kampagne und ihren Status.

Parameter


$aign_id: ID der Kampagne, deren Status erforderlich ist


$ status: Status der Kampagne


$ usr_id: Die ID des Benutzers besitzt diese Kampagne

Rückgabewert


Gibt bei Erfolg eine json-codierte Zeichenfolge mit Kampagnendaten zurück.

Campaign_Filter

Diese Funktion bietet einen Suchfilter für die Suche nach Kampagnen.

Parameter


$ search: Array von Suchabfragen für die Kampagnendaten.

Rückgabewert


Gibt bei Erfolg eine json-codierte Zeichenfolge mit Kampagnendaten zurück.

Contact_Create

Diese Funktion erstellt einen neuen Kontakt in der angegebenen Gruppe.

Parameter


$ contact: Array mit Kontaktdaten.


$ contact_group_id: ID der Kontaktgruppe.

Rückgabewert


Gibt bei Erfolg eine json-codierte Zeichenfolge zurück, die den Status des Kontakts enthält.

Contact_Delete

Diese Funktion entfernt einen Kontakt, dessen ID angegeben ist.

Parameter


$ contact_id: ID des zu entfernenden Kontakts.

Rückgabewert


Gibt bei Erfolg eine json-codierte Zeichenfolge zurück, die den Status des Kontakts enthält.

Hier sind Beispielbereitstellungen von ICTBroadcast-REST-APIs

ICTBroadcast-Ganzzahl mit EspoCRM

ICTBroadcast-Ganzzahl mit VtigerRM

Klicken Sie hier, um ein Internet-Telefoniedienstanbieter zu werden und Ihr eigenes Unternehmen zu gründen