/chat/{deviceId}/contactsCrear contacto
Crea un nuevo contacto de usuario a partir de un número de teléfono en formato E164 (p.
POST https://api.getincloud.ai/v1/chat/{deviceId}/contactsCrea un nuevo contacto de usuario a partir de un número de teléfono en formato E164 (p. ej.: +1234567890) en la agenda interna de contactos de la plataforma del número de WhatsApp conectado.
Los contactos creados desde la API de la plataforma o desde el chat no se sincronizan con la agenda del móvil con el WhatsApp conectado, por lo que es posible que los contactos aparezcan en la aplicación móvil de WhatsApp con el número de teléfono sin formato en lugar del nombre del contacto.
Tutoriales relacionados:
Nota: si el número de teléfono ya está en uso por un contacto existente en el almacén de contactos del dispositivo específico, la API devolverá una respuesta de error 409 Conflict, y el ID de WhatsApp del contacto existente se incluirá en la respuesta de error, de modo que pueda usarse después para actualizar el contacto existente mediante el [endpoint Update contact](#operation/updateContact).
Prueba este endpoint en el probador de API en vivo
>¿Necesitas ayuda? Explora todos los tutoriales, más de 100 ejemplos de casos de uso y juega con el probador de API en vivo con ejemplos de código listos para usar en más de 15 lenguajes de programación, incluidos JavaScript/Node.js, PHP, Python, C#, Java, Ruby, Swift, Kotlin, Powershell, cURL y más.
Autenticación
Envía tu API key en el encabezado Token en cada petición.
Cuerpo de la petición
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
name | string | No | maxLength: 30 |
surname | string | No | maxLength: 50 |
title | string | No | maxLength: 15 |
kind | string | No | enum: ['personal', 'business'] |
gender | string | No | enum: ['male', 'female', 'other'] |
altPhone | string | No | Número de teléfono secundario en formato compatible con E164. P. ej.: +1234567890 minLength: 6 · maxLength: 20 |
email | string | No | minLength: 5 · maxLength: 100 · format: email |
description | string | No | maxLength: 100 |
languages | array<string> | No | |
companyName | string | No | maxLength: 50 |
companyCode | string | No | maxLength: 50 |
companyTaxId | string | No | maxLength: 30 |
companyRole | string | No | maxLength: 30 |
companyWebsite | string | No | minLength: 6 · maxLength: 100 |
companyEmail | string | No | minLength: 5 · maxLength: 100 · format: email |
companyPhone | string | No | Número de teléfono de la empresa en formato compatible con E164. P. ej.: +1234567890 minLength: 2 · maxLength: 18 |
companyCountry | string | No | Código alpha-2 ISO 3166 del país de la empresa. Más información minLength: 2 · maxLength: 2 |
currency | string | No | Código ISO alpha-3 de la moneda. Más información minLength: 3 · maxLength: 3 |
address | string | No | maxLength: 100 |
city | string | No | maxLength: 30 |
postalCode | string | No | maxLength: 20 |
country | string | No | Código alpha-2 ISO 3166 del país. Más información minLength: 2 · maxLength: 2 |
notes | string | No | Notas internas en texto plano sobre este contacto. Al establecer este campo se sobrescribirá el texto de las notas existentes. minLength: 0 · maxLength: 3000 |
birthday | string | No | format: date-time |
notifications | string | No | enum: ['on', 'mute', 'ignore'] |
timezone | string | No | Zona horaria de la ubicación del contacto. Lista de valores admitidos minLength: 2 · maxLength: 40 |
crm | string | No | Nombre opcional del CRM externo de origen. P. ej.: hubspot, dynamics, zoho, bitrix, salesforce... minLength: 2 · maxLength: 50 |
crmRef | string | No | Referencia opcional del usuario en un CRM externo, como un ID, un correo electrónico o una URL del contacto en un sistema CRM externo. minLength: 2 · maxLength: 500 |
sync | boolean | No | Activa la sincronización automática del contacto en todos los números de WhatsApp conectados en tu cuenta. Esta opción está desactivada de forma predeterminada. Para sincronizar un contacto solo en números de WhatsApp específicos, usa en su lugar el campo syncNumbers. default: False |
syncNumbers | array<string> | No | Activa la sincronización automática del contacto en varios números de WhatsApp conectados en tu cuenta. Usa all para sincronizar el contacto en todos los números conectados de tu cuenta, o usa el ID del número de destino (24 caracteres hexadecimales) para seleccionar los números con los que quieres sincronizar el contacto. Esta opción está desactivada de forma predeterminada. |
metadata | array<object> | No | |
links | array<object> | No | |
subscription | object | No | Actualiza la configuración de suscripción a campañas de este contacto |
subscription.status | string | No | Establece el estado de suscripción de este contacto enum: ['subscribed', 'active', 'exclude', 'unsubscribed'] |
$remove | No | ||
phone | string | Sí | minLength: 6 · maxLength: 20 |
assign | string | No | Asigna opcionalmente el chat del nuevo contacto a un miembro del equipo del número mediante su ID (24 caracteres hexadecimales). Se aplica solo cuando se crean el contacto y su chat, y únicamente si tu rol puede asignar chats; un contacto existente conserva su chat tal como está. Si no se establece, el chat permanece sin asignar y pendiente, y se puede asignar más tarde. minLength: 24 · maxLength: 24 |
upsert | boolean | No | Si el contacto ya existe, actualiza la información del contacto. Si no, crea una nueva entrada de contacto. El valor predeterminado es false default: False |
Respuestas
| Código | Descripción |
|---|---|
200 | Contacto creado |
400 | Cuerpo de la solicitud no válido |
401 | No autorizado: token de API no válido o ausente |
403 | No autorizado o faltan permisos |
404 | Recurso no encontrado |
409 | El número de teléfono del contacto ya existe |
429 | Demasiadas solicitudes: inténtalo de nuevo más tarde |
500 | Error inesperado |
501 | No implementado |
503 | Servicio temporalmente no disponible: inténtalo de nuevo más tarde |