Set Contact Information

Les informations de contact peuvent être utilisées comme cible pour les communications via différents canaux, tels que les notifications App, les SMS, les e-mails et WhatsApp. Lorsque les informations de contact d'un utilisateur changent, cette API peut être utilisée pour les mettre à jour.

La définition des informations de contact doit être associée à l'EUID.

Adresse d'invocation

POST /v1/user/contact

Vérification de l'invocation

L'API REST EngageLab utilise l'authentification HTTP Basic comme méthode de vérification. Ajoutez Authorization dans l'en-tête HTTP :

Authorization: Basic ${base64_auth_string}

              
              Authorization: Basic ${base64_auth_string}

Afficher ce bloc de code dans la fenêtre flottante

Le base64_auth_string est généré selon l'algorithme suivant : base64(api_key:api_secret).

Le nom de l'en-tête est "Authorization" et la valeur est la paire "nom d'utilisateur:mot de passe" encodée en base64 (séparée par deux-points).
Pour l'API MA, le nom d'utilisateur correspond à l'APIKey et le mot de passe correspond à l'APISecret. Veuillez configurer une source de données de type API pour obtenir l'APIKey et l'APISecret.

Exemple de requête

En-tête de la requête

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

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

Afficher ce bloc de code dans la fenêtre flottante

Corps de la requête

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

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

Afficher ce bloc de code dans la fenêtre flottante

Paramètres de la requête

Champ	Type	Obligatoire	Description
euid	Long	Oui	L'identifiant unique
contacts	JSON	Oui	La clé est le nom de l'information de contact, et la valeur est la valeur de l'information de contact, toutes deux de type chaîne de caractères. Les informations de contact actuellement prises en charge incluent email, mobile_phone, landline_phone, whatsapp_phone

Paramètres de retour

Champ	Type	Obligatoire	Description
code	Int	Oui	Indique si l'appel API est un succès. 0 indique un succès ou un succès partiel, les autres valeurs représentent un échec.
message	String	Oui	Description du résultat de l'appel API, expliquant le code de retour.

Tout réussi

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

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

Afficher ce bloc de code dans la fenêtre flottante

Tout échoué

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

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

Afficher ce bloc de code dans la fenêtre flottante

Codes d'erreur

Code	Description	Explication détaillée
40050	Échec de l'authentification de l'interface.	Vérifiez si l'ID du projet et la clé secrète du projet sont corrects.
40007	EUID est vide.	Veuillez vérifier la valeur de l'EUID.
50031	ID du projet invalide.	Veuillez vérifier si l'APIKey et l'APISecret sont corrects.
50034	L'ID du projet n'existe pas.	Veuillez vérifier si l'APIKey et l'APISecret sont corrects, et si le projet n'a pas été supprimé.
50074	Source de données API inexistante.	Veuillez vérifier si l'APIKey et l'APISecret sont corrects, et si la source de données API n'a pas été supprimée.
55004	Paramètres métier invalides.	Veuillez vérifier si les champs des paramètres de la requête sont corrects.
55101	Le nombre d'identifiants utilisateur dépasse la limite.	Vérifiez si le nombre de valeurs d'identification utilisateur dépasse 100.
55102	Il existe des noms d'attributs utilisateur invalides.	Vérifiez si le nom de l'attribut respecte les exigences de nommage, et s'il n'est pas vide/n'utilise pas de caractères réservés/ne dépasse pas la limite de longueur.
55103	Les valeurs des attributs utilisateur ne peuvent pas être vides.	Vérifiez si la valeur de l'attribut utilisateur dans le corps de la requête est vide.
55105	La valeur de l'identifiant utilisateur ne peut pas dépasser 256 caractères.	Vérifiez si la valeur de l'identifiant utilisateur dépasse 256 caractères.
55106	Le nom de l'identifiant utilisateur n'est pas dans la plage prise en charge.	Vérifiez si le nom de l'identifiant utilisateur est user_id, anonymous_id ou registration_id.
55107	La valeur de l'identifiant utilisateur est vide.	Vérifiez si la valeur de l'identifiant utilisateur dans le corps de la requête est vide.
55108	EUID invalide.	Veuillez vérifier la valeur de l'EUID.
-1	Erreur interne du serveur.	Veuillez contacter le support technique EngageLab.