Kontaktliste

Entwickler können über die API die Kontaktliste des Kontos abfragen.

Anfragemethode

GET

Anfrage-URL

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

Authentifizierung

Einzelheiten zur Authentifizierung finden Sie in der API-Übersicht.

Anfrage

Anfragebeispiel

curl -X GET https://livedesk-api.engagelab.com/api/v2/accounts/contacts?include_contact_inboxes=false&page=1&sort=last_activity_at&page_size=10 \ -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?include_contact_inboxes=false&page=1&sort=last_activity_at&page_size=10 \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic base64(api_key:api_secret)' \

Diesen Codeblock im schwebenden Fenster anzeigen

Anfrage-Header

Feld	Typ	Beschreibung
Authorization	string	Verwenden Sie `Authorization: Basic base64(API Key:API Secret)` zur Authentifizierung. Rufen Sie API Key und API Secret auf der API-Key-Seite ab, verbinden Sie beide mit einem Doppelpunkt und kodieren Sie sie anschließend mit Base64.
Content-Type	application/json	Dies ist das Datenformat der Anfrage. Verwenden Sie `application/json`.

Query-Parameter

Feld	Typ	Erforderlich	Beschreibung
page	integer	Nein	Seitennummer. Standard ist 1, pro Seite werden 15 Einträge zurückgegeben.
labels	string / string[]	Nein	Filterung nach Labels. Mehrere Labels werden unterstützt, wobei eine Übereinstimmung genügt.
include_contact_inboxes	boolean	Nein	Gibt an, ob `contact_inboxes` zurückgegeben werden soll. Standard ist `true`.
sort	string	Nein	Sortierfeld. Mögliche Werte: `email`, `name`, `phone_number`, `last_activity_at`, `created_at`, `company`, `city`, `country`
direction	string	Nein	Sortierreihenfolge. `asc` oder `desc`.

Erfolgreiche Antwort

Antwortbeispiel

{ "meta": { "count": 1, "current_page": "1" }, "payload": [ { "additional_attributes": { "city": "", "country": "", "telegram": "", "description": "", "company_name": "", "country_code": "", "social_profiles": { "github": "", "twitter": "", "facebook": "", "linkedin": "", "instagram": "" } }, "availability_status": "offline", "email": "support@jiguang.cn", "id": 318763, "name": "support", "phone_number": null, "blocked": false, "identifier": "4444", "thumbnail": "", "custom_attributes": {}, "last_activity_at": 1765441908, "created_at": 1765441895, "contact_inboxes": [ // Wird zurückgegeben, wenn include_contact_inboxes=true { "source_id": "src_001", "inbox": { "id": 10, "name": "Kundendienstkanal", "channel_type": "Channel::Api" } } ] } ] }

              
              {
    "meta": {
        "count": 1,
        "current_page": "1"
    },
    "payload": [
        {
            "additional_attributes": {
                "city": "",
                "country": "",
                "telegram": "",
                "description": "",
                "company_name": "",
                "country_code": "",
                "social_profiles": {
                    "github": "",
                    "twitter": "",
                    "facebook": "",
                    "linkedin": "",
                    "instagram": ""
                }
            },
            "availability_status": "offline",
            "email": "support@jiguang.cn",
            "id": 318763,
            "name": "support",
            "phone_number": null,
            "blocked": false,
            "identifier": "4444",
            "thumbnail": "",
            "custom_attributes": {},
            "last_activity_at": 1765441908,
            "created_at": 1765441895,
            "contact_inboxes": [           // Wird zurückgegeben, wenn include_contact_inboxes=true
             {
              "source_id": "src_001",
              "inbox": 
              {
               "id": 10,
              "name": "Kundendienstkanal",
              "channel_type": "Channel::Api"
              }
             }
          ]
        }
    ]
}

Diesen Codeblock im schwebenden Fenster anzeigen

Antwortparameter

Feld	Typ	Erforderlich	Beschreibung
meta	Object	Nein	Metadatenobjekt.
count	Int	Nein	Anzahl der Suchergebnisse.
current_page	Int	Nein	Aktuelle Seitennummer der Suchergebnisse.
payload	Object	Nein	Attributinformationen.
additional_attributes	Object	Nein	Zusätzliche Attribute.
availability_status	String	Nein	Online-Status. Standard ist `offline`.
email	String	Nein	E-Mail-Adresse.
id	String	Nein	Kontakt-ID.
name	String	Nein	Name.
phone_number	String	Nein	Telefonnummer.
blocked	String	Nein	Gibt an, ob blockiert. Standard ist `false`.
identifier	String	Nein	Benutzerkennung.
thumbnail	String	Nein	Miniaturbild.
custom_attributes	Object	Nein	Benutzerdefinierte Attribute.
created_at	String	Nein	Erstellungszeitstempel.
last_activity_at	String	Nein	Zeitstempel der letzten Aktivität.
created_at	String	Nein	Zeitstempel, zu dem dieser Kontakt erstellt wurde.
contact_inboxes	array	Zugehörige Kanalinformationen; werden nur zurückgegeben, wenn `include_contact_inboxes=true`.
source_id	String	Nein	Quell-ID.
inbox	Object	Nein	Informationen zum Posteingang.
id	Integer	Nein	ID des Posteingangs.
name	String	Nein	Name des Posteingangs.
channel_type	String	Nein	Kanaltyp.

Fehlerantwort

Antwortparameter

HTTP-Statuscode	Beschreibung
401	Nicht autorisiert. Das Token ist ungültig oder fehlt.
403	Unzureichende Berechtigungen.