Onurix - Api

Envia Mensaje por SMS

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

URL:https://www.onurix.com/api/v1/send-sms

Envia un mensaje de texto a los numero de telefono suministrados

CONSIDERACIONES:

Por defecto, los envíos por API se consideran transaccionales. Si el mensaje es de carácter comercial (publicidad, promociones), envíe is-transactional en 0: los números colombianos inscritos en el Registro de Números Excluidos (RNE) de la CRC que no aceptan SMS serán rechazados con el error 1010.
En un envío a varios números o a grupos, cada número excluido queda registrado con el error 1010 en el historial de envíos y no consume créditos; el resto del envío continúa.

Parametros.

Nombre	Tipo	Requerido	Descripción
client	integer(int64)	true	El Id del cliente
key	string	true	Key de la cuenta onurix
phone	string	true	Numero(s) de telefonos separados por comas. Ej “573150123456” ó “573150123456,573150012345”
sms	string	true	Mensaje de texto a enviar a los numeros de telefono
groups	string	false	ID de grupos separados por comas. Ej "1,2,3"
is-transactional	integer	false	Indica si el mensaje es transaccional (1, valor por defecto) o comercial (0). Con 0 se valida el destinatario contra el Registro de Números Excluidos (RNE)

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

curl -X POST "https://www.onurix.com/api/v1/sms/send" -d key="AQUI_SU_KEY" -d client="AQUI_SU_CLIENT" -d phone="AQUI_EL_NUMERO_DE_CELULAR" -d sms="AQUI_EL_SMS_A_ENVIAR" -d groups="AQUI_ID_DE_GRUPO" -H 'Content-Type: application/x-www-form-urlencoded' -H 'Accept: application/json'

Code request

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

$headers=array(
'Content-Type'=>'application/x-www-form-urlencoded',
'Accept'=>'application/json',
);

$client= new \GuzzleHttp\Client();

// Define la matriz del cuerpo de la solicitud.
$request_body =array(
     "client"=>"AQUI_SU_CLIENT",
     "key"=>"AQUI_SU_KEY",
     "phone"=>"AQUI_EL_NUMERO_DE_CELULAR",
     "sms"=>"AQUI_EL_SMS_A_ENVIAR",
     "groups"=>"AQUI_ID_DE_GRUPOS"
    );

try{
$response=$client->request('POST','https://www.onurix.com/api/v1/sms/send',array(
'headers'=>$headers,
'form_params'=>$request_body,
)
);
print_r($response->getBody()->getContents());
}
catch(\GuzzleHttp\Exception\BadResponseException $e){
// Manejar excepciones o errores de API
print_r($e->getMessage());
}

Code request

import requests
headers ={
'Content-Type':'application/x-www-form-urlencoded',
'Accept':'application/json'
}
data = {
     'client':'AQUI_SU_CLIENT',
     'key':'AQUI_SU_KEY',
     'phone':'AQUI_EL_NUMERO_DE_CELULAR',#PARA ENVIAR MULTIPLES TELEFONOS TENDRAN QUE SER SEPARADOS POR COMAS ","
     'sms':'AQUI_EL_SMS_A_ENVIAR',
     'groups':"AQUI_ID_GRUPOS",#PARA ENVIAR MULTIPLES GRUPOS TENDRAN QUE SER SEPARADOS POR COMAS ","
     }

r = requests.post('https://www.onurix.com/api/v1/sms/send', headers = headers, data = data)

print(r.json())

Code request

//Este codigo fue hecho en .net 6
using System.Net.Http;
namespace PruebaOnurix
{
    public class Program
    {
        public static void Main(string[] args)
        {
            Dictionary<string, string> parameters = new()
            {
                { "client", "AQUI_SU_CLIENT"},
                { "key", "AQUI_SU_KEY"},
                { "phone", "AQUI_EL_NUMERO_DE_CELULAR"},
                { "sms","AQUI_EL_SMS_A_ENVIAR"},
            };
            SendSMS(parameters);
        }

        public static void SendSMS(Dictionary<string,string> parameters)
        {
            using var httpClient = new HttpClient()
            {
                BaseAddress = new Uri("https://www.onurix.com"),
            };
            HttpResponseMessage request = httpClient.PostAsync("/api/v1/sms/send", new FormUrlEncodedContent(parameters)).Result;
            string responseString = request.Content.ReadAsStringAsync().Result;
            Console.WriteLine(responseString);
        }
    }
}

Code request

package main

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

func main() {

	headers := map[string][]string{
		"Content-Type": []string{"application/x-www-form-urlencoded"},
		"Accept":       []string{"application/json"},
	}

	data := strings.NewReader("client=AQUI_SU_CLIENT&key=AQUI_SU_KEY&phone=AQUI_EL_NUMERO_DE_CELULAR&sms=AQUI_EL_SMS_A_ENVIAR&groups=AQUI_ID_GRUPOS")
	req, err := http.NewRequest("POST", "https://www.onurix.com/api/v1/sms/send", data)
	req.Header = headers

	client := &http.Client{}
	resp, err := client.Do(req)

	defer resp.Body.Close()
	body, err := ioutil.ReadAll(resp.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/x-www-form-urlencoded',
     }
}
let data={
     'client':'AQUI_SU_CLIENT',
     'key':'AQUI_SU_KEY',
     'phone':'AQUI_EL_NUMERO_DE_CELULAR',//PARA ENVIAR MULTIPLES TELEFONOS TENDRAN QUE SER SEPARADOS POOR COMAS ","
     'sms':'AQUI_EL_SMS_A_ENVIAR',
     'groups':"AQUI_ID_GRUPOS",//PARA ENVIAR MULTIPLES GRUPOS TENDRAN QUE SER SEPARADOS POOR COMAS ","
};

axios.post('https://www.onurix.com/api/v1/sms/send',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 SendSMS {

	public static void main(String[] args) throws IOException, InterruptedException {
		// TODO Auto-generated method stub
		Map<String,String> parameters = new HashMap<>();
		parameters.put("client", "AQUI_SU_CLIENT");
		parameters.put("key", "AQUI_SU_KEY");
		parameters.put("phone", "AQUI_EL_NUMERO_DE_CELULAR");//PARA ENVIAR MULTIPLES TELEFONOS TENDRAN QUE SER SEPARADOS POR COMAS ","
		parameters.put("sms", "AQUI_EL_SMS_A_ENVIAR");
		parameters.put("groups","AQUI_ID_DE_GRUPOS");//PARA ENVIAR MULTIPLES TELEFONOS TENDRAN QUE SER SEPARADOS POR COMAS ","


		var httpClient = HttpClient.newHttpClient();
		var request = HttpRequest.newBuilder()
				.version(HttpClient.Version.HTTP_2)
				.POST(ofFormData(parameters))
				.uri(URI.create("https://www.onurix.com/api/v1/sms/send"))
				.header("Content-Type", "application/x-www-form-urlencoded")
				.build();
		
		var response = httpClient.send(request, HttpResponse.BodyHandlers.ofString());
        //System.out.println(response.body());

	}

    public static HttpRequest.BodyPublisher ofFormData(Map<String, String> parameters) {
        var builder = new StringBuilder();
        for (Entry<String, String> entry : parameters.entrySet()) {
            if (builder.length() > 0) {
                builder.append("&");
            }
            builder.append(URLEncoder.encode(entry.getKey().toString(), StandardCharsets.UTF_8));
            builder.append("=");
            builder.append(URLEncoder.encode(entry.getValue().toString(), StandardCharsets.UTF_8));
        }
        return HttpRequest.BodyPublishers.ofString(builder.toString());
    }
}

Body parameters


            client: 0,

            key: "string",

            phone: "string",

            sms: "string",

            groups: "string",

            is-transactional: 1,

Respuesta de ejemplo

Response 200

{
  "id": "string",
  "status": 0,
  "data": 
  {
      "id": "string",
      "state": "string",
      "credits": 0,
      "sms": "string",
      "phone": "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