Créer un contact | LiveDesk API Français

Les développeurs peuvent créer des contacts via l’API.

Méthode de requête

POST

URL de requête

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

Authentification

Pour plus de détails, consultez les instructions d’authentification dans Présentation de l’API.

Requête

Exemple de requête

curl -X POST 'https://livedesk-api.engagelab.com/api/v2/accounts/contacts' \ -H 'Content-Type: application/json' \ -H 'Authorization: Basic base64(api_key:api_secret)' \ -d '{ "inbox_id": 407, "name": "Test", "email": "alice@acme.inc", "phone_number": "+123456789", "avatar_url": "https://example.com/avatar.png", "identifier": "1234567890" }'

              
              curl -X POST 'https://livedesk-api.engagelab.com/api/v2/accounts/contacts' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Basic base64(api_key:api_secret)' \
  -d '{
    "inbox_id": 407,
    "name": "Test",
    "email": "alice@acme.inc",
    "phone_number": "+123456789",
    "avatar_url": "https://example.com/avatar.png",
    "identifier": "1234567890"
  }'

Afficher ce bloc de code dans la fenêtre flottante

En-têtes de la requête

Champ	Type	Description
Authorization	string	Authentifiez-vous à l’aide de `Authorization: Basic base64(API Key:API Secret)`. Accédez à la page des clés API pour obtenir la clé API et le secret API, séparez-les par deux-points, puis encodez le résultat à l’aide de Base64.
Content-Type	application/json	Format des données. Utilisez `application/json` pour les messages texte classiques.

Paramètres du corps de la requête

Champ	Type	Obligatoire	Description
inbox_id	String	Oui	ID du canal. Correspond à l’ID du canal dans Paramètres du projet > Canaux > Canal spécifique > Paramètres.
name	String	Non	Nom du contact.
email	String	Non	Adresse e-mail.
phone_number	String	Non	Coordonnées du contact.
avatar_url	String	Non	Lien vers la pièce jointe.
identifier	String	Non	Identifiant utilisateur.

Réponse

Exemple de réponse

{ "payload": { "contact": { "additional_attributes": {}, "availability_status": "offline", "email": null, "id": 2219259, "name": "Test", "phone_number": null, "blocked": false, "identifier": null, "thumbnail": "", "custom_attributes": {}, "created_at": 1766571703, "contact_inboxes": [] }, "contact_inbox": { "inbox": null, "source_id": null } } }

              
              {
  "payload": {
    "contact": {
      "additional_attributes": {},
      "availability_status": "offline",
      "email": null,
      "id": 2219259,
      "name": "Test",
      "phone_number": null,
      "blocked": false,
      "identifier": null,
      "thumbnail": "",
      "custom_attributes": {},
      "created_at": 1766571703,
      "contact_inboxes": []
    },
    "contact_inbox": {
      "inbox": null,
      "source_id": null
    }
  }
}

Afficher ce bloc de code dans la fenêtre flottante

Paramètres de la réponse

Champ	Type	Obligatoire	Description
additional_attributes	Object	Non	Attributs supplémentaires.
availability_status	String	Non	Statut en ligne. La valeur par défaut est `offline`.
email	String	Non	Adresse e-mail.
id	String	Non	ID du contact.
name	String	Non	Nom.
phone_number	String	Non	Numéro de téléphone.
blocked	String	Non	Indique si le contact est bloqué. La valeur par défaut est `false`.
identifier	String	Non	Identifiant utilisateur.
thumbnail	String	Non	Identifiant utilisateur.
custom_attributes	String	Non	Attributs du client.
created_at	String	Non	Horodatage de création.
contact_inboxes	Array	Non	Identifiant utilisateur.
inbox	String	Non	Canal.
source_id	String	Non	ID de la source.