
1. Descripción
La API PHP de la Agenda de Contactos te permite tener un acceso total a todos tus contactos almacenados en tu cuenta.
Podrás gestionar tus contactos para crear nuevos, eliminar y modificar.
2. Documentación
Llamada
La clase dispone de una llamada para agregar/modificar contactos en la Agenda:
addContacts($ContactosArray,$accion_existe,$grupo_asociar,$grupo_nuevo);
Esta llamada acepta los siguientes Argumentos:
Nombre Parámetro |
Descripción |
Posibles Valores |
Tipo de Dato |
| $ContactosArray |
Es un array, donde cada elemento define los datos de un contacto.
A su vez cada elemento/contacto es un array asociativo.
|
Cada elemento/contacto del Array será de tipo Array Asociativo, siendo el índice el campo y el valor, el valor de dicho campo. Ejemplo:
Array ( [0] => Array ( [nombre] => juan Antonio [numero] => 612345678 )
[1] => Array ( [nombre] => Pedro [apellidos] => Sanzhez [numero] => 612345667 )
)
|
Array |
| $accion_existe |
Acción cuando el contacto ya existe |
- A; Se actualiza el contacto modificando solo los datos pasado.
- N; Se crea de nuevo el contacto, se borrar el que existe y se crea uno nuevo
- I; Si existe el contacto se ignora los cambios.
|
Char |
| $grupo_asociar |
Código del grupo al que asociamos los contactos. |
Código de grupo existente. |
Long |
| $grupo_nuevo |
Nombre de un nuevo grupo al que asociamos estos contactos. |
Nombre que deseamos para el grupo que vamos a crear. |
String |
Resultado
Una vez realizada la llamada para agregar o modificar contactos, podemos obtener el resultado del proceso, a tráves de la subclase:
contactosagragados
Esta clase tiene la siguiente estructura:
- total_contactos; Número de contactos que se ha enviado en la petición
- total_contactos_nuevos; Número de contactos que hemos agregado
- total_contactos_actualizados; Número de contactos que se han actualizado/modificado.
- total_contactos_ignorados; Número de contactos que se han ignorado, y por tanto no modificado
- total_contactos_errores; Número de contactos que no se han podido agregar/modificar por errores (No cumple algún requisito)
3. Ejemplo
include_once ("class_dms.php");
$dms=new dms_send;
//Autentificar
$dms->autentificacion->idcli="codigo cliente";
$dms->autentificacion->username="nombre de usuario";
$dms->autentificacion->passwd="password";
$dms->SupportSSL(true);
//Definir contactos
$contacto1=Array(
'nombre' => 'Juan',
'numero' => '611111111'
);
$contacto2=Array(
'nombre' => 'Carlos',
'apellidos' => ''Sanchez,
'numero' => '611111112'
);
$ContactosArray=Array(
$contacto1,
$contacto2
);
//Configurar
$accion_existe="A";
$lista_ascociar="";
$lista_nueva="";
//Enviar solicitud a la plataforma
$dms->addContacts($ContactosArray,$accion_existe,$lista_asociar,$lista_nueva);
//Verificar Resultado
if ($dms->autentificacion->error){
//Error de autentificacion con la plataforma
echo $dms->autentificacion->mensajeerror."\n";
}else{
echo "Total contactos: ".$dms->contactosagragados->total_contactos."\n";
echo "Total contactos nuevos: ".$dms->contactosagragados->total_contactos_nuevos."\n";
echo "Total contactos actualizados: ".$dms->contactosagragados->total_contactos_actualizados."\n";
echo "Total contactos ignorados: ".$dms->contactosagragados->total_contactos_ignorados."\n";
echo "Total contactos errores: ".$dms->contactosagragados->total_contactos_errores."\n";
}
4. Gráfico
