GetLeadGroups. Recibir una lista de todos los grupos de contactos.

This method is out-of-date.  

En su lugar, utilice GetLeadGroupStatuses.

Puede obtener la lista de grupos de contactos solicitando una consulta al servicio de API por métodos de software utilizando su correo electrónico. En respuesta, su sistema recibirá una matriz. Allí para cada grupo se transferirá un ID de grupo y un nombre de grupo.

La consulta se envía mediante el método POST en formato URLencode a la dirección: https://username.soloclic.com/api/GetLeadGroups.

Donde username es el inicio de sesión del usuario en el sistema, así como su dominio de tercer nivel en el servicio SoloClic.

Parámetros transferidos en la consulta

• email es el correo electrónico del suscriptor, que necesita para obtener la lista de grupos actual (requerido)

El único campo es el campo de correo electrónico.

¿Como funciona?

Transfiere el correo electrónico del cliente a la función de la API GetLeadGroups. Su sistema recibirá el resultado de la función que realiza y una matriz con grupos de suscripción en la variable de resultado como respuesta.

La matriz de grupos se verá de la siguiente manera:

$resp->result = Array (

[0] => array (
[rass_name] => ID de grupo 1
[rass_title] => Nombre del grupo 1
)

[1] => array (
[rass_name] => ID de grupo 2
[rass_title] => Nombre del grupo 2
)

[2] => array (
[rass_name] => ID de grupo 3
[rass_title] => Nombre del grupo 3

Su sistema recibirá el resultado de la función en formato JSON como respuesta. Para obtener más detalles, consulte la Estados, Códigos y Descripciones de respuesta de API.

Ejemplo de cómo obtener una lista de grupos de suscripción en PHP

Obtenemos grupos de suscripción para el usuario con el correo electrónico [email protected] en el ejemplo. Su nombre de usuario en el sistema es «username».

La función GetHash forma el hash de los datos transferidos.

La función CheckHash comprueba el hash de la respuesta del servicio.

// Inicie sesión en el sistema SoloClic.
 $user_rs['user_id'] = 'username';
// La clave para formar un hash. Consulte la sección API (el enlace en la esquina inferior derecha de la cuenta personal)
 $user_rs['user_rps_key'] = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
 
// Formando la matriz de datos para transferir a la API
$send_data['email'] = '[email protected]'; // Correo electrónico del cliente, del que obtenemos la lista de grupos de suscripción
 
// Formando el hash a los datos transmitidos
$send_data['hash'] = GetHash($send_data, $user_rs);
 
// Llamar a la función GetLeadGroups y decodificar los datos recibidos
$resp = json_decode(Send('https://username.soloclic.com/api/GetLeadGroups', $send_data));
 
// Verificando la respuesta del servicio
if(!CheckHash($resp, $user_rs)){
	echo "¡Error! ¡El hash de respuesta no es cierto!" ; print_r($resp);
	exit;
}
 
if($resp->error_code == 0){
echo "Lista de grupos";
print_r($resp->result);
}
else
	echo "Código de error: {$resp->error_code} - descripción: {$resp->error_text}";
 
// =========== Funciones de enviar, recibir y procesar una respuesta ============
 
// Envío de la consulta al servicio API
function Send($url, $data)
{
	$ch = curl_init();
	curl_setopt($ch, CURLOPT_URL, $url);
	curl_setopt($ch, CURLOPT_POST, true);
	curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));
	curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
	curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2);
	curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); // dando salida a la respuesta a la variable.
 
	$res = curl_exec($ch);
 
	curl_close($ch);
	return $res;
}
 
// Formando el hash de datos transferidos a la API
function GetHash($params, $user_rs) {
	$params = http_build_query($params);
	$user_id = $user_rs['user_id'];
	$secret = $user_rs['user_rps_key'];
	$params = "$params::$user_id::$secret";
	return md5($params);
}
 
// Comprobación del hash de respuesta recibido
function CheckHash($resp, $user_rs) {
	$secret = $user_rs['user_rps_key'];
	$code = $resp->error_code;
	$text = $resp->error_text;
	$hash = md5("$code::$text::$secret");
	if($hash == $resp->hash)
		return true; // el hash es correcto
	else
		return false; // el hash no es correcto
}