Ejemplos de Cliente API de Onurix en PHP

Este repositorio contiene ejemplos de código en PHP 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 PHP.

📋 Tabla de Contenido

• Ejemplos de Cliente API de Onurix en PHP
  • 📋 Tabla de Contenido
  • ⚙️ Prerrequisitos
  • 📂 Estructura del Repositorio
    • Calls
    • General
    • Groups and Contacts
    • SMS
    • URL
    • WhatsApp
  • 📖 Uso
  • ⚙️ Configuración de Parámetros
    • Credenciales de Autenticación (Obligatorias) POST o GET
    • Parámetros Comunes
    • Parámetros Específicos
    • Ejemplo de parámetros para sms/SendSMS.php
  • 📚 Documentación Completa de la API
  • 📄 Licencia
  • 📞 Soporte

⚙️ Prerrequisitos

Antes de empezar, asegúrate de tener instalado lo siguiente:

• PHP 7.0 y 8.0 o superior
• Composer (para gestionar las dependencias)

📂 Estructura del Repositorio

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:

Calls

Archivo	Método	Descripción
SendCall.php	POST	Genera una llamada con un mensaje de voz.
SendCALL2FA.php	POST	Genera y entrega un código de verificación 2FA a través de una llamada.

General

Archivo	Método	Descripción
Balance.php	GET	Consulta el saldo de créditos de la cuenta.
Security.php	POST	Bloquea un número de teléfono para no recibir comunicaciones.
VerificationCode2FA.php	POST	Realiza la verificación de un código 2FA.
VerificationMessage.php	GET	Verifica el estado de un envío de SMS o llamada.

Groups and Contacts

Archivo	Método	Descripción
AssociateContactToGroup.php	POST	Asocia un contacto a un grupo.
ContactCreate.php	POST	Crea un nuevo contacto.
ContactDelete.php	POST	Elimina un contacto.
ContactGroupList.php	GET	Lista los contactos de un grupo.
ContactUpdate.php	POST	Actualiza la información de un contacto.
DissasociateContactToGroup.php	POST	Desasocia un contacto de un grupo.
GroupCreate.php	POST	Crea un nuevo grupo de contactos.
GroupDelete.php	POST	Elimina un grupo de contactos.
GroupList.php	GET	Lista todos los grupos de la cuenta.
GroupUpdate.php	POST	Actualiza el nombre de un grupo.

SMS

Archivo	Método	Descripción
SendSMS.php	POST	Envía un mensaje de texto (SMS).
SendSMS2FA.php	POST	Envía un mensaje de texto (SMS) con un código de verificación 2FA.

URL

Archivo	Método	Descripción
Statistics.php	GET	Obtiene las estadísticas de una URL corta.
URLShortener.php	POST	Crea una URL corta.

WhatsApp

Archivo	Método	Descripción
SendWhatsApp2FA.php	POST (JSON)	Envía un mensaje de WhatsApp con un código de verificación 2FA.
WhatsAppGeneralSend.php	POST (JSON)	Envía un mensaje de WhatsApp usando una plantilla.
SendWhatsAppWithoutTemplate.php	POST (JSON)	Envía un mensaje de WhatsApp sin usar una plantilla.

📖 Uso

1. Clona el repositorio e instala las dependencias: Este proyecto utiliza Guzzle como cliente HTTP, pero en su integracion puede usar otros clientes HTTP y ajustar el codigo segun el caso, usualmente se usan peticiones HTTP POST

   git clone https://github.com/onurixlatam/onurix-php.git
   cd onurix-php
   composer install

2. Navega al archivo del endpoint que deseas utilizar (ej. sms/SendSMS.php).

3. Edita el archivo y reemplaza los valores de los placeholders como se explica en la sección de Configuración de Parámetros.

4. Ejecuta el script desde tu terminal:

   php sms/SendSMS.php

5. Verifica la respuesta que se imprimirá en la consola.

⚙️ Configuración de Parámetros

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:

Credenciales de Autenticación (Obligatorias) POST o GET

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ámetros Comunes

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

Parámetros Específicos

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.
WhatsApp	templateId	ID de la plantilla de WhatsApp aprobada por Meta.
WhatsApp	data	Un array de PHP que se convertirá a JSON con los valores para la plantilla.
WhatsApp	from_phone_meta_id	ID del teléfono de origen registrado en Meta.
WhatsApp	message	Objeto con el mensaje a enviar (tipo y valor).

Ejemplo de parámetros para sms/SendSMS.php

// Define la matriz del cuerpo de la solicitud.
$request_body =array(
     "client"=>"12345",
     "key"=>"*********************",
     "phone"=>"573001234567",
     "sms"=>"Este es un mensaje de prueba enviado desde Onurix.com",
     "groups"=>"1,2,3"
    );

Ejemplo de $data para WhatsApp:

$data = [
    "phones" => "573001234567",
    "body" => [
        1 => ["type" => "text", "value" => "John Doe"],
        2 => ["type" => "text", "value" => "ORD-12345"]
    ]
];

📚 Documentación Completa de la API

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/.

📄 Licencia

Este proyecto está bajo la Licencia MIT.

📞 Soporte

Para soporte y preguntas, no dudes en contactarnos:

• Email: soporte@onurix.com
• Website: https://onurix.com