Buscar contactos

Los desarrolladores pueden usar esta API para consultar la lista de contactos de la cuenta. Admite búsquedas por el correo electrónico del contacto, phone_number, nombre e identificador.

Método de solicitud

GET

Endpoint

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

Autenticación

Para obtener más información, consulta la descripción del método de autenticación en Información general de la API.

Solicitud

Ejemplo de solicitud

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

Este bloque de código se muestra en una ventana flotante

Encabezados de la solicitud

Field	Type	Description
Authorization	string	Usa `Authorization: Basic base64(API Key:API Secret)` para la autenticación. Ve a la página de API Key para obtener la API Key y la API Secret; después, únelas con dos puntos y codifícalas en Base64.
Content-Type	application/json	Tipo de datos. Usa `application/json` para mensajes de texto sin formato.

Parámetros de consulta

Field	Type	Required	Description
q	string	No	Parámetro de consulta. Los campos de contacto admitidos incluyen `email`, `phone_number`, `name` e `identifier`.
page	integer	No	Número de página. El valor predeterminado es `1`, con `15` elementos por página.
labels	string / string[]	No	Filtra por etiquetas. Se admiten varias etiquetas y se comparan mediante una condición de coincidencia con cualquiera de ellas.
include_contact_inboxes	boolean	No	Indica si se deben devolver los `contact_inboxes`. El valor predeterminado es `true`.
sort	string	No	Campo de ordenación. Valores opcionales: `email`, `name`, `phone_number`, `last_activity_at`, `created_at`, `company`, `city`, `country`.
direction	string	No	Dirección de ordenación: `asc` o `desc`.

Ejemplo de respuesta

{ "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
                    }
                }
            ]
        }
    ]
}

Este bloque de código se muestra en una ventana flotante

Parámetros de respuesta

Field	Type	Required	Description
count	Int	No	Número de resultados de la consulta.
current_page	Int	No	Número de página de los resultados de la consulta.
payload	Object	No	Estructura de la carga útil.
additional_attributes	Object	No	Atributos adicionales.
availability_status	String	No	Estado de disponibilidad. El valor predeterminado es `offline`.
email	String	No	Dirección de correo electrónico.
id	String	No	ID del contacto.
name	String	No	Nombre.
phone_number	String	No	Número de teléfono móvil.
blocked	String	No	Indica si el contacto está bloqueado. El valor predeterminado es `false`.
identifier	String	No	Identificador único externo del contacto, correspondiente al UserID mostrado en la interfaz.
thumbnail	String	No	URL del avatar.
custom_attributes	String	No	Atributos personalizados del contacto.
created_at	String	No	Marca de tiempo de creación.
last_activity_at	String	No	Marca de tiempo de la actualización más reciente.
contact_inboxes	Array	No	Información del canal asociado. Solo se devuelve cuando `include_contact_inboxes=true`.
source_id	String	No	ID del canal.
inbox	Object	No	Información del canal.
id	String	No	ID del canal.
name	String	No	Nombre del canal.
channel_type	String	No	Tipo de canal.
provider	String	No	Proveedor. Por ejemplo, si el canal es WhatsApp, el valor correspondiente es `whatsapp_cloud`, `engagelab_whatsapp` o `twilio`. En los canales que no distinguen entre proveedores, el valor es `null`.