Rechercher des contacts

Les développeurs peuvent utiliser cette API pour interroger la liste des contacts du compte. Elle prend en charge les recherches par adresse e-mail du contact, phone_number, nom et identifiant.

Méthode de requête

GET

Point de terminaison

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 Vue d'ensemble de l'API.

Requête

Exemple de requête

curl -X GET https://livedesk-api.engagelab.com/api/v2/accounts/contacts?q=support@engagelab.com \ -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?q=support@engagelab.com \
-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

Field	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, puis joignez-les avec un deux-points avant de les encoder en Base64.
Content-Type	application/json	Type de données. Utilisez `application/json` pour les messages en texte brut.

Paramètres de requête

Field	Type	Required	Description
q	string	No	Paramètre de requête. Les champs de contact pris en charge incluent `email`, `phone_number`, `name` et `identifier`.
page	integer	No	Numéro de page. La valeur par défaut est `1`, avec `15` éléments par page.
labels	string / string[]	No	Filtrage par libellés. Plusieurs libellés sont pris en charge et correspondent selon une condition de correspondance quelconque.
include_contact_inboxes	boolean	No	Indique s'il faut renvoyer `contact_inboxes`. La valeur par défaut est `true`.
sort	string	No	Champ de tri. Valeurs possibles : `email`, `name`, `phone_number`, `last_activity_at`, `created_at`, `company`, `city`, `country`.
direction	string	No	Ordre de tri : `asc` ou `desc`.

Exemple de réponse

{ "meta": { "count": 1, "current_page": 1 }, "payload": [ { "additional_attributes": { "source_id": "email:ed5c8362-425c-4589-8adb-61a033d8c5fb.support@engagelab.com" }, "availability_status": "offline", "email": "support@engagelab.com", "id": 64464046, "name": "support", "phone_number": null, "blocked": false, "identifier": null, "thumbnail": "", "custom_attributes": {}, "last_activity_at": 1778572024, "created_at": 1778570103, "contact_inboxes": [ { "source_id": "support@engagelab.com", "inbox": { "id": 985, "channel_id": 107, "name": "Email", "channel_type": "Channel::Email", "provider": null } } ] } ] }

              
              {
    "meta": {
        "count": 1,
        "current_page": 1
    },
    "payload": [
        {
            "additional_attributes": {
                "source_id": "email:ed5c8362-425c-4589-8adb-61a033d8c5fb.support@engagelab.com"
            },
            "availability_status": "offline",
            "email": "support@engagelab.com",
            "id": 64464046,
            "name": "support",
            "phone_number": null,
            "blocked": false,
            "identifier": null,
            "thumbnail": "",
            "custom_attributes": {},
            "last_activity_at": 1778572024,
            "created_at": 1778570103,
            "contact_inboxes": [
                {
                    "source_id": "support@engagelab.com",
                    "inbox": {
                        "id": 985,
                        "channel_id": 107,
                        "name": "Email",
                        "channel_type": "Channel::Email",
                        "provider": null
                    }
                }
            ]
        }
    ]
}

Afficher ce bloc de code dans la fenêtre flottante

Paramètres de réponse

Field	Type	Required	Description
count	Int	No	Nombre de résultats de la requête.
current_page	Int	No	Numéro de page des résultats de la requête.
payload	Object	No	Structure de la charge utile.
additional_attributes	Object	No	Attributs supplémentaires.
availability_status	String	No	Statut de disponibilité. La valeur par défaut est `offline`.
email	String	No	Adresse e-mail.
id	String	No	ID du contact.
name	String	No	Nom.
phone_number	String	No	Numéro de téléphone mobile.
blocked	String	No	Indique si le contact est bloqué. La valeur par défaut est `false`.
identifier	String	No	Identifiant externe unique du contact, correspondant à l'UserID affiché dans l'interface.
thumbnail	String	No	URL de l'avatar.
custom_attributes	String	No	Attributs du contact.
created_at	String	No	Horodatage de création.
last_activity_at	String	No	Horodatage de la dernière mise à jour.
contact_inboxes	Array	No	Informations sur les canaux associés. Renvoyées uniquement lorsque `include_contact_inboxes=true`.
source_id	String	No	ID du canal.
inbox	Object	No	Informations sur le canal.
id	String	No	ID du canal.
name	String	No	Nom du canal.
channel_type	String	No	Type de canal.
provider	String	No	Fournisseur. Par exemple, si le canal est WhatsApp, la valeur correspondante est `whatsapp_cloud`, `engagelab_whatsapp` ou `twilio`. Pour les canaux qui ne distinguent pas les fournisseurs, la valeur est `null`.