Listar contactos de la campaña

Obtiene la lista de contactos de una campaña específica.

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/campaigns/{campaignId}/contacts

Obtiene la lista de contactos de una campaña específica.

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 número de teléfono, nombre del contacto o ID del grupo de destino `minLength: 1` · `maxLength: 50`
`target`	query	array	No	Filtra por destino del contacto: número de teléfono (+1234567890) o ID de WhatsApp del grupo (123456789000000000@g.us)
`kind`	query	array	No	Filtra por tipo de destino
`status`	query	array	No	Filtra por estado de entrega
`ack`	query	array	No	Filtra por estado de ACK de entrega
`wid`	query	array	No	Filtra contactos por ID de mensajes de WhatsApp
`size`	query	number	No	Tamaño de resultados por solicitud `minimum: 1` · `maximum: 1000` · `default: 100`
`page`	query	number	No	Número de página de resultados para recorrer secuencias de entradas `minimum: 0` · `maximum: 50` · `default: 0`
`sort`	query	string	No	Criterio de ordenación de resultados según la fecha de entrega del mensaje `enum: ['date:desc', 'date:asc']` · `default: date:desc`

Respuestas

Código	Descripción
`200`	Contactos de la campaña
`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 necesarios
`404`	Recurso no encontrado
`409`	La campaña ya no se puede editar
`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

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

// Get contacts in a campaign
curl --request GET \
  --url 'https://api.getincloud.ai/v1/campaigns/{id}/contacts?size=100&page=0' \
  --header 'Token: <api token goes here>'


// Search contacts by text
curl --request GET \
  --url 'https://api.getincloud.ai/v1/campaigns/{id}/contacts?search=%2B1234567890' \
  --header 'Token: <api token goes here>'

AnteriorIniciar/detener campaña SiguienteObtener campaña

¿Te sirvió esta página?