Este repositorio contiene ejemplos de código en Shell Script utilizando cURL para interactuar con la API de Onurix. Está diseñado para ayudarte a integrar fácilmente los servicios de Onurix (SMS, Llamadas, WhatsApp, etc.) en tus aplicaciones o scripts de shell.
- Ejemplos de Cliente API de Onurix con cURL (Shell Script)
Antes de empezar, asegúrate de tener instalado lo siguiente:
- cURL (generalmente preinstalado en sistemas Unix/Linux y macOS)
- Un entorno de Shell Script (Bash, Zsh, etc.)
Los ejemplos de código están organizados en carpetas que corresponden a las diferentes categorías de la API de Onurix. Las peticiones a la API se realizan comúnmente mediante HTTP POST o GET. Para los envíos de WhatsApp, es necesario enviar los datos en formato JSON.
A continuación, se detalla cada endpoint de ejemplo y el método HTTP que utiliza:
| Archivo | Método | Descripción |
|---|---|---|
SendCall.sh |
POST |
Genera una llamada con un mensaje de voz. |
SendCALL2FA.sh |
POST |
Genera y entrega un código de verificación 2FA a través de una llamada. |
| Archivo | Método | Descripción |
|---|---|---|
Balance.sh |
GET |
Consulta el saldo de créditos de la cuenta. |
Security.sh |
POST |
Bloquea un número de teléfono para no recibir comunicaciones. |
VerificationCode2FA.sh |
POST |
Realiza la verificación de un código 2FA. |
VerificationMessage.sh |
GET |
Verifica el estado de un envío de SMS o llamada. |
| Archivo | Método | Descripción |
|---|---|---|
AssociateContactToGroup.sh |
POST |
Asocia un contacto a un grupo. |
ContactCreate.sh |
POST |
Crea un nuevo contacto. |
ContactDelete.sh |
POST |
Elimina un contacto. |
ContactGroupList.sh |
GET |
Lista los contactos de un grupo. |
ContactUpdate.sh |
POST |
Actualiza la información de un contacto. |
DissasociateContactToGroup.sh |
POST |
Desasocia un contacto de un grupo. |
GroupCreate.sh |
POST |
Crea un nuevo grupo de contactos. |
GroupDelete.sh |
POST |
Elimina un grupo de contactos. |
GroupList.sh |
GET |
Lista todos los grupos de la cuenta. |
GroupUpdate.sh |
POST |
Actualiza el nombre de un grupo. |
| Archivo | Método | Descripción |
|---|---|---|
SendSMS.sh |
POST |
Envía un mensaje de texto (SMS). |
SendSMS2FA.sh |
POST |
Envía un mensaje de texto (SMS) con un código de verificación 2FA. |
| Archivo | Método | Descripción |
|---|---|---|
Statistics.sh |
GET |
Obtiene las estadísticas de una URL corta. |
URLShortener.sh |
POST |
Crea una URL corta. |
| Archivo | Método | Descripción |
|---|---|---|
SendWhatsApp2FA.sh |
POST (JSON) |
Envía un mensaje de WhatsApp con un código de verificación 2FA. |
WhatsAppGeneralSend.sh |
POST (JSON) |
Envía un mensaje de WhatsApp usando una plantilla. |
SendWhatsAppWithoutTemplate.sh |
POST (JSON) |
Envía un mensaje de WhatsApp sin usar una plantilla. |
-
Clona el repositorio:
git clone https://github.com/onurixlatam/onurix-curl.git cd onurix-curl -
Navega al archivo del endpoint que deseas utilizar (ej.
sms/SendSMS.sh). -
Edita el archivo y reemplaza los valores de los placeholders como se explica en la sección de Configuración de Parámetros.
-
Asegúrate de que el script sea ejecutable (si no lo es):
chmod +x sms/SendSMS.sh
-
Ejecuta el script desde tu terminal:
./sms/SendSMS.sh
-
Verifica la respuesta que se imprimirá en la consola.
Para usar los ejemplos, necesitas reemplazar los valores de los placeholders (AQUI_...) con tus datos reales. A continuación, se detallan los parámetros que encontrarás en los scripts:
| Parámetro | Descripción |
|---|---|
client |
Tu ID de Cliente. Lo encuentras en tu panel de Onurix en Seguridad API. |
key |
Tu Llave de API. La encuentras en tu panel de Onurix en Seguridad API. |
| Parámetro | Descripción | Ejemplo |
|---|---|---|
phone |
Número de teléfono de destino. Para múltiples números, sepáralos por comas. | 573001234567 o 573001234567,573001234568 |
name |
Nombre para un contacto o grupo. | Mi Grupo |
lastname |
Apellido para un contacto. | Pérez |
email |
Correo electrónico de un contacto. | ejemplo@email.com |
id |
ID de un recurso (mensaje, contacto, grupo). | 12345 |
group-id |
ID de un grupo. | 6789 |
groups |
IDs de grupos separados por comas. | 1,2,3 |
app-name |
Nombre de la aplicación 2FA creada en Onurix. | MiApp |
| Servicio | Parámetro | Descripción |
|---|---|---|
| SMS | sms |
Contenido del mensaje de texto a enviar. |
| Llamadas | message |
Mensaje que se reproducirá en la llamada. |
| Llamadas | voice |
Voz a usar en la llamada (ej. Mariana, Penelope). |
| Llamadas | audio-code |
ID de un audio previamente cargado en la plataforma. |
| URL | url-long |
La URL original que deseas acortar. |
| URL | alias |
(Opcional) Alias personalizado para la URL corta. |
templateId |
ID de la plantilla de WhatsApp aprobada por Meta. | |
data |
Un objeto JSON con los valores para la plantilla. | |
from_phone_meta_id |
ID del teléfono de origen de WhatsApp. | |
message |
Objeto JSON con el mensaje a enviar. |
curl --location 'https://onurix.com/api/v1/send-sms' \
--form 'client="1"' \
--form 'key="********************"' \
--form 'phone="30012345678"' \
--form 'sms="Este es un mensaje de prueba del API de Onurix.com"'curl --location 'https://onurix.com/api/v1/whatsapp/send?key=************&client=1&templateId=123546' \
--header 'Content-Type: application/json' \
--data '{ "phones": "30012345678", "header": { "1": { "type": "image", "value": { "link": "https://tudominio.com/archivo-video.mp4" } } }, "body": { "1": { "type": "text", "value": "" }, "2": { "type": "text", "value": "" } }, "button": {} }'Para obtener una descripción detallada de todos los endpoints, parámetros y respuestas de la API, por favor consulta nuestra documentación oficial en https://docs.onurix.com/.
Este proyecto está bajo la Licencia MIT.
Para soporte y preguntas, no dudes en contactarnos:
- Email: soporte@onurix.com
- Website: https://onurix.com