Trabajando con contactos

Centro de ayuda

Centro de ayuda

Registrarse

Iniciar sesión

Centro de ayuda

Trabajando con contactos

Un contacto es una entidad que conecta al usuario con el cliente que ha escrito. Es una especie de "ficha de contacto" donde se almacena la información del cliente (número de teléfono en WhatsApp, ID en Telegram, nombre de usuario en Instagram) y se indica el responsable asignado.

Contenido

Agregar y actualizar la lista de contactos
Errores
Obtener la lista de contactos
Obtener información de un contacto individual
Eliminar múltiples contactos
Eliminación múltiple de contactos

Agregar y actualizar la lista de contactos

Para agregar o modificar una lista de contactos, envíe una solicitud:

Método POST https://api.wazzup24.com/v3/contacts

Estructura de la solicitud

POST /v3/contacts
[
  {
    ├── id *
    ├── responsibleUserId *
    ├── name *
    ├── contactData[] *
    │   ├── chatType *
    │   ├── chatId *
    │   ├── username
    │   └── phone
    └── uri
  }
]

Hay un límite de 100 entidades por solicitud.

Parámetro	Tipo	Descripción
id*	String	ID del contacto en el sistema CRM. Máximo 100 caracteres
responsibleUserId*	String	ID del usuario responsable. Máximo 100 caracteres. Complete este campo para que el diálogo aparezca en la ventana de chat de Wazzup del responsable asignado
name*	String	Nombre del contacto. Máximo 200 caracteres
contactData*	Array(objeto) contactData	Arreglo de objetos con datos de contacto
uri	String	Enlace al contacto en el CRM. Máximo 200 caracteres. Si se especifica, aparecerá un botón hacia el contacto en el desplegable de "Negocios".

contactData (objeto)

Parámetro	Tipo	Descripción
chatType*	String	Tipo de chat. Valores disponibles: WhatsApp: "whatsapp" Grupo de WhatsApp: "whatsgroup" Viber: "viber" Instagram: "instagram" Telegram: "telegram"
chatId*	String	ID del chat (cuenta del contacto en el mensajero). WhatsApp/Viber: solo números, sin espacios ni caracteres especiales, formato 79011112233 Instagram: nombre de usuario sin @ Whatsgroup y Telegram: llega en los webhooks
username	String	Solo para Telegram. Nombre de usuario sin @. Se puede usar si no se conoce el chatId
phone	String	Solo para Telegram. Número en formato internacional, sin + ni otros símbolos. Usado si no se conoce el chatId

Ejemplo de solicitud

fetch("https://api.wazzup24.com/v3/contacts", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer {apiKey}",
  },
  body: [
{
        "id": "1",
        "responsibleUserId": "1",
        "name": "3301",
        "contactData": [
            {
                "chatType": "whatsapp",
                "chatId": "79991114433"
            }
        ],
        "uri": "https://link-to-contact-in-crm.com"
    },
    {
        "id": "2",
        "responsibleUserId": "1",
        "name": "3302",
        "contactData": [
            {
                "chatType": "whatsapp",
                "chatId": "79884447788"
            }
        ]
    }
]

Errores

Además de los errores comunes a todas las rutas, aquí también pueden aparecer los siguientes:

Errores	Descripción
INVALID_CONTACTS_DATA	El cuerpo de la solicitud está vacío o algunos de los campos proporcionados no son válidos
TOO_MANY_ENTITIES	Se superó el límite de 100 entidades por solicitud

Obtener la lista de contactos

Para obtener la lista de contactos, llame a:

Método GET https://api.wazzup24.com/v3/contacts?offset=

Puede obtener hasta 100 registros por solicitud, ordenados por id ascendente (ASC).

offset es el desplazamiento para paginación (entero no negativo).

Respuesta

Parámetro	Tipo	Descripción
count	Number	Número total de contactos
data	Object data	Arreglo con la información de cada contacto

data (objeto)

Parámetro	Tipo	Descripción
id	String	ID del contacto en el sistema CRM.
responsibleUserId	String	ID del usuario responsable.
name	String	Nombre del contacto.
contactData	Object contactData	Datos de contacto: chatType y chatId
uri	String	Enlace al contacto en el CRM.

Obtener información de un contacto individual

Para obtener información de un contacto específico:

Método GET https://api.wazzup24.com/v3/contacts/{contact id}

Eliminar múltiples contactos

Para eliminar un contacto, realiza la siguiente llamada:

Método DELETE https://api.wazzup24.com/v3/contacts/{contact id}

Eliminación múltiple de contactos

Para eliminar una lista de contactos, realiza la siguiente llamada:

Método PATCH https://api.wazzup24.com/v3/contacts/bulk_delete