Liste des contacts

Les développeurs peuvent consulter la liste des contacts du compte via l'API.

Méthode de requête

GET

URL de requête

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

Authentification

Pour plus de détails, consultez la description de la méthode d'authentification dans la 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	Utilisez `Authorization: Basic base64(API Key:API Secret)` pour l'authentification. Accédez à la page API Key pour obtenir l'API Key et l'API Secret, reliez-les avec un deux-points, puis encodez le résultat en Base64.
Content-Type	application/json	Il s'agit du format de données de la requête. Utilisez `application/json`.

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	Filtre par étiquettes. Plusieurs étiquettes sont prises en charge et une seule correspondance suffit.
include_contact_inboxes	boolean	Non	Indique si `contact_inboxes` doit être renvoyé. La valeur par défaut est `true`.
sort	string	Non	Champ de tri. Valeurs possibles : `email`, `name`, `phone_number`, `last_activity_at`, `created_at`, `company`, `city`, `country`
direction	string	Non	Sens du tri, `asc` ou `desc`.

Réponse réussie

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": [ // Renvoyé lorsque include_contact_inboxes=true { "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": [           // Renvoyé lorsque include_contact_inboxes=true
             {
              "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

Paramètres de réponse

Champ	Type	Obligatoire	Description
meta	Object	Non	Objet de métadonnées.
count	Int	Non	Nombre de résultats de la requête.
current_page	Int	Non	Numéro de la page courante des résultats.
payload	Object	Non	Informations sur les attributs.
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	Miniature.
custom_attributes	Object	Non	Attributs personnalisés.
created_at	String	Non	Horodatage de création.
last_activity_at	String	Non	Horodatage de la dernière activité.
created_at	String	Non	Horodatage de création de ce contact.
contact_inboxes	array	Informations sur les canaux associés, renvoyées uniquement lorsque `include_contact_inboxes=true`.
source_id	String	Non	ID de 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 de statut HTTP	Description
401	Non autorisé. Le jeton est invalide ou absent.
403	Permissions insuffisantes.