Saltar al contenido

Endpoints

Endpoints

Nombre

Listar archivos

Los archivos de tu organización, del más reciente al más antiguo, paginados por cursor.

Método HTTP y ruta

GET/api/v6/storage/objects

https://developers.hablame.co/api/v6/storage/objects

Qué pasa al ejecutarlo

  • Solo consulta: no cambia datos de tu organización.
  • La llamada no se cobra.

Qué hace

Lista los archivos guardados y los que se están eliminando, del más reciente al más antiguo. Pagina por cursor: si next no es null, pásalo como cursor para la página siguiente con los mismos filtros. Un cursor alterado, de otra organización, con otros filtros o de hace más de 24 horas responde 400 INVALID_CURSOR: vuelve a la primera página.

Disponibilidad y requisitos previos

  • Publicado y disponible en la API v6 de producción.
  • Todas las rutas parten de https://developers.hablame.co.
  • Necesitas una API key de Hablame para llamarlo.

Crea tu clave de API

Autenticación y permisos

  • Envía tu API key en la cabecera Authorization con el esquema Bearer.

Quién puede llamarlo: Una API key con el servicio storage habilitado.

Límites y consideraciones operativas

Límite de uso: 10 solicitudes por segundo.

  • Las seis consultas de Almacenamiento (resumen, consumo, listado, detalle, conservación y tarifa) comparten este cupo por organización: no es un cupo por endpoint.

Parámetros de ruta

Este endpoint no tiene parámetros de ruta.

Parámetros de consulta

NombreTipoDescripción y reglas
serviceOpcionalstring

Código del servicio que guardó los archivos (el service de las respuestas). Un código que no existe responde 400 INVALID_FILTER.

Ejemplo:callblasting

scopeOpcionalstring

Código del tipo de archivo dentro del servicio (el scope de las respuestas). Exige service.

Ejemplo:recordings

fromOpcionalstring

Solo los guardados desde este instante (ISO-8601; sin zona, hora de Colombia).

toOpcionalstring

Solo los guardados antes de este instante.

limitOpcionalinteger

Archivos por página.

Valor por omisión:50Mínimo:1Máximo:200

cursorOpcionalstring

El next de la página anterior.

Encabezados HTTP

NombreTipoDescripción y reglas
AuthorizationObligatoriostring

Tu API key con el esquema Bearer.

Ejemplo:Bearer hk_TU_API_KEY

Cuerpo de la petición

Este endpoint no recibe cuerpo en la petición.

Respuestas satisfactorias

200

Una página de archivos.

Ejemplo de respuesta
{
  "success": true,
  "data": {
    "objects": [
      {
        "id": "obj_01JABCDEFGHJKMNPQRSTVWXYZ0",
        "name": "llamada-3001234567.wav",
        "service": "callblasting",
        "scope": "recordings",
        "size": 482113,
        "contentType": "audio/wav",
        "storedAt": "2026-10-18T10:00:00.000-05:00",
        "expiresAt": "2026-11-17T10:00:00.000-05:00",
        "status": "available",
        "deletable": false
      }
    ],
    "next": "c1.t3b9X0k..."
  },
  "meta": {
    "requestId": "5d0f3a9c7b2e41a8",
    "clientIp": "203.0.113.10",
    "timestamp": "2026-10-19T15:30:00+00:00",
    "responseTimeMs": 12.4
  }
}

Los valores del ejemplo son ilustrativos.

Campos de la respuesta

NombreTipoDescripción y reglas
successSiempre presenteboolean

dataSiempre presenteobject

data.objectsSiempre presentearray<object>

data.objects[].idSiempre presentestring

Identificador del archivo.

Ejemplo:obj_01JABCDEFGHJKMNPQRSTVWXYZ0

data.objects[].nameSiempre presentestring

Nombre original, si el servicio lo guardó.

Puede llegar en null.

data.objects[].serviceSiempre presentestring

Servicio que lo guardó.

data.objects[].scopeSiempre presentestring

Tipo de archivo dentro del servicio.

data.objects[].sizeSiempre presenteinteger

Tamaño en bytes.

data.objects[].contentTypeSiempre presentestring

Tipo MIME.

data.objects[].storedAtSiempre presentestring

Cuándo quedó guardado (ISO-8601, hora de Colombia, con milisegundos).

Puede llegar en null.

Formato:date-time

data.objects[].expiresAtSiempre presentestring

Cuándo se elimina según el tiempo de conservación vigente, o null si no vence.

Puede llegar en null.

Formato:date-time

data.objects[].statusSiempre presentestring

available: se puede descargar. deleting: se está eliminando (o ya venció); no se puede descargar y se cobra hasta que termine.

Valores permitidos:available deleting

data.objects[].deletableSiempre presenteboolean

Si su tipo de archivo permite eliminarlo desde el portal antes de que venza.

data.nextSiempre presentestring

Cursor de la página siguiente, o null si no hay más.

Puede llegar en null.

metaSiempre presenteobject

Metadatos de la respuesta.

meta.requestIdSiempre presentestring

Identificador único de la solicitud (16 caracteres hexadecimales). Es el mismo de la cabecera X-Request-Id. Cítalo al contactar soporte.

Ejemplo:b9b1704baffab211

meta.clientIpSiempre presentestring

IP con la que la API vio tu solicitud. Útil si tu API key solo admite ciertas redes.

Ejemplo:203.0.113.45

meta.timestampSiempre presentestring

Fecha y hora en que se construyó la respuesta (ISO 8601 con offset).

Formato:date-timeEjemplo:2026-06-04T19:43:59+00:00

meta.responseTimeMsSiempre presentenumber

Tiempo (ms) que tomó procesar la solicitud en el servidor.

Ejemplo:4.24

Códigos de error

Todas las respuestas de error tienen la misma forma: success en false y un objeto error cuyo code dice qué pasó. Aquí están agrupadas por tipo, con los códigos que este endpoint puede devolver.

Forma de una respuesta de error
NombreTipoDescripción y reglas
successSiempre presenteboolean

Valor fijo:false

metaSiempre presenteobject

Metadatos de la respuesta.

meta.requestIdSiempre presentestring

Identificador único de la solicitud (16 caracteres hexadecimales). Es el mismo de la cabecera X-Request-Id. Cítalo al contactar soporte.

Ejemplo:b9b1704baffab211

meta.clientIpSiempre presentestring

IP con la que la API vio tu solicitud. Útil si tu API key solo admite ciertas redes.

Ejemplo:203.0.113.45

meta.timestampSiempre presentestring

Fecha y hora en que se construyó la respuesta (ISO 8601 con offset).

Formato:date-timeEjemplo:2026-06-04T19:43:59+00:00

meta.responseTimeMsSiempre presentenumber

Tiempo (ms) que tomó procesar la solicitud en el servidor.

Ejemplo:4.24

errorSiempre presenteobject

error.codeSiempre presentestring

Identificador estable en UPPER_SNAKE_CASE. Los clientes ramifican sobre este valor.

Ejemplo:AUTH_REQUIRED

error.legacyCodeinteger

Código numérico legacy v5, solo cuando hay puente. Se omite en los códigos nacidos en v6.

Ejemplo:40002

error.typeSiempre presentestring

URL a la documentación del error.

Formato:uriEjemplo:https://developers.hablame.co/docs/v6/errors/auth-required

error.messageSiempre presentestring

Texto legible en inglés. Es para el log del desarrollador, no para el usuario final: no lo parsees.

error.detailsSiempre presentearray<object>

Contexto estructurado (validaciones, recurso afectado). Arreglo vacío cuando no hay contexto extra.

Validación

  • 400Un parámetro no es válido.

Autenticación

  • 401Credenciales inválidas o faltantes.
  • 401AUTH_REQUIRED

    No se envió un token Bearer y cada llamada lo requiere.

    Mensaje que devuelve la API: Authentication is required. Send your API key as `Authorization: Bearer <token>`.

  • 401AUTH_INVALID_KEY

    La clave de API no se reconoce: formato equivocado, revocada o vencida.

    Mensaje que devuelve la API: The provided API key is invalid or has expired. Please verify the value sent in the `Authorization: Bearer` header.

Permisos

  • 403La API key no tiene el servicio Almacenamiento (storage), no se puede usar desde la red de la petición, o la organización no está activa.
  • 403AUTH_SERVICE_NOT_ALLOWED

    La clave no tiene permitido el servicio detrás de este endpoint.

    Mensaje que devuelve la API: This API key is not authorized to use the requested service.

  • 403AUTH_IP_NOT_ALLOWED

    La clave solo funciona desde ciertas redes y tu IP no está entre ellas.

    Mensaje que devuelve la API: This API key cannot be used from this IP address. The address we saw is in `meta.clientIp`: call from one of the networks allowed for the key, or use a key that allows this one.

  • 403ACCOUNT_NOT_ACTIVE

    Tu organización está suspendida o cerrada.

    Mensaje que devuelve la API: The organization associated with this API key is not active. Please contact support.

Límites de uso

  • 429Se excedió el límite de solicitudes.
  • 429RATE_TPS_EXCEEDED

    Excediste el cupo de tu organización para este endpoint.

    Mensaje que devuelve la API: You have exceeded the allowed request rate for this endpoint. Please wait before retrying.

Recurso inexistente

Este endpoint no declara respuestas de este tipo.

Errores internos y disponibilidad

  • 503Almacenamiento no responde en este momento. Reintenta tras Retry-After.

Otras respuestas

Este endpoint no declara respuestas de este tipo.

Ver en el catálogo de errores

Consideraciones especiales

Los archivos piden una key con Almacenamiento

Los archivos pueden ser grabaciones de llamadas, audios o documentos de tu organización. Los ve cualquier API key con el servicio Almacenamiento (storage), y solo el propietario de tu organización crea las keys. Sin el servicio, la key recibe 403 AUTH_SERVICE_NOT_ALLOWED aquí y en las demás rutas de Almacenamiento.

Solo consulta; el almacenamiento nunca se pausa

Tus archivos se guardan de forma continua y nunca se pausan, aunque no tengas saldo. Para consultarlos por API, la API key necesita el servicio Almacenamiento (storage): con él ve todo (resumen, consumo, archivos, descargas, conservación y tarifa) y sin él cada una de estas rutas responde 403 AUTH_SERVICE_NOT_ALLOWED. La API es solo de consulta: el tiempo de conservación se cambia desde el portal de clientes (Almacenamiento → Conservación) y un archivo se elimina desde ahí o cuando vence. Cualquier método que no sea GET responde 405.

Documentación relacionada

¿Necesitas ayuda?

¿Te sirvió esta página?

Ver todos los canales de soporte

Pide ayuda sobre esto: este endpoint

Armamos un mensaje con los datos que ayudan a revisar tu caso. Léelo, complétalo y envíalo tú: no se manda nada solo.

El mensaje nunca lleva tu clave de API ni contraseñas.

Tus preferencias de cookies

Tú decides qué medimos. Puedes cambiar tu elección cuando quieras. Rechazar no te quita ninguna función de la documentación.

Política de privacidad