Crear contacto

Los desarrolladores pueden crear contactos a través de la API.

Método de solicitud

POST

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 POST https://livedesk-api.engagelab.com/api/v2/accounts/contacts \ -H 'Content-Type: application/json' \ -H 'Authorization: Basic base64(api_key:api_secret)' \ { "inbox_id": 407, "name": "Test", // Opcional "email": "alice@acme.inc", "phone_number": "+123456789", "avatar_url": "https://example.com/avatar.png", "identifier": "1234567890", }

              
              curl -X POST https://livedesk-api.engagelab.com/api/v2/accounts/contacts \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic base64(api_key:api_secret)' \
{
    "inbox_id": 407,
    "name": "Test",                   // Opcional
    "email": "alice@acme.inc",
    "phone_number": "+123456789", 
    "avatar_url": "https://example.com/avatar.png",
    "identifier": "1234567890",
}

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 del cuerpo de la solicitud

Campo	Tipo	Obligatorio	Descripción
inbox_id	String	Sí	ID del canal. Corresponde al Channel ID en "Configuración del proyecto - Canales - canal específico - Configuración".
name	String	No	Nombre del contacto.
email	String	No	Dirección de correo electrónico.
phone_number	String	No	Número de teléfono del contacto.
avatar_url	String	No	Enlace de la imagen del avatar.
identifier	String	No	Identificador del usuario.

Respuesta

Ejemplo de respuesta

{ "payload": { "contact": { "additional_attributes": {}, "availability_status": "offline", "email": null, "id": 2219259, "name": "Test", "phone_number": null, "blocked": false, "identifier": null, "thumbnail": "", "custom_attributes": {}, "created_at": 1766571703, "contact_inboxes": [] }, "contact_inbox": { "inbox": null, "source_id": null } } }

              
              {
    "payload": {
        "contact": {
            "additional_attributes": {},
            "availability_status": "offline",
            "email": null,
            "id": 2219259,
            "name": "Test",
            "phone_number": null,
            "blocked": false,
            "identifier": null,
            "thumbnail": "",
            "custom_attributes": {},
            "created_at": 1766571703,
            "contact_inboxes": []
        },
        "contact_inbox": {
            "inbox": null,
            "source_id": null
        }
    }
}

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

Parámetros de respuesta

Campo	Tipo	Obligatorio	Descripción
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	String	No	Atributos personalizados.
created_at	String	No	Marca de tiempo de creación.
contact_inboxes	Array	No	Lista de bandejas de entrada asociadas al contacto.
inbox	String	No	Canal.
source_id	String	No	ID de origen.