Onurix - Api

Enviar Mensaje por WhatsApp

URL:https://www.onurix.com/api/v1/whatsapp/send

Envió de mensajes de texto o multimedia mediante WhatsApp, no es necesario usar una plantilla personalizada en Onurix.

CONSIDERACIONES:

Antes de enviar un mensaje, asegúrese de que el negocio, el número telefónico y la plantilla de mensaje estén en estado saludable. Si alguno presenta advertencias o bloqueos, el mensaje será rechazado por Meta.
Si desea recibir las respuestas de los usuarios o eventos como entregas y errores, debe configurar un webhook desde el panel de control en onurix.com.
Puede obtener toda la información necesaria para realizar el envío de notificaciones (URL y cuerpo del mensaje en formato JSON) desde el administrador de Onurix, en la opción WhatsApp → Templates.
El destino del mensaje se define con phones o con groups, pero nunca con ambos al mismo tiempo. Si envía los dos (o ninguno) la petición será rechazada.
Si el envío es comercial lo define la categoría que Meta asignó a la plantilla: las de categoría MARKETING son comerciales y las de UTILITY y AUTHENTICATION son transaccionales. En un envío comercial, los números colombianos inscritos en el Registro de Números Excluidos (RNE) de la CRC que no aceptan aplicaciones de mensajería serán rechazados con el error 1010; en un envío a varios números o a grupos, esos números se omiten y el resto del envío continúa. Los mensajes sin plantilla siempre son transaccionales.

Parametros de la URL.

Nombre	Tipo	Requerido	Descripción
client	integer(int64)	true	El Id del cliente
key	string	true	Key de la cuenta onurix
phone-sender-id	string	true	Identificador del número telefónico registrado en Meta que se utilizará para el envío del mensaje
template-id	string	true	Id de la plantilla generado por META

Parametros del cuerpo (JSON).

Nombre	Tipo	Requerido	Descripción
phones	string	condicional	Lista de números de teléfono destino separados por coma. Deben estar en formato nacional o internacional con indicativo (ej. 57 para Colombia). Excluyente con groups. Ejemplo: 573001234567,573007654321
groups	string	condicional	Identificador de uno o más grupos registrados en Onurix, separados por coma. Excluyente con phones
header	json	false	Variables definidas en la sección header de la plantilla de Meta. Las claves ("1", "2", …) corresponden al orden de las variables
body	json	false	Variables definidas en la sección body de la plantilla. Cada entrada recibe un type (text, image, video, …) y un value
button	json	false	Variables utilizadas en los botones personalizados de la plantilla, si aplica

Respuesta.

Estado	Significado	Descripción	Esquema
200	OK	Operación exitosa	JsonResponse
400	Client Error	Parametros invalidos	JsonResponse
520	Unknown	Error interno del sistema	ErrorResponse

Code request

# También puede usar wget
curl -X POST "https://www.onurix.com/api/v1/whatsapp/send" -d client=AQUI_SU_KEY -d key=AQUI_SU_CLIENT -d template-id=AQUI_EL_ID_DE_LA_PLANTILLA -d phone-sender-id=AQUI_EL_ID_DEL_NUMERO_DE_TELEFONO_REMITENTE" -H 'Content-Type: application/json' -d 'AQUI_EL_JSON_CON_LOS_VALORES_PARA_LA_PLANTILLA'

Code request

<?php
// Ejecutar: composer require guzzlehttp/guzzle:*
require'vendor/autoload.php';

$clientId = "AQUI_SU_CLIENT";
$key = "AQUI_SU_KEY";
$templateId = "AQUI_EL_ID_DE_LA_PLANTILLA";
$phoneSenderId = "AQUI_EL_ID_DEL_NUMERO_DE_TELEFONO_REMITENTE";
$client = new \GuzzleHttp\Client();
$headers = [
  'Content-Type' => 'application/json'
];

$data = 'AQUI_EL_ARREGLO_CON_LOS_VALORES_PARA_LA_PLANTILLA';
$response = $client->post("https://www.onurix.com/api/v1/whatsapp/send?key=$key&client=$clientId&template-id=$templateId&phone-sender-id=$phoneSenderId",['body' => json_encode($data)]);
echo $response->getBody()->getContents();

Code request

import requests
import json

url = "https://www.onurix.com/api/v1/whatsapp/send?key=AQUI_SU_KEY&client=AQUI_SU_CLIENT&template-id=AQUI_EL_ID_DE_LA_PLANTILLA&phone-sender-id=AQUI_EL_ID_DEL_NUMERO_DE_TELEFONO_REMITENTE"

payload = json.dumps('AQUI_EL_JSON_CON_LOS_VALORES_PARA_LA_PLANTILLA')
headers = {
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

Code request

//Este codigo fue hecho en .net 6
using System.Text;
using System.Net.Http;
namespace PruebaOnurix
{
    public class Program
    {
        public static void Main(string[] args)
        {
            WhatsAppSend();
        }

        public static void WhatsAppSend()
        {
            string key = "AQUI_SU_KEY";
            string client = "AQUI_SU_CLIENT";
            string templateId = "AQUI_EL_ID_DE_LA_PLANTILLA";
            string parameters = "AQUI_EL_JSON_CON_LOS_VALORES_PARA_LA_PLANTILLA";
            string phoneSenderId = "AQUI_EL_ID_DEL_NUMERO_DE_TELEFONO_REMITENTE";
            using var httpClient = new HttpClient()
            {
                BaseAddress = new Uri("https://www.onurix.com/"),
            };
            HttpResponseMessage request = httpClient.PostAsync($"api/v1/whatsapp/send?client={client}&key={key}&template-id={templateId}&phone-sender-id={phoneSenderId}", content: new StringContent(parameters, Encoding.UTF8, "application/json")).Result;
            string responseString = request.Content.ReadAsStringAsync().Result;
            Console.WriteLine(responseString);
        }
    }
}

Code request

package main

import (
	"fmt"
	"io/ioutil"
	"net/http"
	"strings"
)

func main() {

	url := "https://www.onurix.com/api/v1/whatsapp/send?key=AQUI_SU_KEY&client=AQUI_SU_CLIENT&template-id=AQUI_EL_ID_DE_LA_PLANTILLA&phone-sender-id=AQUI_EL_ID_DEL_NUMERO_DE_TELEFONO_REMITENTE"
	method := "POST"

	payload := strings.NewReader(`AQUI_EL_JSON_CON_LOS_VALORES_PARA_LA_PLANTILLA`)

	client := &http.Client{}
	req, err := http.NewRequest(method, url, payload)

	if err != nil {
		fmt.Println(err)
		return
	}
	req.Header.Add("Content-Type", "text/plain")

	res, err := client.Do(req)
	if err != nil {
		fmt.Println(err)
		return
	}
	defer res.Body.Close()

	body, err := ioutil.ReadAll(res.Body)
	if err != nil {
		fmt.Println(err)
		return
	}
	fmt.Println(string(body))
}

Code request

// Ejecutar: npm install axios --save
const axios = require('axios').default;

let headers = {headers:
     { 'Content-Type': 'application/json'}
};
//   data = JSON.stringify({
//      "phone": "+573201234567",
//      "body": [
//        "Parametro1",
//        "Parametro2"
//      ]
//    })
 let data= JSON.stringify('AQUI_EL_JSON_CON_LOS_VALORES_PARA_LA_PLANTILLA')

axios.post('https://www.onurix.com/api/v1/whatsapp/send?key=AQUI_SU_KEY&client=AQUI_SU_CLIENT&template-id=AQUI_EL_ID_DE_LA_PLANTILLA&phone-sender-id=AQUI_EL_ID_DEL_NUMERO_DE_TELEFONO_REMITENTE',data,headers)
          .then(resp=>{
               console.log(resp.data);
          }).catch(error=>{
               console.log(error);
          });

Code request

//Para este codigo se uso jdk 11
import java.io.IOException;
import java.net.URI;
import java.net.URLEncoder;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.nio.charset.StandardCharsets;
import java.util.HashMap;
import java.util.Map;
import java.util.Map.Entry;

public class WhatsAppGeneralSend {

	public static void main(String[] args) throws IOException, InterruptedException {
		// TODO Auto-generated method stub
		
		String clientId = "AQUI_SU_CLIENT";
		String key = "AQUI_SU_KEY";
		String templateId = "AQUI_EL_ID_DE_LA_PLANTILLA";
		String phoneSenderId = "AQUI_EL_ID_DEL_NUMERO_DE_TELEFONO_REMITENTE";

		var httpClient = HttpClient.newHttpClient();
		var request = HttpRequest.newBuilder()
				.version(HttpClient.Version.HTTP_2)
				.POST(HttpRequest.BodyPublishers.ofString("AQUI_EL_JSON_CON_LOS_VALORES_PARA_LA_PLANTILLA"))
				.uri(URI.create("https://www.onurix.com/api/v1/whatsapp/send?client=" + clientId + "&key=" + key + "&template-id=" + templateId + "&phone-sender-id=" + phoneSenderId))
				.header("Content-Type", "application/json")
				.build();
		
		var response = httpClient.send(request, HttpResponse.BodyHandlers.ofString());
		System.out.println(response.body());
	}
}

Url parameters

client: 0
key: "AQUI_SU_KEY"
phone-sender-id: "AQUI_EL_ID_DEL_NUMERO_DE_TELEFONO_REMITENTE"
template-id: "AQUI_EL_ID_DE_LA_PLANTILLA"

Body parameters example

Envíe "phones" o "groups", nunca ambos. Para grupos, reemplace esa línea por "groups": "1,5". Deje "header" y "button" vacíos si la plantilla no define variables en esas secciones.

{
  "phones": "573001234567,573007654321",
  "header": {},
  "body": {
    "1": {
      "type": "text",
      "value": "Este es un texto enviado desde Onurix"
    },
    "2": {
      "type": "text",
      "value": "Este es un texto enviado desde Onurix"
    }
  },
  "button": {}
}

Respuesta de ejemplo

Response 200

{
  "id": "string",
  "status": "string",
  "phone": "string",
  "name": "string"
}

Response 400 o 520


              {

              "error": 1000,

              "msg": "string"

              }

Si requiere asistencia o tiene un problema, envienos un mensaje para poder ayudarlo

soporte@onurix.com