Contactos

Lista o busca los contactos disponibles en el almacén del dispositivo, con la opción de filtrarlos mediante parámetros de búsqueda.

API de WhatsApp y CRM

Necesitas una clave de API. Pídela a nuestro equipo de soporte o créala desde la plataforma.

GET https://api.getincloud.ai/v1/chat/{deviceId}/contacts

Lista o busca los contactos disponibles en el almacén del dispositivo, con la opción de filtrarlos mediante parámetros de búsqueda.

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.

Parámetros

Campo	Dónde	Tipo	Obligatorio	Descripción
`search`	query	string	No	Busca contactos por nombre, apellido, ID, número de teléfono, correo electrónico, nombre de la empresa, correo de la empresa, dirección, metadatos o notas privadas `maxLength: 150`
`type`	query	array	No	Filtra contactos por tipo: personal, business, user (ambos anteriores), group, channel o private (contactos que provienen de una campaña de anuncios de Facebook y aún no han aprobado compartir su número de teléfono)
`owner`	query	array	No	Filtra contactos asignados a uno de los IDs de usuario indicados (hexadecimal de 24 caracteres). Se permiten varios valores separados por comas.
`has`	query	array	No	Filtra contactos que tienen correo electrónico, chat o ambos.
`hasChat`	query	boolean	No	Obsoleto: usa `has=chat` en su lugar. Filtra contactos con o sin un chat de WhatsApp.
`country`	query	array	No	Filtra contactos por código de país alpha-2 ISO 3166. Más información: https://www.iban.com/country-codes. Se permiten varios valores separados por comas.
`status`	query	array	No	Filtra contactos por estado
`chatStatus`	query	array	No	Filtra chats por estado
`labels`	query	array	No	Nota: este filtro solo funciona con contactos que tienen o tuvieron un chat de WhatsApp iniciado. Filtra contactos por etiquetas de chat. Si se definen varias etiquetas, al menos una debe coincidir. Para incluir contactos que tengan cualquier etiqueta asignada, usa `` como valor, por ejemplo: `labels=`.
`labelsExclude`	query	array	No	Nota: este filtro solo funciona con contactos que tienen o tuvieron un chat de WhatsApp iniciado. Excluye contactos que tengan ciertas etiquetas. Si se definen varias etiquetas, ninguna de ellas debe coincidir. Para excluir contactos que no tengan etiquetas asignadas, usa `` como valor, por ejemplo: `labelsExclude=`.
`ids`	query	array	No	Filtra contactos por ID de chat de WhatsApp. Por ejemplo: `1234567890@c.us`. Se permiten varios IDs separados por comas.
`lid`	query	array	No	Filtra contactos por LID (identificador privado de WhatsApp). Por ejemplo: `1234567890123@lid`. Se permiten varios LID separados por comas.
`phone`	query	array	No	Filtra contactos por números de teléfono o WIDs
`group`	query	array	No	Filtra contactos por WIDs de grupo
`broadcast`	query	array	No	Filtra contactos por WIDs de lista de difusión
`include`	query	array	No	Incluye en la respuesta entidades relacionadas con el contacto, como el chat activo del contacto, si está disponible
`metadataKey`	query	array	No	Filtra contactos con una clave de metadatos específica. Se permiten varios valores separados por comas
`metadataValue`	query	array	No	Filtra contactos con un valor de metadatos específico. Se permiten varios valores separados por comas
`after`	query	string	No	Filtra contactos creados después de la fecha indicada `format: date-time`
`before`	query	string	No	Filtra contactos creados antes de la fecha indicada `format: date-time`
`updatedAfter`	query	string	No	Filtra contactos actualizados después de la fecha indicada `format: date-time`
`updatedBefore`	query	string	No	Filtra contactos actualizados antes de la fecha indicada `format: date-time`
`lastMessageBefore`	query	string	No	Filtra contactos con un chat activo cuyo último mensaje se envió antes de la fecha indicada `format: date-time`
`lastMessageAfter`	query	string	No	Filtra contactos con un chat activo cuyo último mensaje se envió después de la fecha indicada `format: date-time`
`page`	query	number	No	Número de página de resultados (empezando desde 0) `minimum: 0` · `maximum: 300` · `default: 0` · `format: integer`
`size`	query	number	No	Tamaño de página de resultados `minimum: 1` · `maximum: 500` · `default: 20` · `format: integer`
`sort`	query	string	No	Define cómo ordenar los contactos `enum: ['name:asc', 'name:desc', 'date:asc', 'date:desc', 'message:asc', 'message:desc']`

Respuestas

Código	Descripción
`200`	Contactos
`400`	Datos de consulta o cuerpo de la solicitud no válidos
`401`	No autorizado: token de API no válido o ausente
`403`	Faltan los permisos requeridos
`404`	Recurso no encontrado
`409`	Conflicto
`429`	Demasiadas solicitudes: inténtalo de nuevo más tarde
`500`	Error inesperado
`501`	No implementado
`503`	Servicio no disponible temporalmente: inténtalo de nuevo más tarde

// This code example requires you to have installed curl package
// Installation instructions here: https://curl.haxx.se/download.html

// Search most recent contacts
curl --request GET \
  --url 'https://api.getincloud.ai/v1/chat/{deviceId}/contacts?size=20&page=0' \
  --header 'Token: <api token goes here>'


// Search group only contacts
curl --request GET \
  --url 'https://api.getincloud.ai/v1/chat/{deviceId}/contacts?type=group' \
  --header 'Token: <api token goes here>'


// Search contact by phone number 
curl --request GET \
  --url 'https://api.getincloud.ai/v1/chat/{deviceId}/contacts?phone=%2B123456789' \
  --header 'Token: <api token goes here>'

AnteriorBuscar mensajes SiguienteCrear contacto

¿Te sirvió esta página?