POST
https://api.getincloud.online/jacaerys/v1/forwards/keyword-validationVerificar disponibilidad de palabra clave
Valida si una palabra clave está disponible en un origen antes de crear un proceso de reenvío.
API de Mensajería
Necesitas una clave de API. Pídela a nuestro equipo de soporte o créala desde la plataforma.
Este endpoint te permite verificar si una palabra clave específica está disponible para usarse en un origen determinado antes de intentar crear un proceso de reenvío. A diferencia de otros métodos de verificación, este se centra en la validación lógica y la disponibilidad en tiempo real dentro del inventario del cliente.
POST https://api.getincloud.online/jacaerys/v1/forwards/keyword-validationParámetros del cuerpo
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| origin | string | Sí | Código corto (short code), número largo (long code) o ID alfanumérico que deseas validar. |
| keyword | string | Sí | Palabra clave específica que deseas verificar. |
| clientId | string | No | Identificador único del cliente asociado con la solicitud. |
| externalId | string | No | Identificador único de tu sistema para esta solicitud de validación. |
| string | No | Dirección de correo asociada para auditoría o registro. | |
| callbackUrl | string | No | URL para recibir una respuesta asíncrona si el sistema requiere una validación extendida. |
Respuestas
| Código | Descripción |
|---|---|
| 200 OK | La validación se procesó correctamente. Devuelve available (boolean, true si la palabra clave se puede usar, false si no) y message (string, descripción detallada del resultado). |
| 400 Bad Request | Solicitud inválida. Faltan parámetros obligatorios como origin o keyword, o su formato es incorrecto. |
| 401 Unauthorized | El token Bearer es inválido, falta o ha expirado. |
| 403 Forbidden | El usuario no tiene permisos para validar en el origen especificado o el acceso está restringido para su clientId. |
| 404 Not Found | El origen especificado no existe o no está asignado a tu cuenta. |
| 409 Conflict | La palabra clave ya existe y está asignada de forma exclusiva, lo que genera un conflicto de duplicidad inmediata. |
| 500 Internal Server Error | Error inesperado en el servidor durante la validación. |
Notas técnicas
- Reglas de sintaxis: las palabras clave deben cumplir las regulaciones locales del país del origen. Por ejemplo, algunas regiones prohíben palabras clave relacionadas con contenido para adultos o juegos de azar.
- Codificación: si la palabra clave contiene caracteres especiales (acentos, símbolos no GSM), el procesamiento del mensaje entrante relacionado podría verse afectado por la codificación Unicode, aunque esto es más crítico en el envío de mensajes (MT) que en la recepción y validación de palabras clave.
- Latencia de registro: una vez que una palabra clave se valida como disponible, se recomienda crear el proceso de reenvío de inmediato para evitar que otro usuario la reserve.
Ejemplos
Solicitud
curl --request POST \
--url https://api.getincloud.online/jacaerys/v1/forwards/keyword-validation \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'Authorization: Bearer YOUR_TOKEN' \
--data '
{
"origin": "87070",
"keyword": "OFERTA",
"clientId": "client_abc_123",
"externalId": "val-9988",
"email": "dev@empresa.com"
}
'Respuesta 200 OK
{
"available": true,
"message": "Keyword is available for the specified origin.",
"externalId": "val-9988"
}Respuesta 409 Conflict
{
"available": false,
"message": "Keyword is already in use by another process.",
"error_code": "KEYWORD_ALREADY_EXISTS"
}¿Te sirvió esta página?