JSON-Format
Auslöser werden als JSON-Objekte mit den folgenden Attributen dargestellt.
| Name | Typ | Schreibgeschützt | Beschreibung |
| name | Zeichenfolge | Nein | Name des Auslösers |
| enabled | Ganzzahl | Nein | Gibt an, ob der Auslöser aktiviert ist oder nicht |
| description | Zeichenfolge | Nein | Beschreibung des Auslösers |
| definition | Objekt | Nein | Definition des Auslösers. Genauere Einzelheiten finden Sie unter Definitionen von Auslösern. |
Definitionen von Auslösern
Hinweis: Definitionen können unter „Auslöser aktualisieren“ nicht bearbeitet werden.
Ausführliche Beschreibungen zu den einzelnen Auslösern finden Sie unter Referenz: Bedingungen und Aktionen für Auslöser.
Auslöser werden einfach mit JSON definiert. Jeder Auslöser ist ein JSON-Objekt mit drei Schlüsseln:
| Schlüssel zur Definition von Auslösern | Beschreibung |
| event | (JSON-Zeichenfolge) Die Art des Ereignisses, bei der der Auslöser aktiviert wird. Eine Liste der Ereignisse finden Sie unter „Auslöserereignisse“. |
| condition | (JSON-Liste) Die Bedingung, die erfüllt sein muss, damit die im Auslöser festgelegten Aktionen ausgeführt werden. Weitere Informationen finden Sie unter „Bedingungstypen“. |
| action | (JSON-Liste) Die Liste der Aktionen, die ausgeführt werden, wenn die Bedingung erfüllt ist. Weitere Informationen finden Sie unter „Auslöseraktionen“. |
Auslöserereignisse
Folgende Ereignisse können verwendet werden:
| Auslöserereignis | Beschreibung |
| page_enter | Dieses Ereignis wird ausgelöst, wenn ein Besucher das Chat-Widget geladen hat. |
| chat_requested | Dieses Ereignis wird ausgelöst, wenn ein Besucher einen Chat anfordert. |
| chat_message | Dieses Ereignis wird ausgelöst, wenn ein Besucher eine Chatnachricht sendet. |
Bedingungsereignisse
Folgende Bedingungen können verwendet werden:
| Art der Bedingung | Beschreibung |
| or | Überprüfen, ob eine der Bedingungen erfüllt ist |
| and | Überprüfen, ob alle Bedingungen erfüllt sind |
Operatoren für Bedingungsvariablen
Folgende Operatoren können für Bedingungsvariablen verwendet werden. Für andere Variablen stehen möglicherweise keine Operatoren zur Verfügung.
| Operator | Beschreibung |
| eq | Gleich |
| neq | Ungleich |
| lt | Kleiner als |
| gt | Größer als |
| lte | Kleiner oder gleich |
| gte | Größer oder gleich |
| icontains | Enthält |
| nicontains | Enthält nicht |
| contains | Enthält (Klein-/Großschreibung relevant) |
| ncontains | Enthält nicht (Klein-/Großschreibung relevant) |
| regex | Regulärer Ausdruck (Klein-/Großschreibung relevant) |
| iregex | Regulärer Ausdruck |
Bedingungsvariablen
Folgende Variablen können verwendet werden:
Uhrzeit- und Datumsvariablen
| Typ | Beschreibung |
| @hour_of_day | Stunde (Zeitzone UTC), 0 bis 23 |
| @day_of_week | Wochentag. 0 = Montag, 6 = Sonntag |
| @visitor_time_on_page | Anzahl von Sekunden, die der Besucher auf der aktuellen Seite verbracht hat |
| @visitor_time_on_site | Anzahl von Sekunden, die der Besucher auf Ihrer Site verbracht hat |
| stillOnSite | Verzögerung (in Sek.), bevor die nächste Bedingung überprüft wird |
| stillOnPage | Verzögerung (in Sek.), bevor die nächste Bedingung überprüft wird |
Standort des Besuchers
| Typ | Beschreibung |
| @visitor_ip | IP-Adresse des Besuchers (xxx.xxx.xxx.xxx) |
| @visitor_hostname | Hostname zur IP-Adresse des Besuchers |
| @visitor_city | Ort, im dem sich der Besucher befindet |
| @visitor_region | Region, aus der der Besucher stammt |
| @visitor_country_code | Ländercode des Besuchers (zwei Buchstaben) |
| @visitor_country_name | Land, in dem sich der Besucher befindet |
Informationen zu früheren Besuchen
| Typ | Beschreibung |
| @visitor_previous_visits | Anzahl früherer Besuche des Besuchers. Neue Besuche = 0 |
| @visitor_previous_chats | Anzahl früherer Chats des Besuchers mit Agenten. Neue Chats = 0 |
Seiteninformationen
| Typ | Beschreibung |
| @visitor_page_url | URL der Seite, auf der sich der Besucher gegenwärtig befindet |
| @visitor_page_title | Titel der Seite, auf der sich der Besucher gegenwärtig befindet |
| @visitor_page_count | Anzahl von Seiten, die der Besucher aufgerufen hat. Erste Seite = 1 |
| @referrer | URL der vorherigen Seite, auf der sich der Besucher befand |
Besucherinformationen
| Typ | Beschreibung |
| @visitor_name | Name des Besuchers |
| @visitor_email | E-Mail-Adresse des Besuchers |
| @visitor_referrer | Referrer-URL des Besuchers (beim Einstieg in Ihre Site) |
| @visitor_search_engine | Gegebenenfalls die Suchmaschine, über die der Besucher auf Ihre Site gelangte |
| @visitor_search_terms | Gegebenenfalls der Suchbegriff, über den der Besucher auf Ihre Site gelangte |
| @visitor_tags | Name des Stichworts (festgelegt durch Aktion „Stichwort setzen) |
| @visitor_triggered | „True“, wenn der Besucher ausgelöst wurde (festgelegt durch Aktion „Auf ausgelöst setzen“) |
| @visitor_department_id | Abteilung des Besuchers (festgelegt durch die Aktion „Besucherabteilung festlegen“ oder die JavaScript-API) |
Software/Computer des Besuchers
| Typ | Beschreibung |
| @visitor_user_agent | User-Agent-Zeichenfolge des vom Besucher verwendeten Browsers |
| @visitor_browser | Browser des Besuchers |
| @visitor_platform | Betriebssystem/Plattform des Besuchers |
Onlinestatus
| Typ | Beschreibung |
| @account_status | Kontostatus (online/abwesend/offline) |
| @visitor_status | Besucherstatus (online/inaktiv/offline) |
Chatbezogene Informationen
| Typ | Beschreibung |
| @visitor_requesting_chat | „True“, wenn der Besucher um einen Chat bittet |
| @visitor_served | „True“, wenn der Besucher gegenwärtig von einem Agenten betreut wird |
| @department | Abteilung (Name), die der Besucher im Chatanfrageformular auswählt |
| @visitor_served | „True“, wenn der Besucher gegenwärtig von einem Agenten betreut wird |
| @sender | Name des Absenders dieser Nachricht |
| @sender_type | Entweder „agent“ oder „visitor“ |
| @message | Die gesendete Nachricht |
Auslöseraktionen
| Aktion | Parameter | Beschreibung |
| sendMessageToVisitor | Name des Agenten oder der Nachricht (Zeichenfolge) | Sendet eine Nachricht an den Besucher |
| setTriggered | True/false (Boolescher Wert) | Setzt die Flagge „triggered“ für den Besucher |
| wait | Dauer (in Sekunden) (Zahl) | Wartet die festgelegte Anzahl von Sekunden und führt dann die nächste Aktion in der Liste aus, wenn der Besucher noch online ist |
| addTag | Name des Stichworts (Zeichenfolge) | Fügt ein Stichwort zum Besucher hinzu, das in der Besucherliste im Dashboard sichtbar ist |
| removeTag | Name des Stichworts (Zeichenfolge) | Entfernt ein Stichwort aus der Besuchersitzung |
| banVisitor | Grund (Zeichenfolge) | Besucher sperren mit Grund |
| banIp | Grund (Zeichenfolge) | IP-Adresse sperren mit Grund |
| setName | Name des Besuchers (Zeichenfolge) | Legt den Namen des Besuchers fest |
| setDepartment | ID der Abteilung (Nummer) | Legt die aktuelle Abteilung des Besuchers fest |
| setNote | Notiz (Zeichenfolge) | Legt eine Notiz für den Besucher fest, die immer im Dashboard zu sehen ist |
| appendNote | Notiz (Zeichenfolge) | Hängt an die aktuelle Notiz für den Besucher eine weitere Notiz an |
Alle Auslöser abrufen
GET /api/v2/triggers
Erstellt eine Liste aller Auslöser eines Kontos.
Zulässig für
Owner
Administrator
Über cURL
curl https://www.zopim.com/api/v2/triggers \
-v -u {email_address}:{password}
Antwortbeispiel
HTTP/1.1 200 OK
Content-Type: application/json
[
{
"name" : "Guter Auslöser",
"enabled" : 1,
"description" : "Besucher auf Seite angekommen"
},
{
"name" : "Besserer Auslöser",
"enabled" : 1,
"description" : "Besucher hat Chat angefordert"
}
]
Auslöser abrufen
GET /api/v2/triggers/{trigger_name}
Ermöglicht es dem Kontoinhaber bzw. einem Administrator, einen Auslöser nach Namen abzurufen.
Zulässig für
Owner
Administrator
Über cURL
curl https://www.zopim.com/api/v2/triggers/{trigger_name} \
-v -u {email_address}:{password}
Antwortbeispiel
HTTP/1.1 200 OK
Content-Type: application/json
{
"name" : "Guter Auslöser",
"enabled" : 1,
"description" : "Besucher hat Chat angefordert",
}
Auslöser erstellen
POST /api/v2/triggers
Ermöglicht es dem Kontoinhaber bzw. einem Administrator, einen Auslöser zu einem Konto hinzuzufügen.
Zulässig für
Owner
Administrator
Über cURL
curl https://www.zopim.com/api/v2/triggers \
-d '{
"name" : "Guter Auslöser",
"enabled" : 1,
"description" : „Besucher hat Chat angefordert"
}' \
-v -u {email_address}:{password} \
-X POST -H "Content-Type: application/json"
Antwortbeispiel
HTTP/1.1 201 Created
Content-Type: application/json
{
"name" : "Guter Auslöser",
"enabled" : 1,
"description" : "Besucher hat Chat angefordert",
}
Senden von Nachrichten an eine bestimmte Seite/ein bestimmtes Verzeichnis
Sendet eine Nachricht automatisch an eine bestimmte URL oder an ein bestimmtes Verzeichnis
curl https://www.zopim.com/api/v2/triggers \
-d '{
"name" : "Gestreifte Schuhe",
"enabled" : 1,
"description" : "Rabattcode für gestreifte Schuhe senden",
"definition" : {
"event" : "page_enter",
"condition" : [
"and",
[
"icontains",
"@visitor_page_url",
"stripshoe"
],
[
"stillOnPage",
20
]
],
"actions" : [
[
"sendMessageToVisitor",
"Timmy",
"Hier ist ein Rabattcode für dich! Beim Bezahlen einfach RABATT10 angeben"
]
]
}
}' \
-v -u {email_address}:{password} \
-X POST -H "Content-Type:application/json"
Einzelheiten zur Konfiguration von Auslösern finden Sie auf der Seite „Auslöser“ des Kontos
Auslöser aktualisieren
PUT /api/v2/triggers/{trigger_name}
Ermöglicht es dem Kontoinhaber bzw. einem Administrator, die Daten eines Auslösers zu aktualisieren.
Zulässig für
Owner
Administrator
Über cURL
curl https://www.zopim.com/api/v2/triggers/{trigger_name} \
-d '{
"name" : "Bester Auslöser",
"description" : "Besucher hat neuen Chat angefordert"
}' \
-v -u {email_address}:{password} \
-X POST -H "Content-Type:application/json"
Antwortbeispiel
HTTP/1.1 200 OK
Content-Type: application/json
{
"name" : "Bester Auslöser",
"enabled" : 1,
"description" : "Besucher hat neuen Chat angefordert",
}
Auslöser löschen
DELETE /api/v2/triggers/{trigger_name}
Ermöglicht es dem Kontoinhaber bzw. einem Administrator, einen Auslöser zu löschen.
Zulässig für
Owner
Administrator
Über cURL
curl https://www.zopim.com/api/v2/triggers/{trigger_name} \
-v -u {email_address}:{password} -X DELETE
Antwortbeispiel
HTTP/1.1 204 OK
Content-Type: application/json