Trabajar con la entidad de usuario

Los usuarios son los perfiles que creas en tu CRM para tus empleados. No son tus clientes, sino tus gerentes o personal de soporte.

El conjunto de métodos a continuación te ayudará a configurar la sincronización de cuentas de usuario en tu CRM con Wazzup.

Obtener una lista de usuarios

Para obtener una lista de usuarios activos en Wazzup, debes llamar a:

 GET https://api.wazzup24.com/v3/users

Este método devuelve los usuarios ordenados por nombre.

Ejemplo de solicitud
 curl --location --request GET 'https://api.wazzup24.com/v3/users' \
--header 'Authorization: Bearer c8cf90444442348we909520d454368d27'
Ejemplo de respuesta
[
    {
        "id": "2e0df379-0e3c-470f-9b36-06b9e34c3bdb", // user id
        "name": "User Name" // user name
    } 
]

Obtener datos de un usuario específico

Para obtener los datos de un usuario específico, debes llamar a:

 GET https://api.wazzup24.com/v3/users/:id

La respuesta será un JSON como este

{
{"id": "2e0df379-0e3c-470f-9b36-06b9e34c3bdb", //user id
"name": "User Name"} ,
"phone": "79332345432 //user name
]
}
Agregar usuarios

Para agregar un nuevo usuario, debes llamar a:

 POST https://api.wazzup24.com/v3/users

En el cuerpo de la solicitud se debe enviar un array con los datos de los usuarios (máximo 100 por solicitud).

Los usuarios se comparan por su id: si el usuario no existe en Wazzup, se agregará; si ya existe, se actualizarán sus datos.

Agregar usuarios con el mismo número de teléfono a través de la API tiene limitaciones. Si ocurre un error, recibirás una notificación.
Parámetro Tipo Descripción
id* String Identificador del usuario. Hasta 200 caracteres
name* String Nombre del usuario. Hasta 200 caracteres
phone String Número de teléfono en formato internacional, por ejemplo: 79261234567. Si se especifica en un formato incorrecto, el campo será eliminado sin generar error

El campo "phone" se especifica solo para poder agregar un usuario a la aplicación móvil.

Ejemplo de solicitud
 curl --location --request POST 'https://api.wazzup24.com/v3/users' \
--header 'Authorization: Bearer c8cf90444023482f909520d454368d27' \
--header 'Content-Type: application/json' \
--data-raw '[
{
"id": "2e0df379-0e3c-470f-9b36-06b9e34c3bdb",
"name": "Alex Salesman",
"phone": "79263334567"
},
{
"id": "111-2e0df379-0e3c-470f-9b36",
"name": "Kate Supportics",
"phone": "79261234567"
}
]'
Errores comunes
Error  Descripción
INVALID_USERS_DATA El cuerpo de la solicitud está vacío o contiene campos inválidos
TOO_MACH_ENTITIES Se excedió el límite de 100 entidades por solicitud
USER_LIMIT_EXCEEDED Se superó el límite de 1.000 usuarios: no puedes añadir más empleados a tu cuenta
DUPLICATE_PHONE_NUMBER Ya existe un usuario con ese número de teléfono

"Usuario con número de teléfono ... ya existe en el CRM."

 HTTP/1.1 400 Bad Request
{
"error": "INVALID_USERS_DATA",
"description": "One or more of provided users identifiers are not valid."
"data": [
{
index: 12,
fields: [
"id",
"name"
]
}
]
}

 HTTP/1.1 400 Bad Request
{
"error": "TOO_MACH_ENTITIES",
"description": "Too mach entities per request.",
"data": {
"count": 123,
"limit": 100
}
}

 HTTP/1.1 400 Bad Request
{
"error": "USER_LIMIT_EXCEEDED",
"description": "User limit exceeded.",
"data": {
"limit": 1000,
}
}

{
    "status": 400,
    "requestId": "594101c6e81a1cace2646eee1edd5e66",
    "error": "DUPLICATE_PHONE_NUMBER",
    "description": "User with phone number 79999999999 already exists in the CRM.",
    "data": {
        "phone": "79999999999"
    }
}

Eliminar un usuario

Para eliminar un usuario, debes llamar a:

 DELETE https://api.wazzup24.com/v3/users/{contact id}
Ejemplo de solicitud
 curl --location --request DELETE 'https://api.wazzup24.com/v3/users/111-2e0df379-0e3c-470f-9b36' \
--header 'Authorization: Bearer c8cf90444023482f909520d454368d27'

Eliminar usuarios en masa

Para eliminar varios usuarios, llama a:

 PATCH https://api.wazzup24.com/v3/users/bulk_delete

En el cuerpo de la solicitud debes enviar un array con los IDs de los usuarios que deseas eliminar. Si la eliminación es exitosa, se devolverá 200 OK y un array vacío. Si se incluyeron usuarios que no existen en Wazzup, sus IDs se devolverán como array en la respuesta.