Onurix - Api

Listar Contactos por Grupo

URL:https://www.onurix.com/api/v1/group/{group-id}/contacts/list

Lista los contactos asociado al Id de grupo suministrado

Parametros.

Nombre	Tipo	Requerido	Descripción
client	integer(int64)	true	El Id del cliente
key	string	true	Key de la cuenta Onurix
group-id	integer(int64)	true	El Id del grupo a consultar
page	integer	false	Número de página a retornar. Por defecto 1. Máximo 50 items por página.

Responses.

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 GET "https://www.onurix.com/api/v1/group/list?client=AQUI_SU_ID&key=AQUI_SU_KEY&page=AQUI_NUMERO_PAGINA" -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();

try{
    $response=$client->request('GET','https://www.onurix.com/api/v1/group/list?client=AQUI_SU_ID&key=AQUI_SU_KEY',
    array('headers'=>$headers));
    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'
}
r = requests.get("https://www.onurix.com/api/v1/group/list?key=AQUI_SU_KEY&client=AQUI_SU_ID",headers=headers)

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)
        {
            GroupList("AQUI_SU_KEY", "AQUI_SU_ID");
        }

        public static void GroupList(string key ,string client)
        {
            using var httpClient = new HttpClient()
            {
                BaseAddress = new Uri("https://www.onurix.com/"),
            };
            HttpResponseMessage request = httpClient.GetAsync($"api/v1/group/list?key={key}&client={client}").Result;
            string responseString = request.Content.ReadAsStringAsync().Result;
            Console.WriteLine(responseString);
        }
    }
}

Code request

package main

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

func main() {

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

	req, err := http.NewRequest("GET", "https://www.onurix.com/api/v1/group/list?client=AQUI_SU_ID&key=AQUI_SU_KEY", nil)
	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',
     }
}
axios.get('https://www.onurix.com/api/v1/group/list?key=AQUI_SU_KEY&client=AQUI_SU_ID',headers)
          .then(resp=>{
               console.log(resp.data);
          }).catch(error=>{
               console.log(error);
          });

Code request

import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.http.HttpResponse.BodyHandlers;

public class GroupList {
    public static void main(String[] args) throws IOException, InterruptedException {
		// TODO Auto-generated method stub
		var httpClient = HttpClient.newHttpClient();

		var request = HttpRequest.newBuilder(URI.create("https://www.onurix.com/api/v1/group/list?key=AQUI_SU_KEY&client=AQUI_SU_ID"))
											.GET()
											.version(HttpClient.Version.HTTP_2)
											.build();
		HttpResponse response = httpClient.send(request, BodyHandlers.ofString());
		System.out.println(response.body());
	}
}

Body parameters


            client: 0,

            key: "string"

Respuesta de ejemplo

Response 200

{
    "metadata": {
        "current_page": 1,
        "per_page": 50,
        "total_items": 3,
        "total_pages": 1
    },
    "contacts": [
        {
            "id": 1,
            "name": "Prueba",
            "lastname": "string",
            "phone": "string",
            "email": "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