Glosario
Los términos que usa esta documentación, explicados en lenguaje claro.
- Acortador de URLs
- Servicio que crea enlaces cortos que redirigen a una URL de destino y cuenta sus visitas.
- acuse de entrega
- Aviso con el estado final que conocemos de tu mensaje. No garantiza que el mensaje se haya leído en el teléfono.
- capacidad
- Permiso sobre la cuenta que se concede a una clave de API al crearla, aparte de los servicios, por ejemplo
directorypara leer los datos de la organización. - centro de costo
- Unidad de tu organización a la que se atribuye el consumo. Cada clave de API está vinculada a uno. Es el mismo término que usa Cloud.
- clave de API
- Credencial secreta que identifica a tu organización en cada petición. Va en la cabecera
Authorization:y empieza porBearer hk_. Se crea en Cloud. - código corto
- Número corto asignado a tu organización al que las personas envían SMS. En el webhook de SMS entrantes llega en el campo
shortCode. - conexión SMPP
- Sesión abierta con el servidor SMPP. Puede ser de envío (transmitter), de recepción (receiver) o de las dos cosas (transceiver).
- conservación
- Tiempo durante el que se guarda un dato antes de borrarse.
- destino del webhook
- URL HTTPS de tu sistema que recibe los eventos. Mientras Cloud no tenga pantalla para hacerlo, el equipo de Hablame la registra a pedido.
- envoltura
- Estructura JSON común de todas las respuestas de la API v6:
success,dataoerror, ymetacon elrequestId. - límite de uso
- Número máximo de solicitudes que puedes hacer en una ventana de tiempo. Al superarlo, la API responde 429 e indica cuándo reintentar.
- secreto de firma
- Secreto que empieza por
whsec_y sirve para verificar que un webhook lo envió Hablame. Nunca lo compartas ni lo pongas en el código del navegador. - SMS entrante
- Mensaje que una persona envía a tu código corto. Te llega por webhook con el evento
sms..mo. <código corto> system_id- Usuario de tu cuenta SMPP. Lo entrega soporte junto con la contraseña, que nunca debes compartir.Se escribe igual en los dos idiomas. Es un nombre del protocolo o del contrato.
- tope de gasto
- Monto máximo de consumo que configura tu propia organización. Al alcanzarlo, las operaciones que se cobran se rechazan sin hacerse.
- Validación de números
- Servicio que consulta datos de un número de teléfono. Es su nombre público; la ruta de la API sigue siendo
/, porque la ruta es contrato y no se cambia.numberinsight