Lista de contactos

Los desarrolladores pueden consultar la lista de contactos de la cuenta a través de la API.

Método de solicitud

GET

URL de solicitud

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

Autenticación

Para más información, consulte la descripción del método de autenticación en Descripción general de la API.

Solicitud

Ejemplo de solicitud

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

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

Encabezados de solicitud

Campo	Tipo	Descripción
Authorization	string	Use `Authorization: Basic base64(API Key:API Secret)` para la autenticación. Vaya a la página de API Key para obtener la API Key y el API Secret, únalos con dos puntos y luego codifíquelos en Base64.
Content-Type	application/json	Este es el formato de datos de la solicitud. Use `application/json`.

Parámetros de consulta

Campo	Tipo	Obligatorio	Descripción
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. Admite varias etiquetas y devuelve coincidencias con cualquiera de ellas.
include_contact_inboxes	boolean	No	Indica si se debe devolver `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`.

Respuesta exitosa

Ejemplo de respuesta

{ "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": [ // Se devuelve cuando include_contact_inboxes=true { "source_id": "src_001", "inbox": { "id": 10, "name": "Canal de atención al cliente", "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": [           // Se devuelve cuando include_contact_inboxes=true
             {
              "source_id": "src_001",
              "inbox": 
              {
               "id": 10,
              "name": "Canal de atención al cliente",
              "channel_type": "Channel::Api"
              }
             }
          ]
        }
    ]
}

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

Parámetros de respuesta

Campo	Tipo	Obligatorio	Descripción
meta	Object	No	Objeto de metadatos.
count	Int	No	Número de resultados de la consulta.
current_page	Int	No	Número de página actual de los resultados.
payload	Object	No	Información de atributos.
additional_attributes	Object	No	Atributos adicionales.
availability_status	String	No	Estado en línea. 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.
blocked	String	No	Indica si está bloqueado. El valor predeterminado es `false`.
identifier	String	No	Identificador del usuario.
thumbnail	String	No	Miniatura.
custom_attributes	Object	No	Atributos personalizados.
created_at	String	No	Marca de tiempo de creación.
last_activity_at	String	No	Marca de tiempo de la última actividad.
created_at	String	No	Marca de tiempo en la que se creó este contacto.
contact_inboxes	array	Información de los canales asociados; solo se devuelve cuando `include_contact_inboxes=true`.
source_id	String	No	ID de origen.
inbox	Object	No	Información de la bandeja de entrada.
id	Integer	No	ID de la bandeja de entrada.
name	String	No	Nombre de la bandeja de entrada.
channel_type	String	No	Tipo de canal.

Respuesta de error

Parámetros de respuesta

Código de estado HTTP	Descripción
401	No autorizado. El token no es válido o falta.
403	Permisos insuficientes.