https://api.getincloud.online/jacaerys/v1/forwards/by-origin/{origin}Listar procesos de reenvío por origen
Recupera los procesos de reenvío asociados a un origen específico.
GET https://api.getincloud.online/jacaerys/v1/forwards/by-origin/{origin}Permite recuperar todos los procesos de reenvío asociados a un origen (shortcode, longcode o ID alfanumérico). Es útil para visualizar todas las reglas y palabras clave configuradas para un número de entrada.
Parámetros de la ruta
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| origin | string | Sí | Código corto, número largo o identificador alfanumérico del cual se desean listar los procesos. |
Pará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 los procesos asociados 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 (Bearer token). Formato: Bearer <TU_TOKEN>. |
| accept | string | No | application/json. |
Respuestas
- 200 OK: la solicitud fue exitosa.
- items (array de objetos): procesos de reenvío vinculados al origen. Cada objeto contiene:
- id (string): identificador único del proceso.
- name (string): nombre descriptivo del proceso.
- keyword (string): palabra clave de activación.
- targetUrl (string): URL de destino para el reenvío.
- status (string): estado actual (ej. ACTIVE, PAUSED).
- externalId (string): identificador de sistema externo.
- clientId (string): ID del cliente.
- meta (objeto): datos de paginación.
- totalItems (integer): total de registros encontrados.
- itemCount (integer): elementos en la respuesta actual.
- itemsPerPage (integer): límite de elementos por página.
- totalPages (integer): total de páginas.
- currentPage (integer): página actual.
- 400 Bad Request: formato de origen incorrecto o parámetros de consulta malformados.
- 401 Unauthorized: el token proporcionado es inválido o ha expirado.
- 403 Forbidden: el usuario no tiene permisos para acceder a los procesos de este origen.
- 404 Not Found: no se encontraron procesos de reenvío para el origin proporcionado.
- 500 Internal Server Error: error inesperado en el servidor.
Notas técnicas
- Gestión de orígenes: este endpoint devuelve únicamente los procesos de reenvío. Si el origen fue desactivado globalmente, los procesos listados podrían aparecer con su estado individual, pero no ejecutarán el reenvío hasta que el origen sea habilitado.
- Codificación: el contenido de los mensajes entrantes que activan estos procesos puede variar en codificación (GSM-7 o Unicode) según el operador de origen. Debe considerarse al procesar la data en su targetUrl.
- Uso de filtros: clientId y externalId ayudan a segmentar la búsqueda cuando un mismo origen es compartido por varios departamentos o sub-clientes.
Ejemplo de solicitud
curl --request GET \
--url 'https://api.getincloud.online/jacaerys/v1/forwards/by-origin/141518?page=1&limit=10' \
--header 'accept: application/json' \
--header 'Authorization: Bearer YOUR_TOKEN'Respuesta 200 OK
{
"items": [
{
"id": "fwd_001",
"name": "Campaña Verano",
"keyword": "SOL",
"targetUrl": "https://tu-servidor.com/mo",
"status": "ACTIVE",
"externalId": "ext-7788",
"clientId": "client_1"
},
{
"id": "fwd_002",
"name": "Soporte Técnico",
"keyword": "AYUDA",
"targetUrl": "https://tu-servidor.com/help",
"status": "PAUSED",
"externalId": "ext-9900",
"clientId": "client_1"
}
],
"meta": {
"totalItems": 2,
"itemCount": 2,
"itemsPerPage": 10,
"totalPages": 1,
"currentPage": 1
}
}