Skip to main content
GET
Lista los lotes de la cuenta
Devuelve los lotes del marcador que coinciden con los filtros enviados.

Autenticación

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

Parámetros de consulta

integer
Página que se desea consultar. El ejemplo comienza en 0.
integer
Cantidad de lotes por página.
string
Campo utilizado para ordenar los resultados. En el ejemplo se usa createdAt.
string
Orden de los resultados. En el ejemplo se usa desc.
string
Estado por el que se filtran los lotes. En el ejemplo se usa archived.
string
Inicio del periodo en formato ISO 8601.
string
Fin del periodo en formato ISO 8601.

Ejemplo

cURL
La respuesta de cada lote también puede incluir su mapeo, reglas, estrategia de duplicados y datos del canal. Para ver un ejemplo más detallado, consulta Obtener un lote.

Authorizations

apikey
string
header
required

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

Query Parameters

page
integer
default:0

Número de página, comenzando en 0.

Required range: x >= 0
size
integer
default:20

Número de lotes por página.

Required range: x >= 1
sortField
string
default:createdAt

Campo de ordenamiento.

sortOrder
enum<string>
default:desc
Available options:
asc,
desc
status
enum<string>

Filtra por estado del lote. Si se omite, se devuelven todos los lotes, incluidos los archivados.

Available options:
running,
stopped,
completed,
archived

Filtra por nombre del lote.

startDate
string<date-time>

Fecha de creación mínima.

endDate
string<date-time>

Fecha de creación máxima.

crewId
string

Filtra por equipo asociado al canal del lote.

channelType
string

Tipo de canal, según el catálogo de canales de la cuenta. Por ejemplo Livekit_SipCall.

Response

Página de lotes.

data
object[]
required
pagination
object
required