Gibt eine Liste aller Kontakte (Kunden, Mitarbeiter, Leads, Benutzer) mit Telefonnummern her
Parameter
- search (optional) - Suchzeile. Die Suche wird durchgeführt nach:
- Namen und Telefonnummern von Kunden, Leads, Mitarbeitern und Benutzern
- Interne PBX-Nummern der Benutzer
- take (zur Paginierung) - wie viele Kontakte hergegeben werden sollen (Standard ist 20)
- skip (zur Paginierung) - wie viele Kontakte übersprungen werden sollen (Standard 0)
Antwort
(Antwort 1)
Antwort 1:
{
"totalCount": 128,
"contacts": [
{
"contact_type": "customer",
},
{
"contact_type": "employee",
},
{
"contact_type": "lead",
},
{
"contact_type": "user",
}
]
}
wo
- totalCount — Gesamtzahl der Kontakte (einschließlich Suchzeile)
- contacts — Gruppe von Kontakten. Jeder der Kontakte verfügt je nach Art (Kunde, Mitarbeiter, Lead, Benutzer) über eigene Attribute.
Kunde
(Antwort 2)
Antwort 2:
{
"contact_type": "customer",
"id": 3486,
"name": "Good Company",
"status": "company",
"type": "client",
"phone": {
"phone": "+44123456789",
"type": "work"
},
"responsible": {
"id": 234,
"name": "John Beam",
"ext_num": "100"
}
}
wo
- contact_type — Art des Kontakts:
- id — KundenID
- name — Kundenname
- status — Kundenstatus. Mögliche Werte:
- individual — Privatkunde
- company — Firmenkunde
- type — Art des Kunden. Mögliche Werte:
- potential — Potenzieller Kunde
- client — Kunde
- reseller — Wiederverkäufer
- partner — Partner
- phone — Telefonnummer. Enthält folgende Felder:
- phone — Telefonnummer
- type — Art der Nummer. Mögliche Werte:
- work — Arbeit
- personal — Privat
- responsible — Verantwortlicher Benutzer. Enthält folgende Felder:
- id — Benutzer ID
- name — Benutzername
- ext_num — Interne PBX Nummer des Benutzers
Kundenmitarbeiter
(Antwort 3)
Antwort 3:
{
"contact_type": "employee",
"id": 8,
"name": "Michael Simpson",
"phone": {
"phone": "+44123456789",
"type": "work"
},
"position": {
"position": "manager",
"title": ""
},
"customer": {
"id": 3486,
"name": "Good Company"
},
"responsible": {
"id": 234,
"name": "John Beam",
"ext_num": "100"
}
}
wo
- contact_type — Art des Kontakts.
- id — Mitarbeiter ID
- name — Mitarbeitername
- phone — Telefonnummer. Enthält folgende Felder:
- phone — Telefonnummer
- type — Art der Nummer. Mögliche Werte:
- work — Arbeit
- personal — Privat
- position — Mitarbeiterposition. Enthält folgende Felder:
- position — Position. Mögliche Werte:
- ceo — Hauptgeschäftsführer
- director — Geschäftsführer
- manager — Manager
- sales_manager — Salesmanager
- hr — HR
- support — Support
- custom — Beliebig
- title — Name der beliebigen Position (für position = custom)
- customer — Kunde, mit dem der Mitarbeiter verknüpft ist. Enthält folgende Felder:
- id — Kunden ID
- name — Kundenname
- responsible — Benutzer, der für den übergeordneten Kunde verantwortlich ist. Enthält folgende Felder:
- id — Benutzer ID
- name — Benutzername
- ext_num — Interne PBX Nummer des Benutzers
Lead
(Antwort 4)
Antwort 4:
{
"contact_type": "lead",
"id": 3486,
"name": "Good Company",
"phone": {
"phone": "+44123456789",
"type": "work"
},
"responsible": {
"id": 234,
"name": "John Beam",
"ext_num": "100"
}
}
wo
- contact_type — Art des Kontakts:
- id — Lead ID
- name — Lead Name
- phone — Telefonnummer. Enthält folgende Felder:
- phone — Telefonnummer
- type — Art der Nummer. Mögliche Werte:
- work — Arbeit
- personal — Privat
- responsible — Verantwortlicher Benutzer. Enthält folgende Felder:
- id — Benutzer ID
- name — Benutzername
- ext_num — nterne PBX Nummer des Benutzers
Benutzer
(Antwort 5)
Antwort 5:
{
"contact_type": "user",
"id": 234,
"name": "John Beam",
"avatar": 2457,
"role": "",
"status": "",
"phone": {
"phone": "100",
"type": "internal"
},
"group": {
"type": "admin",
"title": ""
}
}
wo
- contact_type — Art des Kontakts:
- id — Benutzer ID
- name — Benutzername
- avatar — Benutzer-Avatar (Datei ID)
- role — Benutzer-Rolle
- status — Benutzerstatus
- phone — Telefonnummer. Enthält folgende Felder:
- phone — Telefonnummer
- type — Art der Nummer. Mögliche Werte:
- work — Arbeit
- personal — Privat
- internal — Interne PBX Nummer
- group — Benutzergruppe. Enthält folgende Felder:
- type — Art der Gruppe. Mögliche Werte:
- admin — Administratoren
- manager — Managers
- chat_operator — Fachkräfte
- trainee — Praktikanten
- custom — Benutzerdefiniert
- title — Name der Benutzergruppe (für Typ = Benutzerdefiniert)