Set Contact Information

Kontaktinformationen können als Ziel für Kanal-Kommunikationen wie App-Benachrichtigungen, SMS, E-Mails und WhatsApp verwendet werden. Wenn sich die Kontaktinformationen eines Nutzers oder einer Nutzerin ändern, kann diese API genutzt werden, um sie zu aktualisieren. Das Festlegen von Kontaktinformationen muss mit der EUID verknüpft werden.

Aufrufadresse

POST /v1/user/contact

Authentifizierung des Aufrufs

Die EngageLab REST API verwendet HTTP Basic Authentication zur Authentifizierung. Fügen Sie dem HTTP-Header die Autorisierung hinzu:

Authorization: Basic ${base64_auth_string}

              
              Authorization: Basic ${base64_auth_string}

Diesen Codeblock im schwebenden Fenster anzeigen

Der base64_auth_string wird nach folgendem Schema generiert: base64(api_key:api_secret).

Der Header-Name ist „Authorization“, und der Wert ist das base64-codierte „Benutzername:Passwort“-Paar (Benutzername und Passwort durch Doppelpunkt getrennt).
Für die MA API entspricht der Benutzername dem APIKey und das Passwort dem APISecret. Bitte konfigurieren Sie eine API-Datenquelle, um APIKey und APISecret zu erhalten.

Beispiel für eine Anfrage

Anfrage-Header

> POST /v1/user/contact > Content-Type: application/json > Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==

              
              > POST /v1/user/contact
> Content-Type: application/json
> Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==

Diesen Codeblock im schwebenden Fenster anzeigen

Anfrage-Body

{ "euid":10362473, "contacts":{ "mobile_phone": "18023456879", "email": "12@gmail.com" } }

              
              {
    "euid":10362473,
    "contacts":{
        "mobile_phone": "18023456879",
        "email": "12@gmail.com"
    }
}

Diesen Codeblock im schwebenden Fenster anzeigen

Anfrageparameter

Feld	Typ	Erforderlich	Beschreibung
euid	Long	Ja	Die eindeutige Benutzer-ID
contacts	JSON	Ja	Der Schlüssel gibt die Art der Kontaktinformation an, der Wert enthält die entsprechende Information. Beide sind vom Datentyp String. Aktuell unterstützte Kontaktinformationen sind: email, mobile_phone, landline_phone, whatsapp_phone

Rückgabeparameter

Feld	Typ	Erforderlich	Beschreibung
code	Int	Ja	Gibt an, ob der API-Aufruf erfolgreich war. 0 steht für Erfolg oder Teilerfolg, andere Werte stehen für Fehler.
message	String	Ja	Ergebnisbeschreibung des API-Aufrufs, erläutert den Rückgabecode.

Vollständig erfolgreich

{ "code": 0, "message": "success" }

              
              {
    "code": 0,
    "message": "success"
}

Diesen Codeblock im schwebenden Fenster anzeigen

Vollständig fehlgeschlagen

{ "code": 0, "message": "success" }

              
              {
    "code": 0,
    "message": "success"
}

Diesen Codeblock im schwebenden Fenster anzeigen

Fehlercodes

Code	Beschreibung	Detaillierte Erklärung
40050	Schnittstellen-Authentifizierung fehlgeschlagen.	Prüfen Sie, ob die Projekt-ID und der Projektschlüssel korrekt sind.
40007	EUID ist leer.	Bitte überprüfen Sie den Wert der EUID.
50031	Projekt-ID ist ungültig.	Bitte prüfen Sie, ob APIKey und APISecret korrekt sind.
50034	Projekt-ID existiert nicht.	Bitte prüfen Sie, ob APIKey und APISecret korrekt sind und ob das Projekt gelöscht wurde.
50074	API-Datenquelle existiert nicht.	Bitte prüfen Sie, ob APIKey und APISecret korrekt sind und ob die API-Datenquelle gelöscht wurde.
55004	Geschäftliche Parameter sind ungültig.	Bitte prüfen Sie, ob die Felder der Anfrage korrekt ausgefüllt sind.
55101	Die Anzahl der Nutzeridentifikatoren überschreitet das Limit.	Prüfen Sie, ob die Anzahl der Nutzeridentifikatoren 100 überschreitet.
55102	Es gibt ungültige Benennungen für Nutzerattribute.	Prüfen Sie, ob der Attributname den Namensanforderungen entspricht und ob er leer ist/Reservierte Zeichen verwendet/das Längenlimit überschreitet.
55103	Nutzerattributwerte dürfen nicht leer sein.	Prüfen Sie, ob der Wert des Nutzerattributs im Anfrage-Body leer ist.
55105	Der Wert des Nutzeridentifikators darf 256 Zeichen nicht überschreiten.	Prüfen Sie, ob der Wert des Nutzeridentifikators 256 Zeichen überschreitet.
55106	Der Name des Nutzeridentifikators liegt nicht im unterstützten Bereich.	Prüfen Sie, ob der Name des Nutzeridentifikators user_id, anonymous_id oder registration_id ist.
55107	Der Wert des Nutzeridentifikators ist leer.	Prüfen Sie, ob der Wert des Nutzeridentifikators im Anfrage-Body leer ist.
55108	Ungültige EUID.	Bitte überprüfen Sie den Wert der EUID.
-1	Interner Serverfehler.	Bitte kontaktieren Sie den technischen Support von EngageLab.

Tipp: Nutzen Sie diese API, um effizient Kontaktinformationen zu aktualisieren und Ihre Benutzerdaten stets aktuell zu halten. Weitere Informationen zur REST API Authentifizierung finden Sie in der Dokumentation.