Skip to main content
GET
Consulta un lote
Devuelve la información de un lote concreto, incluidos su estado, métricas, configuración y canal asociado.

Autenticación

string
required
API key obtenida desde la interfaz de Inagent, dentro del marcador.

Parámetros de ruta

string
required
Identificador único del lote.

Ejemplo

cURL

Authorizations

apikey
string
header
required

API key obtenida desde la interfaz de Inagent, dentro del marcador.

Path Parameters

batchId
string<uuid>
required

Id del lote.

Response

El lote.

Lote de marcación. Es la estructura que devuelven tanto la consulta de un lote como cada elemento del listado.

id
string<uuid>
name
string
channelId
string<uuid>
channelName
string
channelType
string

Tipo de canal, tal como lo expone el catálogo de canales. Por ejemplo Livekit_SipCall.

Example:

"Livekit_SipCall"

channelPriority
integer

Peso al repartir la capacidad del canal entre lotes que corren a la vez.

Required range: 1 <= x <= 10
crewId
string | null
status
enum<string>

Estado persistido.

deleting y archiving son transitorios: el lote no admite ninguna acción mientras está en uno de ellos, y cualquier intento responde 409.

Available options:
stopped,
running,
completed,
archived,
deleting,
archiving
displayStatus
string

Estado efectivo del lote en el momento de la consulta. Es el valor recomendado para mostrar o evaluar la situación del lote.

Puede no coincidir con status: un lote con status: running fuera de su ventana horaria devuelve scheduled, ya que no realizará llamadas hasta que la ventana se abra.

Example:

"scheduled"

statusReason
enum<string>

Por qué está en ese estado. manual y scheduled son los que puede declarar un cliente al arrancar o detener; el resto los escribe el servicio.

Available options:
created,
manual,
scheduled,
no more contacts,
system
statusChangedAt
string<date-time> | null
statusChangedBy
string | null
statusDetail
string | null
nextActivationAt
string<date-time> | null

Fecha y hora en que un lote en espera reanudará la marcación. null si no procede.

En el listado puede venir vacío aunque el lote tenga una ventana horaria configurada, ya que allí solo se calcula para los lotes en curso. Para obtener el valor en cualquier estado, consulte el lote por su identificador.

totalContacts
integer

Contactos del lote.

fileRowCount
integer

Filas del CSV original. Puede ser mayor que totalContacts: las filas sin dirección utilizable, o descartadas por filtros o duplicados, no llegan a ser contactos.

processedCount
integer

Número de contactos ya procesados. En un lote en curso refleja el estado actual de la marcación; si esa información no está disponible momentáneamente, se devuelve el último valor registrado.

contactedCount
integer

Contactos efectivamente contactados.

finishedCount
integer

Contactos cerrados sin haber sido contactados: se agotaron sus intentos o sus direcciones.

uploadStatus
string

Estado de la importación del CSV.

uploadProgress
integer
Required range: 0 <= x <= 100
queueSyncStatus
enum<string>

Estado de la carga de los contactos en el motor de marcación.

Es necesario para distinguir un lote que está arrancando de uno que ya está marcando: el lote pasa a running antes de que la carga finalice.

Available options:
pending,
syncing,
completed,
failed
mapping
object

Qué columna del CSV es cada cosa.

filters
object | null
schedule
object | null

Ventana horaria propia. null si hereda la de la cuenta.

rules
object | null

Reglas de marcación del lote. null si usa las reglas globales de la cuenta.

duplicateStrategy
object | null
isFavorite
boolean
s3CsvKey
string

Ubicación interna del CSV importado.

s3SnapshotKey
string | null

Ubicación interna del snapshot, en lotes archivados.

channel
object | null

Datos del canal resuelto.

enabled
boolean
deleted
boolean
TenantId
string
createdAt
string<date-time>
updatedAt
string<date-time>
createdBy
string
updatedBy
string