Saturn Studio – Voximplant

📌 ¿Qué es este módulo?

Este módulo integra Voximplant, la plataforma en la nube para automatización de comunicaciones, directamente con Saturn Studio. Permite a los robots gestionar interacciones en tiempo real, como esperar y recibir llamadas, ejecutar escenarios de voz interactivos (IVR), y consultar historiales y números telefónicos.

Gracias a esta integración, puedes automatizar completamente las operaciones de un centro de contacto, crear sistemas de notificación por voz, o desarrollar flujos de trabajo complejos que se activan a partir de una llamada entrante, todo orquestado desde la lógica de un robot en Saturn Studio.

📚 Descripción de los comandos

A continuación se detallan los comandos disponibles para la integración con Voximplant:

🪝 Subscribe to Webhook

Suscribe un webhook a Voximplant para recibir eventos. (Este comando prepara la conexión para otros, como “Wait for a call”).

📥 Wait for a call

Espera una llamada entrante desde Voximplant.

Parámetro	Descripción	Ejemplo
Credential	Credencial de Voximplant necesaria para esperar mensajes.	credential
Simplify data	Simplifica los datos de la llamada.	true
Assign result to variable	Variable donde se almacenará el resultado.	{“call_id”: 356714616, “caller_number”: “12027731097”, “callee_number”: “1423561719409”, “callee_name”: “John”, “callee_lastname”: “Doe”, “callee_email”: “johndoe@example.com”, “direction”: “outgoing”, “start_time”: “2025-02-26T151527”, “duration”: 3, “status”: “unknown”, “record_url”: “”}

📜 Get Call History

Obtiene el historial de llamadas de una cuenta de Voximplant.

Parámetro	Descripción	Ejemplo
Credential	Credencial de Voximplant necesaria para obtener el historial.	credential
From Date	La fecha “desde” para obtener el historial.	20-02-2025
To Date	La fecha “hasta” para obtener el historial.	20-02-2025
Call ID	El ID de la llamada para obtener el historial.	2921787
Limit	El número máximo de registros a devolver.	10
Assign result to variable	Variable donde se almacenará el resultado.	{“success”:true,”result”:[{“id”:355384437,”attempt_num”:1,”calllist_item_id”:null,”domain_id”:17767,”session_id”:”1649024222″,”scenario_id”:45485,”datetime_start”:”2025-02-25 131922″,”phone_a”:”12027731097″,”phone_b”:”1433171659189″,”is_incoming”:false,”call_result_code”:1,”duration”:4,”record_url”:null,”call_cost”:”0.23375301″,”call_data”:”{“UTC”: “UTC”, “email”: “johndoe@Rocketbot.com”, “names”: “Juan”, “phone”: “1433171659189”, “asr_input”: “”, “lastnames”: “Pablo”}”,”call_resources”:”[{“cost”: 0.001153, “unit”: “”, “used_at”: “2025-02-25 131927”, “description”: “VoiceMail”, “resource_type”: “VOICEMAILDETECTION”, “transaction_id”: 32829863870004, “resource_quantity”: 1, “resource_usage_id”: 758004330}, {“cost”: 0.0126, “unit”: “”, “used_at”: “2025-02-25 131947”, “description”: “TextToSpeech”, “resource_type”: “TTS_TEXT_MICROSOFT”, “transaction_id”: 32829895880004, “resource_quantity”: 625, “resource_usage_id”: 758004329}]”,”call_calls”:”[{“cost”: 0.22, “call_id”: 1311309171, “duration”: 3, “incoming”: false, “start_time”: “2025-02-25 131947”, “successful”: true, “local_number”: “12027731097”, “remote_number”: “1433171659189”, “transaction_id”: 32829895780004, “remote_number_type”: “pstn”}]”,”call_records”:”[]”,”call_status”:false,”recalc”:true,”campaign_id”:null,”processing”:false,”scenario_version_id”:300456,”has_call_logs”:true,”user_id”:null,”dialing_time”:24,”completion_code”:”AMD”,”queue_id”:null,”user_group_id”:null,”callback_at”:null}],”_meta”:{“limit”:1,”cursor”:null}}

🔢 Get Numbers

Obtiene números de una cuenta de Voximplant.

Parámetro	Descripción	Ejemplo
Credential	Credencial de Voximplant necesaria para obtener números.	credential
Phone Number	El número de teléfono a obtener.	1433171659189
Assign result to variable	Variable donde se almacenará el resultado.	{“success”:true,”result”:[{“id”:8660,”domain_id”:17767,”auto_charge”:true,”can_be_used”:true,”category_name”:”GEOGRAPHIC”,”phone_country_code”:”US”,”phone_purchase_date”:”2024-02-27 094918″,”required_verification”:null,”verification_status”:”NOT_REQUIRED”,”deactivated”:false,”unverified_hold_until”:null,”canceled”:false,”phone_next_renewal”:”2025-02-27″,”phone_number”:”12027731097″,”phone_price”:”1.0000″,”phone_region_id”:null,”redirect_number”:null,”deleted”:false,”is_sms_enabled”:false,”is_sms_supported”:false,”description”:null,”allowed_callerids”:true}],”_meta”:{“totalCount”:1,”pageCount”:1,”currentPage”:1,”perPage”:20}}

▶️ Run Scenario

Ejecuta un escenario en Voximplant.

Parámetro	Descripción	Ejemplo
Credential	Credencial de Voximplant necesaria para ejecutar un escenario.	credential
Scenario ID	El ID del escenario a ejecutar.	2066
Caller ID	El ID de llamada (número) a utilizar.	2212003838
Variables	Variables a enviar al escenario.	[{“Name”: “John”, “Lastame”: “Doe”, “Age”: 30}]
Assign result to variable	Variable donde se almacenará el resultado.	{“success”: true,”result”: true}

🧪 Ejemplo de uso

• IVR de Atención al Cliente: Utilizar “Wait for a call” para recibir una llamada y “Run Scenario” para lanzar un menú de voz interactivo que guíe al cliente.
• Campañas de Voz: Crear un robot que lea una lista de clientes desde una base de datos y use “Run Scenario” en un bucle para llamar a cada uno y reproducir un mensaje promocional.
• Auditoría y Reportería: Programar un robot para que use “Get Call History” semanalmente para obtener todas las llamadas, calcular costos y duraciones, y generar un informe.
• Verificación Telefónica: Como parte de un proceso de registro, ejecutar un escenario que llame al usuario y le pida que ingrese un código en su teclado para validar su número.

🧩 Requisitos

1. Tener una cuenta activa en la plataforma Voximplant.
2. Disponer de las credenciales de API de Voximplant (como API Key, Account ID) para ser utilizadas en el parámetro Credential.
3. Haber configurado previamente las aplicaciones, reglas y escenarios de voz en el panel de control de Voximplant.
4. Conocer los IDs de los escenarios, llamadas o números para los comandos que requieran una consulta específica.