Es folgt die Liste der API bieten wir mit Applikationen von Drittanbietern zur Vollautomatisierung und nahtlose Funktionalität erreichen zu integrieren.
REST API
Diese REST API bietet externe Schnittstelle, um einige wichtige Funktionen ICTBroadcast nennen. ICTBroadcast definiert 3 Klassen API_User, API_contact und API_Campaign in REST API, die alle notwendigen Funktionen, um von außerhalb des Anwendungsbereich zugegriffen werden definiert. Es folgt Code Beispiel beschreibt, wie diese Funktionen aufrufen:
User_Create
Diese Funktion erstellt einen neuen Benutzer in ICTBroadcast. Folgende Code beschreibt, wie man diese Funktion aufrufen.
Parameters
$user: serialisierten Array mit Nutzdaten
Rückgabewert
Gibt ein Array mit Benutzerdaten, falls erfolgreich. Ansonsten gibt Array mit falschen Wert.
User_Update
Diese Funktion aktualisiert die Nutzdaten.
Parameters
$user_id: ID des Benutzers, dessen Daten aktualisiert werden soll
$user: Daten des Benutzers
Rückgabewert
Gibt json codierter String mit Benutzerdaten, falls erfolgreich. Ansonsten gibt Array mit falschen Wert.
User_Get
Diese Funktion liefert Daten der Benutzer, dessen ID als Argument zur Verfügung gestellt.
Parameters
$user_id: ID des Benutzers,
$search: Suche
$value: Wert
Rückgabewert
Gibt json codierter String mit Benutzerdaten, falls erfolgreich. Ansonsten gibt Array mit falschen Wert.
User_Delete
Diese Funktion Löschen eines Benutzers, dessen ID ist.
Parameters
$user_id: ID des Benutzers,
Rückgabewert
Liefert true, wenn erfolgreich löschen andernfalls false.
User_Extension_Create
Diese Funktion erzeugt Erweiterung für den jeweiligen Benutzer.
Parameters
$user_id: ID des Benutzers,
$extension: Array mit Daten für die neue Erweiterung
Rückgabewert
Gibt json codierter String mit Verlängerung Daten, wenn erfolgreich. Ansonsten gibt Array mit falschen Wert.
User_Role_List
Diese Funktion liefert alle verfügbaren Rollen.
Parameters
Keine
Rückgabewert
Gibt json codierter String mit Benutzerrollen, falls erfolgreich.
User_Payment_Create
Diese Funktion fügt Kredit im Benutzerkonto
Parameters
$user_id: ID des Benutzers,
$value: bezahlte Betrag hinzufügen
$description: Kurzbeschreibung
$type: Art der Zahlung
Rückgabewert
Liefert true, falls hinzuzufügen Kredit erfolgreich andernfalls false.
User_Login
Diese Funktion meldet sich ein Benutzer.
Parameters
$session_id: Session ID
Rückgabewert
Versandkosten Sitzungsnamen wenn erfolgreich sonst false zurück.
User_Logout
Diese Funktion zerstört Benutzer-Session, um ihn abmelden.
Parameters
$session_id: Session ID
Rückgabewert
Versandkosten Sitzungsnamen wenn erfolgreich sonst false zurück.
Campaign_Status
Diese Funktion gibt den Status der Kampagne, dessen ID angegeben.
Parameters
$campaign_id: ID der Kampagne, deren Status ist erforderlich
Rückgabewert
Gibt json codierter String mit Kampagnenstatus Daten, wenn erfolgreich.
Campaign_Start
Diese Funktion startet eine Kampagne, deren ID angegeben.
Parameters
$campaign_id: ID der Kampagne
Rückgabewert
Gibt json codierter String mit Kampagnenstatus Daten, wenn erfolgreich.
Campaign_Stop
Diese Funktion stoppt eine Kampagne, deren ID angegeben.
Parameters
$campaign_id: ID der Kampagne
Rückgabewert
Gibt json codierter String mit Kampagnenstatus Daten, wenn erfolgreich.
Campaign_Contact_Create
Diese Funktion fügt einen bestimmten Kontakt, der durch die Kampagne, deren ID angegeben gewählt werden.
Parameters
$contact_id: Array mit Kontaktdaten, die erstellt werden.
$campaign_id: ID der Kampagne
Rückgabewert
Gibt json codierter String mit Kampagne Daten, wenn erfolgreich.
Campaign_Summary
Diese Funktion gibt die Zusammenfassung der Kampagne. Es wird eine Liste Status (besetzt, Staus, no-Antwort nicht) jedes Kontakts in der Kampagne.
Parameters
$campaign_id: ID der Kampagne, deren Status ist erforderlich
$usr_id: ID des Benutzers, besitzt diese Kampagne
Rückgabewert
Gibt json codierter String mit Kampagne Daten, wenn erfolgreich.
Campaign_Result
Diese Funktion aktualisiert eine Kampagne, seinen Status.
Parameters
$campaign_id: ID der Kampagne, deren Status ist erforderlich
$status: Status der Kampagne
$usr_id: ID des Benutzers, besitzt diese Kampagne
Rückgabewert
Gibt json codierter String mit Kampagne Daten, wenn erfolgreich.
Contact_Create
Diese Funktion erstellt einen neuen Kontakt in bestimmten Gruppe.
Parameters
$contact: Array mit Kontaktdaten.
$contact_group_id: ID der Kontaktgruppe.
Rückgabewert
Versandkosten json codierter String mit Status des Kontakts, falls erfolgreich.
Contact_Delete
Diese Funktion entfernt einen Kontakt, dessen ID angegeben.
Parameters
$contact_id: ID des Kontakts zu entfernen.
Rückgabewert
Versandkosten json codierter String mit Status des Kontakts, falls erfolgreich.