node-red-contrib-vocalrec 1.0.5
Nodos personalizados de Node-RED para la API de VocalRec
node-red-contrib-vocalrec
Nodos personalizados de Node-RED para interactuar con la API REST de VocalRec.
Instalación
Para instalar este conjunto de nodos en su instancia de Node-RED, navegue hasta su directorio de usuario de Node-RED (normalmente ~/.node-red) y ejecute el siguiente comando:
npm install node-red-contrib-vocalrec
Alternativamente, puede instalarlo directamente desde la paleta de Node-RED.
Nodos Incluidos
Este paquete incluye los siguientes nodos:
- VocalRec Config: Nodo de configuración para establecer la conexión con el servidor VocalRec (Host, Puerto y Token de autenticación).
- Start Recording: Inicia una nueva grabación.
- Stop Recording: Detiene una grabación existente.
- Pause Recording: Pausa una grabación activa.
- Resume Recording: Reanuda una grabación pausada.
- Start Streaming: Inicia el streaming del audio de una grabación activa.
- Stop Streaming: Detiene el streaming activo de una una grabación.
- Status Recording: Obtiene el estado de una grabación.
- Find Transactions: Busca transacciones de grabación basadas en criterios de filtro.
- Metadata: Agrega metadatos a una transacción de grabación.
- Alias: Establece un identificador externo asociado a la grabación.
- Bookmark: Establece una etiqueta en el monento actual de la grabación.
- Discard: Descarta una grabación, elimianando los datos y ficheros asociados.
- Actualiza transaccion: Actualiza los campos de una transaccion.
- Audio url: Obtiene la url al fichero de audio de una transaccion.
- Call list: Obtiene la lista de llamadas activas.
- Channel List: Obtiene la lista de canales activos.
Configuración del Nodo VocalRec Config
Antes de usar cualquier nodo de VocalRec, debe configurar un nodo VocalRec Config:
- Arrastre un nodo
VocalRec Configa su flujo. - Haga doble clic en él para abrir sus propiedades.
- Ingrese el Host (dirección IP o nombre de dominio de su servidor VocalRec).
- Ingrese el Puerto (el puerto en el que VocalRec está escuchando, por defecto 80).
- Ingrese el Token de autenticación (si su API VocalRec requiere autenticación).
- Asigne un Nombre descriptivo a su configuración.
Uso de los Nodos
Cada nodo de VocalRec está diseñado para interactuar con una función específica de la API. La mayoría de los nodos requieren una configuración de servidor VocalRec y aceptan msg.payload como entrada para los parámetros de la API.
Ejemplo: Iniciar una Grabación
- Arrastre un nodo
injecty un nodoVocalRec Start Recordinga su flujo. - Conecte la salida del nodo
injecta la entrada del nodoVocalRec Start Recording. - Configure el nodo
VocalRec Start Recordingseleccionando su configuración de servidor VocalRec y, opcionalmente, proporcionando unNúmeroyProgram ID. - El
msg.payloadde entrada al nodoStart Recordingpuede contenernumberyProgramIdpara anular los valores predeterminados del nodo.
{
"number": "123456789",
"ProgramId": "mi_programa_grabacion"
}
- La salida del nodo
Start Recordingcontendrá la respuesta de la API, incluyendo el ID de la transacción de la grabación.
Contribuciones
Las contribuciones son bienvenidas. Por favor, abra un issue o envíe un pull request en el repositorio de GitHub.
Licencia
Este proyecto está bajo la licencia MIT. Consulte el archivo LICENSE para más detalles.
