CONVERGENT BILLING

GLink PHP WebServices

20 de Junio del 2008

 GLink

Objetivos

El objetivo principal del sistema el proveer de una interfaz de manejo de cuentas para
que cualquier sistema pueda interactuar con GBillExpress de una forma segura y confiable.

Introducción:
El WebServices esta diseñado con la herramienta de desarrollo PHP el cual
cuenta con la opción de utilizar un Header SOAP para brindarle mayor seguridad y control de
acceso.

El sistema cuenta con las siguientes funciones:

Assign_MinutesPlan: función que nos permite asignar un plan de minutos a una entidad
determinada.

Los parámetros requeridos son los siguientes:

Nombre del Parámetro Tipo de dato esperado Descripción

Usuario utilizado para ingresar a
GBillExpressUserName String
la plataforma.
Password utilizado para ingresar
GBillExpressPassword String
a la plataforma.
EntityDescription String Pin o Nombre del Grupo.
Nombre del Plan de minutos a
PlanDescription String
asignar
Fecha desde la que queremos
FromDate String
que sea efectiva la asignación.
Fecha hasta la que queremos
ToDate String
que sea efectiva la asignación.

El parámetro de retorno de la función en un String que contiene un código y una

descripción indicando el resultado de la operación.
Create Account: función que nos permite crear cuentas en GBillExpress desde otro sistema.

Los parámetros requeridos son los siguientes:

Nombre del Parámetro Tipo de dato esperado Descripción

Usuario utilizado para ingresar a la
GBillExpress User Name String
plataforma.
Password utilizado para ingresar a la
GBillExpress Password String
plataforma.
Es el PIN que va a estar asociado a la
Account String
cuenta.
Es el PIN Password de la que va a tener
Account Password String
la cuenta.
Name String Nombre del titular de la cuenta
Last Name String Apellido del titular de la cuenta
Usuario web que usaran para chequear
Web User Name String
la cuenta.
Web Password String Password para la web.
Se debe indicar el tipo de ANI, el ANI y
el ANI Password que tendrá la cuenta.
De la siguiente forma:
* Anis String Tipo_ani=ani|ani_pass
Ej.: E164=3514118515|22123
Tipos de ANI : E164, DID, E164-FAX,
etc.
Indicamos si la cuenta esta activa o no
Status String
‘Enabled’ o ‘Disabled’

* En caso de que la cuenta tenga más de un ANI estos deben ir separado por coma (,). Los tipos
de ANI validos son los que figuran en GBillExpress.

El parámetro de retorno de la función en un String que contiene un código y una

descripción indicando el resultado de la operación.

Create_MinutesPlan : función que nos permite crear un nuevo plan de minutos en GBillExpress
desde otro sistema.

Los parámetros requeridos son los siguientes:

Nombre del Parámetro Tipo de dato esperado Descripción

Usuario utilizado para ingresar a
GBillExpress User Name String
la plataforma.
Password utilizado para ingresar
GBillExpress Password String
a la plataforma.
Description String Nombre del Plan de Minutos
Valor mínimo, expresado en
Minimum String segundos, desde el cual se cobra
una llamada.
 Unidad de medida en segundos
Increment String que se usa para el incremento del
tiempo cobrable.
Cantidad de minutos con los que
Minutes String
cuenta el plan.
FlatRate String Indicar con 1 o 0 si es tarifa plana
Prioridad que se utilizara para
aplicar el plan de minutos en
Priority String
caso que una cuenta esté
asociada a varios planes.
Se puede indicar en este campo
si se debe recargar la cuenta
RechargeOnPeriod String
automáticamente en cada
periodo (1 = Yes; 0 = No)
Lista de prefijos que están
Prefixes String permitidos en el Plan de Minutos
separados por “,”.

El parámetro de retorno de la función en un String que contiene un

código y una descripción indicando el resultado de la operación.

Get_AccountInformation: función que nos permite obtener información de la cuenta consultada.

Los parámetros requeridos son los siguientes:

Nombre del Parámetro Tipo de dato esperado Descripción

GBillExpress User Name String Usuario utilizado para ingresar a
la plataforma.
GBillExpress Password String Password utilizado para ingresar
a la plataforma.
PIN String PIN asociado a la cuenta a
consultar

La consulta retorna una tabla con el siguiente formato:

Nombre de Columna Tipo de Dato Descripción

Id Integer Numero de identificación de la cuenta.
Pin String Pin asociado a la cuenta.
UserName String Nombre a quien corresponde la cuenta
LastName String Apellido de quien corresponde la cuenta.
Password String Clave o codigo para uso de la cuenta.
Usuario Web para acceso al sitio de
WebUserName String
consulta de la cuenta.
WebPassword String Clave para acceso Web
CreationDate DateTime Fecha y hora de la creación de la cuenta.
ActivationDate DateTime Fecha y hora en que se activo la cuenta.
Status String Estado de la cuenta.
Amount Money Monto actual de la cuenta.
RechargeAmount Money El monto de las cuentas adicionales
Listado de ANIs que pertencen a esa
Anis String cuenta, separados por “,” e indicando el
tipo de ANI que es.
 Los passwords de los ANIs guardan su
correspondencia en el mismo orden que
AnisPassword String
los ANIs, con el formato
Password=@pass1,Password=@pass2,...
Planes de minutos asociados a la cuenta
con los minutos disponibles separados
MinutesPlans String
por coma.
Ej: Argentina=100,Brasil=25
ReturnCode String Código de Retorno de la función.
Descripción del código de retorno de la
ReturnDescription String
función

Get_CallDetail: función que nos permite obtener el detalle de las llamadas que están asociadas
a una cuentas en GBillExpress desde otro sistema.

Los parámetros requeridos son los siguientes:

Nombre del Parámetro Tipo de dato esperado Descripción

GBillExpress User Name String Usuario utilizado para ingresar a
la plataforma.
GBillExpress Password String Password utilizado para ingresar
a la plataforma.
Entity Description String PIN de la cuenta
From Time String Fecha desde
To Time String Fecha hasta
CallType String Tipo de Llamadas que se desea
consultar.
0 = Llamadas entrantes
1 = Llamadas Salientes

La consulta retorna una tabla con el siguiente formato:

Nombre de Columna Tipo de Dato Descripción

Fecha y hora de inicio de la
ConnectTime DateTime
llamada
ANI String Numero de Origen
Destination String Numero de Destino
AniDescription String Descripción del Origen
DestinationDescription String Descripción del Destino
Duración Real de la llamada
RealDuration Integer
en segundos
Duración de la llamada
aplicando las reglas de cobro,
ChargedDuration Integer
incluyendo mínimos e
incrementos
Cargo generado por la
CallCost Money
llamada
Cargos extras generados por
CallExtraCost Money
la llamada
FromProvider String
ToProvider String
Nombre del Plan de minuto
PlanDescription String
utilizado en la llamada
 Código de Retorno de la
ReturnCode String
función.
Descripción del código de
ReturnDescription String
retorno de la función

EntityRecharge: esta función puede ser utilizada para realizar recargas a las cuentas.

Los parámetros requeridos son los siguientes:

Nombre del Parámetro Tipo de dato esperado Descripción

Usuario utilizado para ingresar a
GBillExpress User Name String
la plataforma.
Password utilizado para ingresar
GBillExpress Password String
a la plataforma.
EntityDescription String PIN de la cuenta
Nombre del Plan de Minutos a
PlanDescription String
recargar
Amount String Monto a recargar
Tipo de Recarga a realizar
Ej.: 1 – suma el monto de la
recarga al saldo existente.
2 – Crea una nueva cuenta
asociada a la anterior y le asigna
RechargeType String
el monto.
3 – Sobre escribe el saldo de la
cuenta con el nuevo monto.
4 – Agrega minutos al plan de
minutos indicado.
Descripción o concepto de la
Description String
recarga

El parámetro de retorno de la función en un String que contiene un

código y una descripción indicando el resultado de la operación.

Update_Account: función que nos permite actualizar los datos de una cuenta en GBillExpress
desde otro sistema.

Los parámetros requeridos son los siguientes:

Nombre del Parámetro Tipo de dato esperado Descripción

Usuario utilizado para ingresar a
GBillExpress User Name String
la plataforma.
Password utilizado para ingresar
GBillExpress Password String
a la plataforma.
Es el PIN que va a estar asociado
PIN String
a la cuenta.
Es el PIN Password que va a
Password String
tener la cuenta.
Name String Nombre del titular de la cuenta
Last Name String Apellido del titular de la cuenta
Usuario web que usaran para
Web User Name String
chequear la cuenta.
Web Password String Password para la web.
 Se debe indicar el listado de ANIs
* DeleteAnis String
a quitar de la cuenta.
Incluir el listado de ANIs a
agregar a la cuenta. Indicando el
tipo de ANI, el ANI y el password
del ANI.
* AddAnis String De la siguiente forma:
Tipo_ani=ani|ani_pass
Ej.: E164=3514118515|22123
Tipos de ANI : AutoANI, E164,
DID, E164-FAX, etc.
Fecha y Hora en la que se desea
ActivationDate String
activar la cuenta.
Indicamos si la cuenta esta activa
Status String o no
‘Enabled’ o ‘Disabled’
Sirve para setear el límite de
BalanceLimit String
gasto de la cuenta.
Sirve para setear a partir de que
CreditAlarmAmount String valor se dispara la alarma de
saldo de la cuenta.

* En caso de que la cuenta tenga más de un ANI estos deben ir separado por coma (,). Los tipos
de ANI validos son los que figuran en GBillExpress.

El parámetro de retorno de la función en un String que contiene un código y una

descripción indicando el resultado de la operación.