Obtener campañas

Recupera campañas, opcionalmente filtradas por parámetros de búsqueda ---- Prueba este endpoint en el probador de API en vivo ¿Necesitas ayuda?

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

Recupera campañas, opcionalmente filtradas por 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
`before`	query	string	No	Fecha de inicio en formato ISO 8601. Ejemplo: `2023-01-15T00:00:00.000Z` `format: date-time`
`after`	query	string	No	Fecha de fin en formato ISO 8601. Ejemplo: `2023-02-15T00:00:00.000Z` `format: date-time`
`status`	query	array	No	Filtrar por estado de la campaña
`device`	query	array	No	Filtrar por IDs de dispositivos de WhatsApp
`owner`	query	array	No	Filtrar por IDs de usuarios propietarios
`id`	query	array	No	Filtrar por IDs de campañas
`phone`	query	array	No	Filtrar campañas por números de teléfono de los destinatarios. Se permiten varios valores separados por comas. Ej.: `+1234567890`
`group`	query	array	No	Filtrar campañas por chats grupales de los destinatarios. Se permiten varios valores separados por comas. Ej.: `123456789000000000@g.us`
`size`	query	number	No	Cantidad de resultados por solicitud `minimum: 1` · `maximum: 100` · `default: 50`
`page`	query	number	No	Número de página de resultados para navegar secuencialmente por las entradas `minimum: 0` · `maximum: 100` · `default: 0`
`sort`	query	string	No	Criterio de ordenación de los resultados por fecha de creación de la campaña `enum: ['date:desc', 'date:asc']` · `default: date:desc`

Respuestas

Código	Descripción
`200`	Campañas
`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`	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

// Retrieve recent campaigns
curl --request GET \
  --url 'https://api.getincloud.ai/v1/campaigns?size=50' \
  --header 'Token: <api token goes here>'


// Retrieve campaigns per WhatsApp device
curl --request GET \
  --url 'https://api.getincloud.ai/v1/campaigns?device={{device.id}}%3E' \
  --header 'Token: <api token goes here>'


// Retrieve campaigns per status
curl --request GET \
  --url 'https://api.getincloud.ai/v1/campaigns?status=pending%2Cprocessing%2Cpending%2Cdraft%2Cprocessed' \
  --header 'Token: <api token goes here>'

AnteriorObtener campaña SiguienteActualización masiva de chats

¿Te sirvió esta página?