Listar procesos de reenvío por origen (List Origin Forward Processes)

Lista todos los procesos de reenvío y palabras clave configurados para un origen específico.

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 todos los procesos de reenvío asociados a un origen específico (shortcode, longcode o ID alfanumérico). Es útil para visualizar todas las reglas y palabras clave configuradas para un número de entrada determinado.

GET https://api.getincloud.online/jacaerys/v1/forwards/by-origin/{origin}

Parámetros de 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

Campo	Tipo	Descripción
items	array de objetos	Lista de procesos de reenvío vinculados al origen.
items[].id	string	Identificador único del proceso.
items[].name	string	Nombre descriptivo del proceso.
items[].keyword	string	Palabra clave de activación.
items[].targetUrl	string	URL de destino para el reenvío.
items[].status	string	Estado actual (ej. ACTIVE, PAUSED).
items[].externalId	string	Identificador de sistema externo.
items[].clientId	string	ID del cliente.
meta	objeto	Datos de paginación.
meta.totalItems	integer	Total de registros encontrados.
meta.itemCount	integer	Elementos en la respuesta actual.
meta.itemsPerPage	integer	Límite de elementos por página.
meta.totalPages	integer	Total de páginas.
meta.currentPage	integer	Página actual.

Errores

Código	Descripción
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 y advertencias

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. Tenlo en cuenta al procesar los datos en tu targetUrl.
Uso de filtros: clientId y externalId ayudan a segmentar la búsqueda cuando un mismo origen es compartido por varios departamentos o subclientes.

Ejemplo de solicitud

curl --request GET \
 --url 'https://api.getincloud.online/jacaerys/v1/forwards/by-origin/141518?page=1&amp;limit=10' \
 --header 'accept: application/json' \
 --header 'Authorization: Bearer YOUR_TOKEN'

Respuesta de ejemplo (200 OK)

{
 &quot;items&quot;: [
 {
 &quot;id&quot;: &quot;fwd_001&quot;,
 &quot;name&quot;: &quot;Campaña Verano&quot;,
 &quot;keyword&quot;: &quot;SOL&quot;,
 &quot;targetUrl&quot;: &quot;https://tu-servidor.com/mo&quot;,
 &quot;status&quot;: &quot;ACTIVE&quot;,
 &quot;externalId&quot;: &quot;ext-7788&quot;,
 &quot;clientId&quot;: &quot;client_1&quot;
 },
 {
 &quot;id&quot;: &quot;fwd_002&quot;,
 &quot;name&quot;: &quot;Soporte Técnico&quot;,
 &quot;keyword&quot;: &quot;AYUDA&quot;,
 &quot;targetUrl&quot;: &quot;https://tu-servidor.com/help&quot;,
 &quot;status&quot;: &quot;PAUSED&quot;,
 &quot;externalId&quot;: &quot;ext-9900&quot;,
 &quot;clientId&quot;: &quot;client_1&quot;
 }
 ],
 &quot;meta&quot;: {
 &quot;totalItems&quot;: 2,
 &quot;itemCount&quot;: 2,
 &quot;itemsPerPage&quot;: 10,
 &quot;totalPages&quot;: 1,
 &quot;currentPage&quot;: 1
 }
}

AnteriorListar procesos de reenvío por origen SiguienteListar propietarios de origen

¿Te sirvió esta página?