POST
https://api.getincloud.online/raven/v3/forward-processes/keyword-usageVerificar uso de palabra clave
Comprueba si una palabra clave ya está en uso por un proceso de reenvío para un origen determinado.
API de Mensajería
Necesitas una clave de API. Pídela a nuestro equipo de soporte o créala desde la plataforma.
Este endpoint permite verificar si una palabra clave específica ya está siendo utilizada por un proceso de reenvío para un origen determinado. Es útil para validar la disponibilidad antes de crear un nuevo proceso de reenvío.
POST https://api.getincloud.online/raven/v3/forward-processes/keyword-usageParámetros del cuerpo
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| origin | string | Sí | Código corto, número largo o ID alfanumérico que deseas consultar. |
| keyword | string | Sí | Palabra clave cuya disponibilidad deseas verificar en el origen especificado. |
| clientId | string | No | Identificador único del cliente para filtrar la búsqueda dentro de un contexto de cliente específico. |
| externalId | string | No | Identificador externo relacionado con la consulta. |
Respuestas
200 OK
La consulta se realizó con éxito e indica si la palabra clave está en uso.
| Campo | Tipo | Descripción |
|---|---|---|
| isUsed | boolean | true si la palabra clave ya está asignada a un proceso de reenvío para ese origen, o false si está disponible. |
| processId | string (opcional) | Si isUsed es true, ID del proceso de reenvío que usa la palabra clave. |
| name | string (opcional) | Nombre del proceso de reenvío existente, si aplica. |
400 Bad Request
La solicitud es inválida. Puede ocurrir si faltan los parámetros requeridos origin o keyword.
{
"error": "Missing required parameters: origin, keyword"
}401 Unauthorized
Error de autenticación. El token no es válido, falta o ha expirado.
500 Internal Server Error
Error inesperado en el servidor al verificar el uso de la palabra clave.
Notas técnicas
- Sensibilidad a mayúsculas y minúsculas: por lo general, las palabras clave no distinguen entre mayúsculas y minúsculas, pero se recomienda hacer la verificación en el formato exacto en que planeas registrarla.
- Disponibilidad: una palabra clave se considera "en uso" solo si existe un proceso de reenvío activo o pausado vinculado a ella.
Ejemplo de solicitud
curl --request POST \
--url https://api.getincloud.online/raven/v3/forward-processes/keyword-usage \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'Authorization: Bearer <TU_TOKEN>' \
--data '
{
"origin": "87070",
"keyword": "AYUDA",
"clientId": "client_abc_123"
}
'¿Te sirvió esta página?