Obtenir la liste des contacts | LiveDesk API Contact Français

Les développeurs peuvent utiliser cette API pour récupérer la liste des contacts associés à un compte LiveDesk.

Méthode de requête

GET

Endpoint

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 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)'

Afficher ce bloc de code dans la fenêtre flottante

En-têtes de 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 l’API Key et l’API Secret, reliez-les à l’aide de deux-points, puis encodez-les au format Base64.
Content-Type	application/json	Type de données. Utilisez `application/json` pour les messages texte classiques.

Paramètres de requête

Champ	Type	Obligatoire	Description
page	integer	Non	Numéro de page. La valeur par défaut est 1, avec 15 éléments par page.
labels	string / string[]	Non	Filtrer par libellés. Plusieurs libellés sont pris en charge ; les contacts correspondant à au moins un libellé sont renvoyés.
include_contact_inboxes	boolean	Non	Indique s’il faut renvoyer `contact_inboxes`. La valeur par défaut est `true`.
sort	string	Non	Champ de tri. Valeurs disponibles : `email`, `name`, `phone_number`, `last_activity_at`, `created_at`, `company`, `city` et `country`.
direction	string	Non	Sens du tri : `asc` ou `desc`.

Réponse en cas de succès

Exemple de réponse

{ "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": [ { "source_id": "src_001", "inbox": { "id": 10, "name": "Canal du service client", "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": [
        {
          "source_id": "src_001",
          "inbox": {
            "id": 10,
            "name": "Canal du service client",
            "channel_type": "Channel::Api"
          }
        }
      ]
    }
  ]
}

Afficher ce bloc de code dans la fenêtre flottante

contact_inboxes est renvoyé lorsque include_contact_inboxes=true.

Paramètres de réponse

Champ	Type	Obligatoire	Description
meta	Object	Non	Objet de métadonnées.
count	Integer	Non	Nombre de résultats de la requête.
current_page	Integer	Non	Numéro de la page correspondant aux résultats de la requête actuelle.
payload	Object	Non	Attributs du contact.
additional_attributes	Object	Non	Attributs supplémentaires.
availability_status	String	Non	Statut de disponibilité. La valeur par défaut est `offline`.
email	String	Non	Adresse e-mail.
id	Integer	Non	ID du contact.
name	String	Non	Nom.
phone_number	String	Non	Numéro de téléphone.
blocked	Boolean	Non	Indique si le contact est bloqué. La valeur par défaut est `false`.
identifier	String	Non	Identifiant de l’utilisateur.
thumbnail	String	Non	Miniature de l’utilisateur.
custom_attributes	Object	Non	Attributs personnalisés.
created_at	String	Non	Horodatage de création du contact.
last_activity_at	String	Non	Horodatage de la dernière activité.
contact_inboxes	Array	Non	Informations sur les canaux du contact, renvoyées uniquement lorsque `include_contact_inboxes=true`.
source_id	String	Non	ID de la source.
inbox	Object	Non	Informations sur la boîte de réception.
id	Integer	Non	ID de la boîte de réception.
name	String	Non	Nom de la boîte de réception.
channel_type	String	Non	Type de canal.

Réponse d’erreur

Paramètres de réponse

Code d’état HTTP	Description
401	Non autorisé. Le jeton est invalide ou manquant.
403	Autorisations insuffisantes.