Buscar archivos

Lista archivos, opcionalmente usando varios filtros de búsqueda.

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/files

Lista archivos, opcionalmente usando varios filtros 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, incluyendo 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
`page`	query	number	No	`minimum: 0` · `maximum: 100` · `default: 0` · `format: integer`
`size`	query	number	No	`minimum: 1` · `maximum: 100` · `default: 20` · `format: integer`
`search`	query	string	No	Busca archivos por nombre de archivo, etiquetas o referencia `maxLength: 100`
`after`	query	string	No	Entrega después de la fecha indicada `format: date-time`
`before`	query	string	No	Entrega antes de la fecha indicada `format: date-time`
`format`	query	array	No	Filtra archivos por tipo de formato. Si no se indica, se devolverán archivos de cualquier formato
`ids`	query	array	No	Filtra archivos por IDs
`tags`	query	array	No	Busca archivos por el campo de etiquetas definido por el usuario. El motor de búsqueda realiza una coincidencia parcial de términos donde no se pueden usar los caracteres `.` o `-`, ya que se procesan como separadores; para una búsqueda explícita, encierra el término de búsqueda entre comillas dobles, por ejemplo: `"search term"`
`sha2`	query	string	No	Encuentra un archivo por el valor de su suma de verificación SHA2 `minLength: 64` · `maxLength: 64` · `pattern: ^[0-9a-f]{64}$`
`reference`	query	string	No	Busca archivos por el campo de referencia definido por el usuario. El motor de búsqueda realiza una coincidencia parcial de términos donde no se pueden usar los caracteres `.` o `-`, ya que se procesan como separadores; para una búsqueda explícita, encierra el término de búsqueda entre comillas dobles, por ejemplo: `"search term"` `minLength: 1` · `maxLength: 50`
`status`	query	array	No
`device`	query	string	No	`minLength: 24` · `maxLength: 24` · `pattern: ^[0-9A-Fa-f]{24}$`
`filename`	query	string	No	Busca archivos por el campo de nombre de archivo definido por el usuario. El motor de búsqueda realiza una coincidencia parcial de términos donde no se pueden usar los caracteres `.` o `-`, ya que se procesan como separadores; para una búsqueda explícita, encierra el término de búsqueda entre comillas dobles, por ejemplo: `"search term"` `minLength: 1` · `maxLength: 150`
`filenameSearch`	query	string	No	Búsqueda de subcadena en el campo de nombre de archivo (sin distinguir mayúsculas de minúsculas). Devuelve los archivos cuyo nombre contiene el término indicado. Se requieren como mínimo 2 caracteres. `minLength: 2` · `maxLength: 150`
`origin`	query	string	No	`enum: ['remote', 'upload', 'catalog']`
`mime`	query	array	No
`kind`	query	array	No
`ext`	query	array	No
`permission`	query	string	No	Nivel de permiso de acceso al archivo. Los archivos `public` son accesibles para cualquiera en el equipo, mientras que los archivos `private` solo son accesibles para el creador del archivo. `enum: ['public', 'readonly', 'private']`
`owner`	query	string	No	ID del usuario/agente creador del archivo (24 caracteres hexadecimales). No se puede usar junto con el parámetro `ownerDistinct`. `minLength: 24` · `maxLength: 24` · `pattern: ^[0-9A-Fa-f]{24}$`
`ownerDistinct`	query	string	No	Creador del archivo distinto del ID de usuario/agente indicado (24 caracteres hexadecimales). No se puede usar junto con el parámetro `owner`. `minLength: 24` · `maxLength: 24` · `pattern: ^[0-9A-Fa-f]{24}$`
`filesize`	query	array	No	Rango de tamaño de archivo mínimo y máximo en bytes. Ejemplo: 10000,1000000

Respuestas

Código	Descripción
`200`	Archivos
`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 requeridos
`404`	Recurso no encontrado
`409`	Conflicto
`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 last created files
curl --request GET \
  --url 'https://api.getincloud.ai/v1/files?size=25&page=0&status=any' \
  --header 'Token: <api token goes here>'


// Get last valid files that are images
curl --request GET \
  --url 'https://api.getincloud.ai/v1/files?size=20&status=valid&kind=image' \
  --header 'Token: <api token goes here>'

AnteriorActualizar archivo SiguienteDescargar el contenido de un archivo

¿Te sirvió esta página?