Manual de Integración Voz V2 (MAN-PP-03-10) #

Contenido

1. ControldeCambios…………………………………………………………………………………………….. 3
2. BlasterdeAldeamo-API……………………………………………………………………………………….. 4

¿Qué puede hacer la API?……………………………………………………………………………………… 4

3. API-Aplicaciones……………………………………………………………………………………………….. 7

2

1.            Control de Cambios #

2.            BlasterdeAldeamo-API #

Las campañas de Blaster de Aldeamo pueden ser administradas desde un software externo, como, por ejemplo:

• Desde un sistema contable cuando unafactura vence, con la API de Blasterde Aldeamo se puedeinformar al usuario usando un mensaje de
• En el sistema de citas médicas, al presionar un botón podría enviarse un mensaje de voz recordando atodos lospacientesquetienenunacitamédica.
• Desde un sistema de notas académicas podría informar a todos los padres de familia que las notas ya fueron subidas al
• Y muchas aplicaciones más. Todo sistema de software puede hacer uso de esta herramienta y usarla a su

La API de Blaster de Aldeamo es una API REST que funciona a través de peticiones HTTP y autenticación básica.

¿Qué puede hacer la API? #

La API actual cuenta con las siguientes características:

• Crear campañas (con subida de audios).
• Cambiar el estado de una campaña (DETENIDA a ACTIVA o viceversa).
• Obtener la información completa de una campaña.
• Obtener la información de un contacto de una campaña específica usando un identificador o un número telefónico.
• Obtener una lista con la información completa de todos los contactos de una campaña específica.
• Agregar contactos a una campaña específica.
  • Con la posibilidad de reproducir en medio de la llamada un PIN en múltiples idiomas.
  • Con la posibilidad de definir las variables personalizadas para campañas Para poder utilizar la API se debe:
• Crear una campaña y permitir su acceso desde
• Obtener el id del grupo y la campaña en la sección Configuración de la campaña (o en la respuesta de la creación con la API)
• Dirigir todas las peticiones a https://voz.aldeamo.com
• Realizar la conexión con tu software a través de peticiones HTTP según la documentación.

www.aldeamo.com                                                                                                            4

EJEMPLOS

Ejemplo A:

Petición GET para obtener los contactos de una campaña con ID 345

Ejemplo B:

Petición POST para crear un contacto con teléfono 3221234123 en la campaña con ID 345

Python

>>> # HTTP GET USERNAME =

“TU_USERNAME” PASSWORD

= “TU_PASSWORD”

>>> # EJEMPLO A

>>> requests.get(‘https://voz.aldeamo.com/api/campaign/345/contact’, auth=(USERNAME, PASSWORD))

>>> # HTTP POST

>>> # EJEMPLO B

>>> requests.post(‘https://voz.aldeamo.com/api/campaign/345/contact’, data={‘phone’: ‘3221234123’}, auth=(USERNAME, PASSWORD))

Jquery AJAX

// HTTP GET USERNAME =

“TU_USERNAME” PASSWORD

= “TU_PASSWORD”

// EJEMPLO A

$.ajax({

type: “GET”,

url: “https://voz.aldeamo.com/api/campaign/345/contact”, dataType: ‘json’,

beforeSend: function (xhr) {

xhr.setRequestHeader (“Authorization”, “Basic ” + btoa(USERNAME + “:” + PASSWORD));

},

success: function (data){ alert(‘Ok’);

}

});

// HTTP POST

// EJEMPLO B

$.ajax({

type: “POST”,

url: “https://voz.aldeamo.com/api/campaign/345/contact”, dataType: ‘json’,

data: {phone: “3221234123”}, beforeSend: function (xhr) {

xhr.setRequestHeader (“Authorization”, “Basic ” + btoa(USERNAME + “:” + PASSWORD));

},

success: function (data){ alert(‘Ok’);

}

});

PHP

// HTTP GET

// EJEMPLO A

<?php

$USERNAME = “TU_USERNAME”;

$PASSWORD = “TU_PASSWORD”;

$headers = array(

‘Content-Type:application/json’,

‘Authorization: Basic ‘. base64_encode($USERNAME . “:” . $PASSWORD)

);

$ch = curl_init();

curl_setopt($ch, CURLOPT_HTTPHEADER, $headers); curl_setopt($ch,

CURLOPT_URL,”https://voz.aldeamo.com/api/campaign/345/contact”); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$server_output = curl_exec ($ch); curl_close ($ch);

?>

// HTTP POST

// EJEMPLO B

<?php

$headers = array(

‘Content-Type:application/json’,

‘Authorization: Basic ‘. base64_encode($USERNAME . “:” . $PASSWORD)

);

www.aldeamo.com                                                                                                            6

$ch = curl_init();

curl_setopt($ch, CURLOPT_HTTPHEADER, $headers); curl_setopt($ch,

CURLOPT_URL,”https://voz.aldeamo.com/api/campaign/345/contact”); curl_setopt($ch, CURLOPT_POST, 1);

curl_setopt($ch, CURLOPT_POSTFIELDS, “phone=3221234123”); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$server_output = curl_exec ($ch); curl_close ($ch);

?>

Para más información, click aquí: https://voz.aldeamo.com/api/docs

3. API -Aplicaciones

API-Aplicaciones

campa

ign                                                                              Moslrar/ocultar Lista de Operaciones

b‹pandir0oeraciones Código

Mélodo paraMobétleondeorplaaralisclaamobeiacroenlteascttaodsoddeeuunnaaccaammooaaññaa

Método pBra generar el Pegarle de excel de una

camoaña

/ap ”/canpaign/{ pk camoaign}/contact/”d/(idl/

/ap”/canpaign/{pk_camoaign]/c

ontact/phone/(Phone}/

Idébsdo para añadir un contacto a una campaña en

especifico

Metodo para obtener un contacto de una cam dana usando el identilicaoor del contacto

MétodDpara subirmasivamerrle contactos a una

camoaña

Método oara ootener lista de contactos de una e mpaña que concuerdan con un número