Saltar al contenido principal
GET
cURL
Límite de Tasa: 12 solicitudes por segundo
startDate/endDate son nombres antiguos que se mantienen por compatibilidad y equivalen a createdAfter/createdBefore (filtran sobre created_at, no sobre cuándo inició o finalizó la Campaña). Usa startedAfter/startedBefore y endedAfter/endedBefore para filtrar por esas fechas. Cuando se envían ambos extremos de un par, el valor after debe ser anterior al before.

Autorizaciones

Authorization
string
header
requerido

Add api-key YOUR_API_SECRET_KEY as the value of the Authorization header.

Parámetros de consulta

agentId
string<uuid4>

Filters the Campaigns by Agent ID of the agent assigned to the Campaign

status
enum<string>

Filters the Campaigns by the Status of the Campaign

Opciones disponibles:
pending,
ready,
active,
inactive,
cooldown,
finished
integration
enum<string>

Type of integration for the Campaign

Opciones disponibles:
phone_call,
whatsapp
startDate
string<ISO 8601>

Older name kept for backward compatibility, equivalent to createdAfter. Filters by created_at, not by start date.

endDate
string<ISO 8601>

Older name kept for backward compatibility, equivalent to createdBefore. Filters by created_at, not by end date.

createdAfter
string<ISO 8601>

Filter by created_at on or after this date.

createdBefore
string<ISO 8601>

Filter by created_at on or before this date.

startedAfter
string<ISO 8601>

Filter by started_at on or after this date. Excludes Campaigns that have not started.

startedBefore
string<ISO 8601>

Filter by started_at on or before this date. Excludes Campaigns that have not started.

endedAfter
string<ISO 8601>

Filter by ended_at on or after this date. Excludes Campaigns that have not ended.

endedBefore
string<ISO 8601>

Filter by ended_at on or before this date. Excludes Campaigns that have not ended.

archived
boolean
predeterminado:false

If true, archived Campaigns will be included in the results.

pageSize
integer
predeterminado:50

Number of items per page to return.

Rango requerido: x <= 100
cursor
string

Cursor to the next page to return.

Respuesta

Campaigns response

total_count
integer

Total number of Campaigns for the given query. NOTE: The result is cache for 3 minutes.

campaigns
object[]
pagination
object

Filters are applied to each request independently. Changing filters while paginating may result in gaps or overlaps in the result set. For consistent results, maintain the same filters throughout pagination.