Hablame

Referencia de la API

36 endpoints, cada uno con su alcance, sus límites, los errores que puede devolver y un panel Try-It para probarlo con tu propia API key.

Descargar OpenAPIhttps://developers.hablame.co/api/v6

Utilidades

Endpoints de diagnóstico, disponibles para cualquier API key. Sirven para verificar que tus credenciales quedaron bien conectadas.

GET/api/v6/utilities/ping

Ping

Confirma que tu API key es válida y muestra lo que la API sabe de quien llama.

Cualquier API key válida · 20 solicitudes por minuto

Herramientas

Catálogos de propósito general que puedes consumir desde tu aplicación. Disponibles para cualquier API key.

GET/api/v6/tools/countries

Listar países

Catálogo completo de países con código ISO, código telefónico y MCC.

Cualquier API key válida · 60 solicitudes por minuto

GET/api/v6/tools/countries/{code}

Obtener un país

Datos de un país por su código ISO 3166-1 alpha-2.

Cualquier API key válida · 60 solicitudes por minuto

Number Insight

Resuelve un número telefónico: país, tipo de línea, operador actual (en Colombia siguiendo portabilidad) y área. Uno a uno o por lote.

GET/api/v6/numberinsight/{number}

Consulta de un número

País, tipo de línea, operador actual y área de un número telefónico.

Cualquier API key válida · 60 solicitudes por minuto

POST/api/v6/numberinsight/batch

Consulta por lote

Resuelve muchos números en una sola solicitud, en línea o como trabajo asíncrono.

Cualquier API key válida · 10 solicitudes por minuto

GET/api/v6/numberinsight/batch/{jobId}

Estado de un lote

Estado de un trabajo asíncrono y URL de descarga del resultado.

Cualquier API key válida · 60 solicitudes por minuto

Acortador de URLs

Crea y administra enlaces cortos en tus dominios y consulta su analítica de clics.

POST/api/v6/urlshortener/links

Crear un enlace corto

Publica un enlace corto con código generado o alias propio. Se cobra al crearlo, salvo que tu plan lo incluya.

API key con el servicio urlshortener habilitado y la capacidad urlshortener.write concedida · 35 solicitudes por segundo

POST/api/v6/urlshortener/links/batch

Crear enlaces cortos en lote

Hasta 1.000 enlaces en una petición, con un resultado por enlace y un solo cobro por lo que se creó.

API key con el servicio urlshortener habilitado y la capacidad urlshortener.write concedida · 35 solicitudes por segundo

GET/api/v6/urlshortener/links

Listar enlaces cortos

Tus enlaces paginados, con búsqueda, filtros, orden y sus contadores de visitas.

API key con el servicio urlshortener habilitado · 30 solicitudes por minuto

GET/api/v6/urlshortener/domains

Listar dominios disponibles

Dominios donde tu organización puede publicar enlaces, con el predeterminado primero.

API key con el servicio urlshortener habilitado · 30 solicitudes por minuto

GET/api/v6/urlshortener/links/{domain}/{code}

Obtener un enlace corto

Un enlace tuyo por dominio y código.

API key con el servicio urlshortener habilitado · 60 solicitudes por minuto

PATCH/api/v6/urlshortener/links/{domain}/{code}

Actualizar un enlace corto

Cambia el destino, el estado o el vencimiento. El dominio y el código no cambian.

API key con el servicio urlshortener habilitado y la capacidad urlshortener.write concedida · 35 solicitudes por segundo

DELETE/api/v6/urlshortener/links/{domain}/{code}

Eliminar un enlace corto

El enlace deja de redirigir y desaparece de la API. Su código queda ocupado, y lo puedes restaurar durante 90 días.

API key con el servicio urlshortener habilitado y la capacidad urlshortener.write concedida · 35 solicitudes por segundo

POST/api/v6/urlshortener/links/{domain}/{code}/restore

Restaurar un enlace eliminado

Devuelve a la vida un enlace tuyo que eliminaste, con el mismo código y sin nuevo cobro.

API key con el servicio urlshortener habilitado y la capacidad urlshortener.write concedida · 35 solicitudes por segundo

GET/api/v6/urlshortener/links/{domain}/{code}/stats

Estadísticas del enlace

Totales del rango, serie por día o por hora y desgloses por país, dispositivo, sistema, navegador u origen.

API key con el servicio urlshortener habilitado · 120 solicitudes por minuto

GET/api/v6/urlshortener/overview

Resumen de la organización

Inventario, actividad del rango frente al periodo anterior, evolución, más visitados y desgloses de toda tu organización.

API key con el servicio urlshortener habilitado · 120 solicitudes por minuto

GET/api/v6/urlshortener/pricing

Precio vigente

Cuánto le cuesta a tu organización crear un enlace y cada visita, y si su plan lo incluye.

API key con el servicio urlshortener habilitado · 60 solicitudes por minuto

Text-to-Speech

Convierte texto en audio con voces naturales, reutiliza automáticamente un audio idéntico ya generado y consulta el estado de cada solicitud.

POST/api/v6/tts/synthesize

Sintetizar texto a voz

Convierte un texto en audio y devuelve su referencia. Síncrono.

API key con el servicio tts habilitado · 60 solicitudes por minuto

GET/api/v6/tts/synthesis/{id}

Estado de una síntesis

Metadatos de una solicitud de síntesis por su id.

API key con el servicio tts habilitado · 120 solicitudes por minuto

GET/api/v6/tts/voices

Listar voces disponibles

Catálogo de voces para síntesis, filtrable.

API key con el servicio tts habilitado · 120 solicitudes por minuto

Call Blasting

Llamadas de voz salientes con audio pregrabado o texto a voz, con reintentos configurables y estado por intento.

POST/api/v6/callblasting/calls

Llamada con voz generada

Envía una llamada que reproduce un audio generado por texto a voz.

API key con el servicio callblasting habilitado · 60 solicitudes por minuto

POST/api/v6/callblasting/calls/audio

Llamada con audio pregrabado

Envía una llamada que reproduce un audio pregrabado, ya subido o en el mismo paso.

API key con el servicio callblasting habilitado · 60 solicitudes por minuto

GET/api/v6/callblasting/calls/{id}

Estado de una llamada

Estado de la llamada y el histórico de todos sus intentos.

API key con el servicio callblasting habilitado · 120 solicitudes por minuto

POST/api/v6/callblasting/audios

Subir un audio pregrabado

Deja un audio en tu catálogo para reutilizarlo en cuantas llamadas quieras.

API key con el servicio callblasting habilitado · 30 solicitudes por minuto

GET/api/v6/callblasting/audios

Listar audios pregrabados

Los audios de tu organización con su id, duración y tamaño.

API key con el servicio callblasting habilitado · 60 solicitudes por minuto

GET/api/v6/callblasting/voices

Listar voces disponibles

Catálogo de voces para la síntesis de las llamadas, filtrable.

API key con el servicio callblasting habilitado · 120 solicitudes por minuto

Cuenta

Resumen de facturación de la organización: saldo o cupo, topes de gasto y movimientos. Información financiera sensible.

GET/api/v6/account/billing

Resumen de facturación

Modalidad, moneda y saldo disponible o cupo restante de la organización.

API key con la capacidad account concedida · 20 solicitudes por minuto

GET/api/v6/account/usage

Consumo por scope

Consumo del periodo desglosado por organización, centro de costo, usuario, clave y servicio.

API key con la capacidad account concedida · 20 solicitudes por minuto

GET/api/v6/account/payments

Historial de pagos

Recargas de saldo prepago y pagos de factura postpago, en una sola fuente.

API key con la capacidad account concedida · 30 solicitudes por minuto

GET/api/v6/account/adjustments

Ajustes de saldo

Ajustes manuales de saldo aplicados a la cuenta.

API key con la capacidad account concedida · 30 solicitudes por minuto

GET/api/v6/account/limits

Topes de gasto

Topes de gasto activos de la cuenta, por scope. Solo lectura.

API key con la capacidad account concedida · 30 solicitudes por minuto

Organización

Perfil de la organización, centros de costo y usuarios. Incluye datos personales.

GET/api/v6/account/organization

Organización

Perfil de la organización dueña de la API key.

API key con la capacidad directory concedida · 60 solicitudes por minuto

GET/api/v6/account/cost-centers

Centros de costo

Centros de costo de la organización, con el predeterminado marcado.

API key con la capacidad directory concedida · 60 solicitudes por minuto

GET/api/v6/account/users

Usuarios

Miembros de la organización, con rol, centro de costo y estado.

API key con la capacidad directory concedida · 30 solicitudes por minuto

Plataforma

Estado operativo de los servicios y catálogo de lo que tu cuenta tiene habilitado.

GET/api/v6/status

Estado de servicios

Estado operativo de los servicios, en forma compacta para tu monitoreo.

Cualquier API key válida · 60 solicitudes por minuto

GET/api/v6/catalog/services

Catálogo de servicios

Servicios vivos de la plataforma y si esta cuenta tiene acceso a cada uno.

Cualquier API key válida · 60 solicitudes por minuto