Kontakte suchen

Entwickler können diese API verwenden, um die Kontaktliste des Kontos abzufragen. Sie unterstützt die Suche nach Kontakt-E-Mail, phone_number, Name und Kennung.

Anfragemethode

GET

Endpoint

https://livedesk-api.engagelab.com/api/v2/accounts/contacts

Authentifizierung

Weitere Informationen finden Sie in der Beschreibung der Authentifizierungsmethode unter API-Übersicht.

Anfrage

Anfragebeispiel

curl -X GET https://livedesk-api.engagelab.com/api/v2/accounts/contacts?q=support@engagelab.com \ -H 'Content-Type: application/json' \ -H 'Authorization: Basic base64(api_key:api_secret)'

              
              curl -X GET https://livedesk-api.engagelab.com/api/v2/accounts/contacts?q=support@engagelab.com \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic base64(api_key:api_secret)'

Diesen Codeblock im schwebenden Fenster anzeigen

Anfrage-Header

Field	Type	Description
Authorization	string	Verwenden Sie `Authorization: Basic base64(API Key:API Secret)` zur Authentifizierung. Rufen Sie die API-Key-Seite auf, um den API Key und das API Secret zu erhalten, fügen Sie diese dann mit einem Doppelpunkt zusammen und kodieren Sie sie anschließend in Base64.
Content-Type	application/json	Datentyp. Verwenden Sie `application/json` für Klartextnachrichten.

Query-Parameter

Field	Type	Required	Description
q	string	No	Abfrageparameter. Unterstützte Kontaktfelder sind `email`, `phone_number`, `name` und `identifier`.
page	integer	No	Seitennummer. Der Standardwert ist `1`, mit `15` Einträgen pro Seite.
labels	string / string[]	No	Nach Labels filtern. Mehrere Labels werden unterstützt und mit einer Beliebig-Übereinstimmung-Bedingung abgeglichen.
include_contact_inboxes	boolean	No	Gibt an, ob `contact_inboxes` zurückgegeben werden soll. Der Standardwert ist `true`.
sort	string	No	Sortierfeld. Mögliche Werte: `email`, `name`, `phone_number`, `last_activity_at`, `created_at`, `company`, `city`, `country`.
direction	string	No	Sortierrichtung: `asc` oder `desc`.

Antwortbeispiel

{ "meta": { "count": 1, "current_page": 1 }, "payload": [ { "additional_attributes": { "source_id": "email:ed5c8362-425c-4589-8adb-61a033d8c5fb.support@engagelab.com" }, "availability_status": "offline", "email": "support@engagelab.com", "id": 64464046, "name": "support", "phone_number": null, "blocked": false, "identifier": null, "thumbnail": "", "custom_attributes": {}, "last_activity_at": 1778572024, "created_at": 1778570103, "contact_inboxes": [ { "source_id": "support@engagelab.com", "inbox": { "id": 985, "channel_id": 107, "name": "Email", "channel_type": "Channel::Email", "provider": null } } ] } ] }

              
              {
    "meta": {
        "count": 1,
        "current_page": 1
    },
    "payload": [
        {
            "additional_attributes": {
                "source_id": "email:ed5c8362-425c-4589-8adb-61a033d8c5fb.support@engagelab.com"
            },
            "availability_status": "offline",
            "email": "support@engagelab.com",
            "id": 64464046,
            "name": "support",
            "phone_number": null,
            "blocked": false,
            "identifier": null,
            "thumbnail": "",
            "custom_attributes": {},
            "last_activity_at": 1778572024,
            "created_at": 1778570103,
            "contact_inboxes": [
                {
                    "source_id": "support@engagelab.com",
                    "inbox": {
                        "id": 985,
                        "channel_id": 107,
                        "name": "Email",
                        "channel_type": "Channel::Email",
                        "provider": null
                    }
                }
            ]
        }
    ]
}

Diesen Codeblock im schwebenden Fenster anzeigen

Antwortparameter

Field	Type	Required	Description
count	Int	No	Anzahl der Abfrageergebnisse.
current_page	Int	No	Seitennummer der Abfrageergebnisse.
payload	Object	No	Payload-Struktur.
additional_attributes	Object	No	Zusätzliche Attribute.
availability_status	String	No	Online-Status. Der Standardwert ist `offline`.
email	String	No	E-Mail-Adresse.
id	String	No	Kontakt-ID.
name	String	No	Name.
phone_number	String	No	Mobiltelefonnummer.
blocked	String	No	Gibt an, ob der Kontakt blockiert ist. Der Standardwert ist `false`.
identifier	String	No	Externe eindeutige Kennung des Kontakts, entsprechend der in der Benutzeroberfläche angezeigten UserID.
thumbnail	String	No	Avatar-URL.
custom_attributes	String	No	Kontaktattribute.
created_at	String	No	Zeitstempel der Erstellung.
last_activity_at	String	No	Zeitstempel der letzten Aktualisierung.
contact_inboxes	Array	No	Zugehörige Kanalinformationen. Wird nur zurückgegeben, wenn `include_contact_inboxes=true`.
source_id	String	No	Kanal-ID.
inbox	Object	No	Kanalinformationen.
id	String	No	Kanal-ID.
name	String	No	Kanalname.
channel_type	String	No	Kanaltyp.
provider	String	No	Anbieter. Wenn der Kanal beispielsweise WhatsApp ist, lautet der entsprechende Wert `whatsapp_cloud`, `engagelab_whatsapp` oder `twilio`. Bei Kanälen, bei denen keine Anbieter unterschieden werden, ist der Wert `null`.