GET
https://api.getincloud.online/jacaerys/v1/forwards/keywordsListar palabras clave del usuario (List User Keywords)
Recupera todas las palabras clave asociadas a la cuenta del usuario en los procesos 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 recupera la lista de todas las palabras clave (keywords) asociadas a la cuenta del usuario. Sirve para tener una visión general de los términos de activación configurados en los distintos procesos de reenvío.
GET https://api.getincloud.online/jacaerys/v1/forwards/keywordsParámetros de consulta
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| page | integer | No | Número de página para la paginación. |
| limit | integer | No | Cantidad de registros por página. |
| clientId | string | No | Filtra las palabras clave asociadas a un identificador de cliente específico. |
| externalId | string | No | Filtra los resultados según un identificador de sistema externo. |
Encabezados
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| Authorization | string | Sí | Token de portador. Formato: Bearer <YOUR_TOKEN>. |
| accept | string | No | application/json. |
Respuestas
200 OK
| Campo | Tipo | Descripción |
|---|---|---|
| keywords | array de objetos | Lista de palabras clave encontradas. |
| keywords[].keyword | string | Texto de la palabra clave. |
| keywords[].origin | string | Código corto o número largo al que está vinculada. |
| keywords[].processId | string | Identificador único del proceso de reenvío que usa esta palabra clave. |
| meta | objeto | Datos de paginación. |
| meta.totalItems | integer | Total de palabras clave encontradas. |
| meta.itemCount | integer | Cantidad de elementos en la respuesta actual. |
| meta.itemsPerPage | integer | Límite de elementos por página. |
| meta.totalPages | integer | Total de páginas disponibles. |
| meta.currentPage | integer | Página actual. |
Errores
| Código | Descripción |
|---|---|
| 400 Bad Request | Parámetros de consulta mal formateados. |
| 401 Unauthorized | El token Bearer es inválido, ha expirado o no se proporcionó. |
| 403 Forbidden | El usuario no tiene permisos para acceder a la lista de palabras clave de este cliente o entorno. |
| 404 Not Found | No se encontraron palabras clave con los criterios especificados. |
| 500 Internal Server Error | Error inesperado en el servidor. |
Notas técnicas y advertencias
- Unicidad: dentro de un mismo
origin, las palabras clave deben ser únicas. Este listado permite verificar qué términos ya están ocupados. - Codificación y sensibilidad: aunque las palabras clave se almacenan como cadenas de texto, el sistema suele tratarlas sin distinguir mayúsculas de minúsculas (case-insensitive). Se recomienda mantener la consistencia en el registro.
- Segmentación y codificación: las palabras clave con caracteres especiales pueden influir en la lógica de coincidencia si el terminal del usuario final envía el mensaje en una codificación distinta (como Unicode en lugar de GSM-7).
Ejemplo de solicitud
curl --request GET \
--url 'https://api.getincloud.online/jacaerys/v1/forwards/keywords?page=1&limit=10' \
--header 'accept: application/json' \
--header 'Authorization: Bearer YOUR_TOKEN'Respuesta de ejemplo (200 OK)
{
"keywords": [
{
"keyword": "PROMO",
"origin": "87070",
"processId": "fwd_123456789"
},
{
"keyword": "AYUDA",
"origin": "87070",
"processId": "fwd_987654321"
}
],
"meta": {
"totalItems": 2,
"itemCount": 2,
"itemsPerPage": 10,
"totalPages": 1,
"currentPage": 1
}
}¿Te sirvió esta página?