API

mmDial bietet ein umfangreiches API zur Anbindung externer Software.

Viele Schnittstellen sind bislang undokumentiert. Sollten Sie eine weitere Schnittstelle benötigen, wenden Sie sich bitte an unseren Support! Die API befindet sich nocht im Alpha-Stadium. Die Dokumentation kann fehlerhaft sein, und Schnittstellen können sich jederzeit ändern!

Allgemeines

* Die mmDial API ist über http://login.mmdial.de/api/ zu erreichen.
* Die API benutzt die Standard HTTP Authentication.
* Als Benutzername wird ein Benutzer mit Adminrechten verwendet
* Es werden je nach Funktion HTTP GET und HTTP POST Argumente übergeben
* Rückmeldungen erfolgen in der Regel als json Objekt

Funktionen

searchvoicebyleadid

Sucht eine Voice-Aufnahme über die Lead-ID des Kunden.

Parameter

* leadid (GET) - die zu suchende Lead-ID

Rückgabe

json Objekt:

* status: ok|error
* msg: (nur bei error)
* voices: json Objekt:
 * recid: Aufnahme-ID
 * agentid: Agenten-ID
 * timestamp: Der Zeitstempel der Aufnahme
 * available: yes|no yes, wenn die Datei schon/noch abrufbar ist.
 * voiceid: Dateiinterne ID
 * url: Url um die Datei herunterzuladen.
 * length: Abspiellänge der Aufzeichnung
 * size: Größe der Aufzeichnung

searchvoicebyphonenumber

Sucht eine Voice-Aufnahme über die Telefonnummer des Kunden.

Parameter

* phone(GET) - die zu suchende Telefonnummer
* date (GET, optional) - Datum im Format YYYY-MM-DD
* timestamp (GET, optional) - Timestamp im Format YYYMMDDHHIISS

Rückgabe

json Objekt:

* status: ok|error
* msg: (nur bei error)
* voices: json Objekt:
 * recid: Aufnahme-ID
 * agentid: Agenten-ID
 * timestamp: Der Zeitstempel der Aufnahme
 * available: yes|no yes, wenn die Datei schon/noch abrufbar ist.
 * voiceid: Dateiinterne ID
 * url: Url um die Datei herunterzuladen.
 * length: Abspiellänge der Aufzeichnung
 * size: Größe der Aufzeichnung

searchvoicebyagent

Sucht eine Voice-Aufnahme über die Agenten-ID.

Parameter

* agentid(GET) - die zu Agenten-ID
* date (GET, optional) - Datum im Format YYYY-MM-DD
* timestamp (GET, optional) - Timestamp im Format YYYMMDDHHIISS

Rückgabe

json Objekt:

* status: ok|error
* msg: (nur bei error)
* voices: json Objekt:
 * recid: Aufnahme-ID
 * agentid: Agenten-ID
 * timestamp: Der Zeitstempel der Aufnahme
 * available: yes|no yes, wenn die Datei schon/noch abrufbar ist.
 * voiceid: Dateiinterne ID
 * url: Url um die Datei herunterzuladen.
 * length: Abspiellänge der Aufzeichnung
 * size: Größe der Aufzeichnung

getfieldsbycampaign

Gibt alle Auftragsformularfelder einer Kampagne zurück.

Parameter

* campaign_id (GET) - die Kampagnen-ID

Rückgabe

json Objekt:

* fields - json Objektliste:
 * name: Feldname

exportbystatus

Erstellt eine Exportdatei aus verschiedenen Kriterien als CSV.

Parameter

* campaign_id (GET) - die Kampagnen-ID
* status (GET Array, optional) - die zu Exportierenden Status
* datetype: (GET, optional) last_phone|last_edit|imported_date (GET Array, optional)
* fromdate: (GET, optional) Datum beginn: d.m.Y
* fromtime: (GET, optional) Uhrzeit beginn: H:i:s
* todate: (GET, optional) Datum ende: d.m.Y
* totime: (GET, optional) Uhrzeit ende: H:i:s
* selectedfields: (GET/POST) Feldauswahlliste getrennt durch , (Kommata) Prefix für Normale Felder: customerfield_, Prefix für Auftragsformularfelder: webformfield_

Rückgabe

json Objekt:

* status: ok|error
* file_id: Datei-ID
* size: Datei-Größe
* url: Datei-URL

dncadd

Fügt eine oder mehrere Nummern der Sperrliste hinzu

Parameter

* number (GET (Optional: mehrere durch , getrennt))

Rückgabe

json Objekt:

* status: ok|error|doublet
* message

dncdel

Löscht eine, oder mehrere Nummern aus der Sperrliste.

Parameter

* number (GET (Optional: mehrere durch , getrennt))

Rückgabe

json Objekt:

* status: ok|error
* message

dncget

Gibt die Sperrliste als CSV Datei zurück

Parameter keine

Rückgabe

CSV-Datei mit allen gesperrten Rufnummern

dnccheck

Sucht eine Nummer in der DNC-Liste

Parameter

* number (GET)
* fuzzy: yes|no (GET, optional) Sucht auch nach Teilnummern.

Rückgabe

json Objekt:

* status: exists|notfound (bei fuzzy = no)
* results: Liste mit passenden Telefonnummern (bei fuzzy = yes)