Nombre
Consultar un archivo
El detalle de un archivo de tu organización.
Método HTTP y ruta
/https:
Qué pasa al ejecutarlo
- Solo consulta: no cambia datos de tu organización.
- La llamada no se cobra.
Qué hace
Devuelve un archivo, con la misma forma que en el listado.
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.
Autenticación y permisos
- Envía tu API key en la cabecera
Authorizationcon 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
| Nombre | Tipo | Descripción y reglas |
|---|---|---|
idObligatorio | string | Identificador del archivo, tal como llega en el listado. Patrón: |
Parámetros de consulta
Este endpoint no tiene parámetros de consulta.
Encabezados HTTP
| Nombre | Tipo | Descripción y reglas |
|---|---|---|
AuthorizationObligatorio | string | Tu API key con el esquema Bearer. Ejemplo: |
Cuerpo de la petición
Este endpoint no recibe cuerpo en la petición.
Respuestas satisfactorias
200
El archivo.
Esta respuesta no trae cuerpo.
Campos de la respuesta
| Nombre | Tipo | Descripción y reglas |
|---|---|---|
successSiempre presente | boolean | |
dataSiempre presente | object | Un archivo. Nunca trae el bucket, la ruta interna ni identificadores consecutivos. |
data.Siempre presente | string | Identificador del archivo. Ejemplo: |
data.Siempre presente | string | Nombre original, si el servicio lo guardó. Puede llegar en |
data.Siempre presente | string | Servicio que lo guardó. |
data.Siempre presente | string | Tipo de archivo dentro del servicio. |
data.Siempre presente | integer | Tamaño en bytes. |
data.Siempre presente | string | Tipo MIME. |
data.Siempre presente | string | Cuándo quedó guardado (ISO-8601, hora de Colombia, con milisegundos). Puede llegar en Formato: |
data.Siempre presente | string | Cuándo se elimina según el tiempo de conservación vigente, o Puede llegar en Formato: |
data.Siempre presente | string |
Valores permitidos: |
data.Siempre presente | boolean | Si su tipo de archivo permite eliminarlo desde el portal antes de que venza. |
metaSiempre presente | object | Metadatos de la respuesta. |
meta.Siempre presente | string | Identificador único de la solicitud (16 caracteres hexadecimales). Es el mismo de la cabecera Ejemplo: |
meta.Siempre presente | string | IP con la que la API vio tu solicitud. Útil si tu API key solo admite ciertas redes. Ejemplo: |
meta.Siempre presente | string | Fecha y hora en que se construyó la respuesta (ISO 8601 con offset). Formato: |
meta.Siempre presente | number | Tiempo (ms) que tomó procesar la solicitud en el servidor. Ejemplo: |
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
| Nombre | Tipo | Descripción y reglas |
|---|---|---|
successSiempre presente | boolean | Valor fijo: |
metaSiempre presente | object | Metadatos de la respuesta. |
meta.Siempre presente | string | Identificador único de la solicitud (16 caracteres hexadecimales). Es el mismo de la cabecera Ejemplo: |
meta.Siempre presente | string | IP con la que la API vio tu solicitud. Útil si tu API key solo admite ciertas redes. Ejemplo: |
meta.Siempre presente | string | Fecha y hora en que se construyó la respuesta (ISO 8601 con offset). Formato: |
meta.Siempre presente | number | Tiempo (ms) que tomó procesar la solicitud en el servidor. Ejemplo: |
errorSiempre presente | object | |
error.Siempre presente | string | Identificador estable en UPPER_SNAKE_CASE. Los clientes ramifican sobre este valor. Ejemplo: |
error. | integer | Código numérico legacy v5, solo cuando hay puente. Se omite en los códigos nacidos en v6. Ejemplo: |
error.Siempre presente | string | URL a la documentación del error. Formato: |
error.Siempre presente | string | Texto legible en inglés. Es para el log del desarrollador, no para el usuario final: no lo parsees. |
error.Siempre presente | array<object> | Contexto estructurado (validaciones, recurso afectado). Arreglo vacío cuando no hay contexto extra. |
Validación
Este endpoint no declara respuestas de este tipo.
Autenticación
- 401Credenciales inválidas o faltantes.
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>`.
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.
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.
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.
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.
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
- 404El archivo no existe para tu organización. Es la misma respuesta para un archivo que nunca existió, uno de otra organización, uno ya eliminado o un
idmal formado.
El archivo no existe para tu organización.
Errores internos y disponibilidad
- 503Almacenamiento no responde en este momento. Reintenta tras
Retry-After.
503 genérico: un servicio del que dependemos no responde.
Otras respuestas
Este endpoint no declara respuestas de este tipo.
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.