POST
https://api.getincloud.online/raven/v3/forward-processesCrear proceso de reenvío
Define cómo se manejan y redirigen los mensajes SMS entrantes (MO) según palabra clave u origen.
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 crear un nuevo proceso de reenvío. Un proceso de reenvío define cómo deben manejarse y redirigirse los mensajes entrantes (MO) según criterios específicos, como palabras clave o números de origen.
POST https://api.getincloud.online/raven/v3/forward-processesParámetros del cuerpo
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| name | string | Sí | Nombre descriptivo para identificar el proceso de reenvío. |
| origin | string | Sí | Código corto, número largo o ID alfanumérico al que llegarán los mensajes entrantes. |
| keyword | string | No | Palabra clave que activa este proceso. Si se deja en blanco, el proceso puede actuar como manejador por defecto para el origen. |
| targetUrl | string | Sí | URL del webhook a la que se reenviarán los datos del mensaje entrante. |
| type | string | No | Tipo de proceso. Valores comunes: HTTP_POST, HTTP_GET o EMAIL. |
| status | string | No | Estado inicial del proceso. Por defecto es ACTIVE. |
| externalId | string | No | Identificador único de tu sistema para este proceso. |
| clientId | string | No | Identificador único del cliente asociado con este proceso. |
| string | No | Correo electrónico para recibir notificaciones relacionadas con este proceso. | |
| callbackUrl | string | No | URL adicional para recibir confirmaciones de procesamiento del reenvío. |
Respuestas
201 Created
El proceso de reenvío se creó con éxito.
| Campo | Tipo | Descripción |
|---|---|---|
| id | string | Identificador único asignado al nuevo proceso. |
| name | string | Nombre del proceso creado. |
| origin | string | Origen configurado. |
| keyword | string | Palabra clave asignada. |
| status | string | Estado actual del proceso. |
| created_at | string | Marca de tiempo de la creación (formato ISO 8601). |
400 Bad Request
La solicitud es inválida. Puede ocurrir si faltan campos obligatorios o si el origen o la palabra clave ya están en uso por otro proceso.
{
"error": "Keyword already in use for this origin"
}401 Unauthorized
Fallo de autenticación. El token Bearer es inválido o no tiene permisos para crear procesos en este entorno.
500 Internal Server Error
Error inesperado en el servidor durante la creación del proceso.
Notas técnicas
- Prioridad de palabras clave: si existen múltiples procesos para el mismo origen, el sistema prioriza la coincidencia exacta de la keyword.
- Seguridad del webhook: asegúrate de que tu targetUrl esté preparada para recibir peticiones POST con un cuerpo JSON que contiene los detalles del mensaje entrante (remitente, texto, marca de tiempo).
Ejemplo de solicitud
curl --request POST \
--url https://api.getincloud.online/raven/v3/forward-processes \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'Authorization: Bearer <TU_TOKEN>' \
--data '
{
"name": "Reenvío de Promociones",
"origin": "87070",
"keyword": "PROMO",
"targetUrl": "https://tu-servidor.com/webhook/sms-mo",
"type": "HTTP_POST",
"externalId": "ext-proc-001",
"clientId": "client_123"
}
'¿Te sirvió esta página?