mmDial API

Allgemeines

Die mmDial API bindet externe Software an einen mmDial-Zugang an: Aufnahmen suchen und herunterladen, Daten exportieren, die Sperrliste pflegen, Leads lesen, anlegen und ändern.

Nicht jede Schnittstelle von mmDial steht hier. Wenn Sie eine weitere benötigen, wenden Sie sich an unseren Support – vieles ist vorhanden und nur noch nicht beschrieben.

Anmeldung per Token

Jeder Aufruf weist sich mit einem Token aus. Den Token legen Sie selbst in der Kundenverwaltung an, unter API-Token.

• Der Token wird einmal angezeigt. Gespeichert wird nur eine Prüfsumme – danach ist er nicht mehr abrufbar. Notieren Sie ihn sofort.
• Jeder Token trägt einen Namen, damit später erkennbar ist, wer ihn benutzt. Legen Sie lieber je Anwendung einen eigenen an: dann lässt sich einer abschalten, ohne die anderen zu stören.
• Ein Token kann auf einzelne Aktionen begrenzt werden – eine Aktion je Zeile. Leer bedeutet: alle Aktionen sind erlaubt.
• Änderungen am Token (abschalten, löschen, Begrenzung) wirken nach spätestens fünf Minuten. Die Schnittstelle merkt sich eine Anmeldung so lange.

Der Token im Aufruf

Bevorzugt im Authorization-Kopf:

curl -H "Authorization: Bearer <TOKEN>" \
     "https://login.mmdial.de/api/index.php?action=dncget"

Wo das nicht geht, auch als HTTP-Basic-Anmeldung – Benutzername xmlrpc_user, Kennwort ist der Token:

curl -u "xmlrpc_user:<TOKEN>" \
     "https://login.mmdial.de/api/index.php?action=dncget"

Dem Benutzernamen darf Ihre Dialer-Kennung angehängt werden, getrennt durch - oder _, also etwa xmlrpc_user-1098. Das ändert an der Prüfung nichts, die Kennung landet aber im Zugriffsprotokoll des Webservers und hilft uns bei der Fehlersuche. Stimmt sie nicht zum Token, ist der Aufruf abgewiesen.

Ob der Token trägt

Mit 401 Unauthorized antwortet die Schnittstelle, wenn der Token unbekannt, abgeschaltet oder für diese Aktion nicht freigegeben ist. Bei einem 401 prüfen Sie also beides: den Token selbst und seine Aktionsbegrenzung.

authtestGET

Die Probeaktion: Sie antwortet nur, wenn die Anmeldung gilt. Keine Parameter.

curl -H "Authorization: Bearer <TOKEN>" \
     "https://login.mmdial.de/api/index.php?action=authtest"

{"status":"ok","login":"token","customer":1098,"time":"2026-10-26 11:04:12"}

Dateien abholenGET

Aufnahmen und Exportdateien holen Sie mit action=getfile. Die fertige Adresse steht in der Antwort der Aktion, die die Datei erzeugt oder gefunden hat – im Feld url. Nehmen Sie sie von dort, statt sie selbst zusammenzusetzen.

Parameter

Antwort

Die Datei selbst, kein JSON. Die Anmeldung gehört auch hier dazu: die Adresse allein gibt nichts heraus.

curl -H "Authorization: Bearer <TOKEN>" -o aufnahme.mp3 \
  "https://login.mmdial.de/api/index.php?action=getfile&type=voices&file=9912837"

Exportdateien sind für den Abruf gedacht, nicht für die Aufbewahrung – holen Sie sie zeitnah ab.

Feldnamen

Drei Aktionen arbeiten mit Leadfeldern: exportbystatus, addlead und editlead. Sie benutzen dieselben Namen.

Im Export sind zusätzlich diese Namen möglich, die es beim Schreiben nicht gibt: agentid (Agent des letzten Anrufs), imported_date (angelegt am), last_edit (zuletzt geändert), last_phone (letzter Anruf). Jede andere Spalte der Leadtabelle lässt sich ebenfalls mit ihrem eigenen Namen exportieren.

searchvoicebyleadidGET

Sucht die Aufnahmen zu einem Lead.

Parameter

Antwort

{
  "status": "ok",
  "voices": [
    {
      "recid": "4815162",
      "agentid": "1098-204",
      "timestamp": "2026-10-20 11:32:07",
      "available": "yes",
      "voiceid": "9912837",
      "url": "http://api.mmdial.de/index.php?action=get&type=voices&file=9912837",
      "length": "184",
      "size": "1472000"
    }
  ]
}

searchvoicebyphonenumberGET

Sucht Aufnahmen über die Rufnummer des Kunden.

Parameter

Antwort

Wie bei searchvoicebyleadid, und jeder Eintrag nennt zusätzlich leadid – die Rufnummer kann in mehreren Leads stehen.

Höchstens 1000 Aufnahmen je Aufruf, die neuesten zuerst. Grenzen Sie mit date ein, wenn Sie mehr erwarten.

searchvoicebyagentGET

Sucht Aufnahmen über den Agenten.

Parameter

Antwort

Wie bei searchvoicebyphonenumber, ebenfalls höchstens 1000 Aufnahmen je Aufruf. Für einen ganzen Tag eines Agenten reicht das meistens nicht – fragen Sie dann je Tag ab.

getfieldsbycampaignGET

Nennt die Auftragsformularfelder einer Kampagne. Damit erfahren Sie die Namen, die exportbystatus und editlead erwarten.

Parameter

Antwort

{
  "fields": [
    { "name": "Kundennummer", "GUID": "41" },
    { "name": "Tarif",        "GUID": "41" }
  ]
}

GUID ist die Nummer des Formulars. Ein Feld desselben Namens kann in mehreren Formularen einer Kampagne vorkommen; erst Name und GUID zusammen bezeichnen es eindeutig. Die Einträge aus allfields=yes haben keine GUID.

getfieldsbyguidGET

Dasselbe für ein einzelnes Formular, über dessen Nummer. Nützlich, wenn eine Kampagne mehrere Formulare hat und Sie nur die Felder von einem brauchen.

Parameter

Antwort

Wie bei getfieldsbycampaign: eine Liste fields mit name und GUID.

exportbystatusGETPOST

Erstellt eine CSV-Datei mit den Leads einer Kampagne und gibt die Abrufadresse zurück. Die Auswahl der Felder bestimmen Sie selbst.

Parameter

Antwort

curl -H "Authorization: Bearer <TOKEN>" \
  "https://login.mmdial.de/api/index.php?action=exportbystatus\
&campaign_id=3000&status[]=SALE&datetype=last_edit\
&fromdate=01.10.2026&fromtime=00:00:00\
&selectedfields=customerfield_leadid_external,customerfield_company_name,customerfield_phone,webformfield_41_Tarif\
&encoding=UTF-8"

{"status":"ok","file_id":"6f1c0b9e4a2d8d31b7a05c9e3d8f7a21",
 "size":182344,
 "url":"http://login.mmdial.de/api/index.php?action=getfile&type=temp&file=6f1c0b9e4a2d8d31b7a05c9e3d8f7a21",
 "broken_data_count":0}

Die Datei holen Sie anschliessend unter dieser Adresse ab – wieder mit Ihrem Token, und bitte über https:

curl -H "Authorization: Bearer <TOKEN>" -o export.csv \
  "https://login.mmdial.de/api/index.php?action=getfile&type=temp&file=<file_id>"

Zur Datei

• Trennzeichen ;, Felder in ", Zeilenende CRLF.
• Die erste Zeile nennt die Feldnamen ohne den Vorsatz.
• Sortiert nach dem letzten Anruf, der älteste zuerst.
• customerfield_phone enthält die Ländervorwahl und die Rufnummer in einem Stück.
• Von den Auftragsformularfeldern steht der letzte gespeicherte Stand je Formular in der Datei.
• Ein grosser Export dauert; die Schnittstelle rechnet bis zu 100 Minuten daran und bricht nicht ab, wenn die Verbindung abreisst. Setzen Sie Ihre eigene Wartezeit entsprechend hoch.

getcampaignsGET

Nennt alle Kampagnen des Zugangs. Keine Parameter.

Antwort

{
  "campaigns": [
    { "id": "3000", "name": "Vertrieb Nord", "callerid": "4924194580649",
      "active": "Y", "ki_enabled": "Y" },
    { "id": "3500", "name": "Verkauf", "callerid": "4924194580649",
      "active": "N", "ki_enabled": "N" }
  ]
}

getcampaignGET

Die Angaben zu einer Kampagne.

Parameter

Antwort

{
  "status": "ok",
  "campaign": {
    "name": "Vertrieb Nord",
    "callerid": "4924194580649",
    "active": "Y",
    "ki_enabled": "Y",
    "dial_timeout": "30"
  }
}

Gibt es die Kampagne nicht, kommt {"status":"notfound"}. dial_timeout ist die Zeit in Sekunden, die der Dialer einen Anruf klingeln lässt.

editcampaignGETPOST

Ändert eine Kampagne. Geschrieben wird nur, was Sie mitschicken.

Parameter

Antwort

{ "status": "ok" }
{ "status": "notfound" }

getcampaignlivedataGET

Die laufenden Zahlen einer Kampagne – gedacht für eine eigene Anzeige neben der Oberfläche.

Parameter

Antwort

{
  "status": "ok",
  "data": {
    "dial_level": 2.5,
    "available_leads": "18342",
    "calls_today": "4211",
    "average_agents": "12",
    "drops": "38",
    "dropcount": "0.90",
    "dropcount_answers": 3.21,
    "campaign": "3000",
    "extrastats": {
      "calls_hour": "612", "answers_hour": "131",
      "drops_hour": "4", "drops_hour_pct": "0.65",
      "calls_halfhour": "...", "calls_fivemin": "...", "calls_onemin": "..."
    }
  }
}

Gibt es zu der Kampagne heute noch keine Zahlen, kommt {"status":"notfound"}. Die Werte stammen aus der laufenden Statistik des Dialers und werden im Minutentakt fortgeschrieben – fragen Sie nicht häufiger ab.

getcampaignstatsGET

Zwei Auswertungen über einen Zeitraum: die mittlere Wartezeit der Agenten und die Zeit je Status.

Parameter

Antwort

{ "waittimes": [ { "user": "1098-204", "length_in_sec": "18" },
                 { "user": "1098-207", "length_in_sec": "24" } ] }

{ "statustimes": [ { "Status": "PAUSE", "length_in_sec": "3120" },
                   { "Status": "READY", "length_in_sec": "8400" } ] }

Die Zeiten stehen in Sekunden, aufsteigend sortiert.

dncaddGET

Nimmt eine oder mehrere Rufnummern in die Sperrliste des Zugangs auf.

Parameter

Antwort

{
  "status": "ok",
  "numbers": [
    { "number": "24192789880",   "status": "ok" },
    { "number": "4924192789880", "status": "doublet" },
    { "number": "17012345678",   "status": "ok" }
  ]
}

Der äussere status fasst zusammen: ok, sobald mindestens eine Nummer neu eingetragen wurde, doublet, wenn alle schon dastanden, und error, wenn es einen echten Fehler gab. Bei einem Fehler bricht die Verarbeitung an dieser Stelle ab; message nennt die Position der Nummer (von 0 an gezählt), und in numbers sehen Sie, was bis dahin eingetragen wurde. Eine schon vorhandene Nummer ist kein Fehler und hält die Liste nicht auf.

Die Schreibweise der Nummer

Vor dem Eintragen wird die Nummer auf ihre Ziffern reduziert, und führende Nullen fallen weg: aus 0241 / 92789880 wird 24192789880, aus 0049 241 92789880 dagegen 4924192789880. Beides sind damit verschiedene Einträge.

Schicken Sie Nummern deshalb immer in derselben Form, in der auch Ihre Leads gespeichert sind – sonst steht die Nummer in der Sperrliste, ohne dass die Sperre beim Anruf greift. dnccheck nimmt dieselbe Umformung vor und zeigt Ihnen, was angekommen ist.

dncdelGET

Nimmt eine oder mehrere Rufnummern aus der Sperrliste heraus.

Parameter

Antwort

status ist ok oder error, bei error dazu message. ok heisst, dass der Auftrag ausgeführt wurde – auch dann, wenn die Nummer gar nicht in der Liste stand. Ob eine Nummer gesperrt ist, sagt dnccheck.

dncgetGET

Gibt die ganze Sperrliste des Zugangs aus. Keine Parameter.

Antwort

Klartext, eine Rufnummer je Zeile, Zeilenende CRLF. Kein JSON. Die Nummern stehen so da, wie sie eingetragen wurden – siehe die Schreibweise bei dncadd.

24192789880
4924192789880
17012345678
...

dnccheckGET

Sucht eine Rufnummer in der Sperrliste.

Parameter

Antwort

Ohne fuzzy:

{ "status": "exists" }      // die Nummer ist gesperrt
{ "status": "notfound" }    // sie ist es nicht

Mit fuzzy=yes antwortet die Aktion ohne status und nennt alle Treffer. Gesucht wird die Nummer selbst und jede kürzere Form davon bis hinunter zu sechs Stellen – so finden Sie auch eine gesperrte Vorwahl oder einen gesperrten Rufnummernblock:

{ "results": [ "241927", "24192789880" ] }

Eine leere results-Liste heisst: nichts gesperrt.

camp_dncadd, camp_dncdel, camp_dncget, camp_dnccheckGET

Neben der Sperrliste des ganzen Zugangs gibt es eine je Kampagne. Die vier Aktionen arbeiten genau wie dncadd, dncdel, dncget und dnccheck – mit demselben number, demselben reason, demselben fuzzy und denselben Antworten. Dazu kommt ein Parameter:

curl -H "Authorization: Bearer <TOKEN>" \
  "https://login.mmdial.de/api/index.php?action=camp_dncadd\
&campaignID=3000&number=024192789880&reason=Widerspruch+per+Mail"

getleadbyidGET

Liest einen Lead über seine Lead-Nummer.

Parameter

Antwort

In lead_data stehen die Feldnamen und zusätzlich:

{
  "status": "found",
  "lead_data": {
    "lead_id": "45611659",
    "title": "Frau",
    "phone": "4924192789880",
    "alt_phone": "",
    "first_name": "Erika",
    "last_name": "Mustermann",
    "street": "Theaterstr.",
    "streetnr": "70-74",
    "streetadd": "",
    "plz": "52062",
    "ort": "Aachen",
    "country": "DE",
    "notices": "",
    "company_name": "Musterfirma GmbH",
    "rotation": "no",
    "status": "SALE",
    "agentid": "1098-204",
    "listid": "202610181",
    "last_contact": "2026-10-20 11:32:07",
    "called_count": "2",
    "leadid_external": "A-55912"
  },
  "formdata": {
    "41": { "Kundennummer": "A-55912", "Tarif": "Komfort" },
    "42": { "Zaehlernummer": "12345" }
  }
}

Nicht gesetzte Felder kommen als leere Zeichenkette, nicht als null. Ihre eigenen Zusatzfelder stehen als xtra_<Name> mit in lead_data.

Wird der Lead in der laufenden Datenbank nicht gefunden, sucht die Aktion von selbst im Archiv weiter und setzt dann is_archived.

getleadbyphonenumberGET

Liest Leads über die Rufnummer. Dieselbe Nummer kann in mehreren Leads stehen, darum ist lead_data hier eine Liste.

Parameter

Antwort

{
  "status": "found",
  "lead_data": [
    { "lead_id": "45611659", "phone": "4924192789880", "...": "..." },
    { "lead_id": "39811204", "phone": "4924192789880", "...": "...",
      "archived": true }
  ],
  "formdata": [
    { "41": { "Kundennummer": "A-55912", "Tarif": "Komfort" } }
  ]
}

Die Felder je Eintrag sind dieselben wie bei getleadbyid, ohne called_count. Einträge aus dem Archiv tragen archived: true. Wird nichts gefunden, kommt {"status":"notfound"}.

Die Formulardaten stehen zweimal da. Einmal bei jedem Lead selbst, als formdata innerhalb seines Eintrags in lead_data – nur dort ist zu sehen, welcher Stand zu welchem Lead gehört. Und einmal, wie seit jeher, als flache Liste formdata neben lead_data. Finden Sie mehrere Leads, benutzen Sie die Angabe am Lead.

getleadbyexternalidGET

Liest Leads über Ihre eigene Lead-Nummer (leadid_external).

Parameter

Antwort

Wie bei getleadbyphonenumber: lead_data ist eine Liste, denn Ihre Nummer kann in mehreren Leads stehen – die Schnittstelle verlangt sie nicht als eindeutig.

getleadbyextrafieldGET

Liest Leads über eines Ihrer Zusatzfelder.

Parameter

Antwort

Wie bei getleadbyphonenumber: status und lead_data als Liste.

getleadbycustomdataGET

Die Suche mit mehreren Merkmalen zugleich. Alle Angaben, die Sie mitschicken, müssen zutreffen.

Parameter

Antwort

Wie bei getleadbyphonenumber. Schicken Sie gar kein Merkmal, kommt {"status":"noarguments"} – die Aktion gibt also nicht versehentlich alle Leads heraus.

curl -H "Authorization: Bearer <TOKEN>" \
  "https://login.mmdial.de/api/index.php?action=getleadbycustomdata\
&campaignID=3000&extra_fieldname=Vertragsnummer&extra_fieldvalue=V-4711"

addlistGET

Legt eine neue Liste in einer Kampagne an.

Parameter

Antwort

{ "status": "ok", "listid": "202610261" }

getlistsGET

Nennt die Listen – alle, oder die einer Kampagne.

Parameter

Antwort

{
  "lists": [
    { "listid": "202610261", "name": "Import 26.10.",
      "campaignID": "3000", "status": "inactive" }
  ]
}

status ist active oder inactive: aus einer abgeschalteten Liste wird nicht telefoniert.

editlistGETPOST

Ändert eine Liste – und schaltet sie ein. Das ist der Schritt nach addlist: eine neu angelegte Liste ist abgeschaltet.

Parameter

Antwort

{ "status": "ok" }
{ "status": "notfound" }

curl -H "Authorization: Bearer <TOKEN>" \
  "https://login.mmdial.de/api/index.php?action=editlist\
&listid=202610261&active=yes"

addleadPOST

Legt einen Lead an – einen je Aufruf. Die Prüfungen auf Doubletten und ungültige Nummern schalten Sie selbst zu.

Parameter

Antwort

{
  "lead_stats": {
    "success": 1,
    "error": 0,
    "sqlerror": 0,
    "formaterror": 0,
    "doubleterror": 0,
    "invaliderror": 0,
    "formaterror_types": []
  },
  "the_new_leadid": "45611660"
}

curl -H "Authorization: Bearer <TOKEN>" \
  -d "campaign_id=3000" -d "list_id=202610261" \
  -d "country_phone_code=49" \
  -d "doubletcheck_campaign=yes" \
  -d "leaddata[company_name]=Musterfirma GmbH" \
  -d "leaddata[first_name]=Erika" \
  -d "leaddata[last_name]=Mustermann" \
  -d "leaddata[phone]=024192789880" \
  -d "leaddata[plz]=52062" \
  -d "leaddata[ort]=Aachen" \
  -d "leaddata[leadid_external]=A-55912" \
  "https://login.mmdial.de/api/index.php?action=addlead"

editleadGETPOST

Ändert einen vorhandenen Lead. Geschrieben wird nur, was Sie mitschicken; alles andere bleibt, wie es ist.

Parameter

leaddata oder formfields muss dabei sein, sonst antwortet die Aktion mit einem Fehler.

Antwort

{ "status": "ok" }
{ "status": "error", "reason": "Fehlende Felder" }

Was dabei zu beachten ist

• Formulardaten werden nicht überschrieben. Jeder Aufruf mit formfields legt einen neuen Stand an; der alte bleibt in der Historie. Mitgeschickt werden sollten darum alle Felder des Formulars, nicht nur das geänderte – sonst stehen in dem neuen Stand nur diese.
• Leere Werte sind erlaubt. leaddata[phone]= löscht die Rufnummer. Ein Feld, das bleiben soll, lassen Sie einfach weg.
• rotation=yes stellt den Lead wieder auf telefonierbar, no nimmt ihn heraus.
• Ein archivierter Lead wird mitgeändert.
• Ändern Sie den status, können dadurch Benachrichtigungen ausgelöst werden, die für die Kampagne eingerichtet sind – genauso, wie wenn ein Agent den Status setzt.

curl -H "Authorization: Bearer <TOKEN>" \
  -d "leaddata[status]=SALE" \
  -d "leaddata[notices]=Vertrag liegt vor" \
  -d "formfields[webform_41_Tarif]=Komfort" \
  -d "formfields[webform_41_Kundennummer]=A-55912" \
  "https://login.mmdial.de/api/index.php?action=editlead\
&leadid=45611659&campaign_id=3000&GUID=41"

getcallbacksbyleadidGET

Nennt die Rückrufe zu einem Lead.

Parameter

Antwort

{
  "callbacks": [
    {
      "id": "88312",
      "user": "1098-204",
      "global_callback": false,
      "status": "aktiv",
      "created": "2026-10-20 11:35:02",
      "set_time": "2026-10-27 09:00:00",
      "campaign_id": "3000",
      "comments": "Ruft morgens besser an"
    }
  ]
}

Gibt es keinen, ist callbacks leer. Ein status dieser Aktion ist nicht dabei.

addcallbackGETPOST

Vereinbart einen Rückruf zu einem Lead.

Parameter

Antwort

{ "status": "ok" }
{ "status": "error" }

Was dabei geschieht

• Ein schon vorhandener aktiver Rückruf dieses Leads wird auf bearbeitet gesetzt – es gibt immer nur einen aktiven.
• Der Lead bekommt den Status CBHOLD. Damit ruft der Dialer ihn nicht weiter an, bis der Rückruf fällig ist.
• Der Vorgang wird im Verwaltungsprotokoll festgehalten.

curl -H "Authorization: Bearer <TOKEN>" \
  -d "callback=2026-10-27 09:00:00" \
  -d "user=1098-204" \
  -d "recipient=user" \
  -d "hinweise=Ruft morgens besser an" \
  "https://login.mmdial.de/api/index.php?action=addcallback&lead_id=45611659"