GetLeadGroupStatuses. Recibir una lista de todos los grupos de contactos con estado de suscripción

Este método reemplaza al anterior, GetLeadGroups.

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

• ID del grupo;
• Nombre del grupo;
• Estado de contacto en este grupo;
• Hora de suscribirse a este grupo.

La consulta es solicitada por el método POST en el formato URLencode a la dirección: https://nombre_de_usuario.soloclic.com/api/GetLeadGroupStatuses

Donde nombre_de_usuario 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

El único campo obligatorio es el campo de correo electrónico, es decir, el correo electrónico del suscriptor que necesita para obtener la lista de grupos actual.

Como funciona

Transfiere el correo electrónico del cliente a la función de API GetLeadGroupStatuses. Su sistema recibirá el resultado del desempeño de la función 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:

Array
(
	[0] => stdClass Object
		(
			[rass_name] => ID del grupo 1
			[rass_title] => Nombre del grupo 1
			[rass_status] => Estado de contacto en este grupo 1
			[subscription_time] => Hora de suscribirse a este grupo 1
		)
 
	[1] => stdClass Object
		(
			[rass_name] => ID del grupo 2
			[rass_title] => Nombre del grupo 2
			[rass_status] => Estado de contacto en este grupo 2
			[subscription_time] => Hora de suscribirse a este grupo 2
		)
 
	[2] => stdClass Object
		(
			[rass_name] => ID del grupo 3
			[rass_title] => Nombre del grupo 3
			[rass_status] => Estado de contacto en este grupo 3
			[subscription_time] => Hora de suscribirse a este grupo 3
		)
)

La respuesta está codificada en formato JSON. Para obtener más detalles, consulte las «Respuestas del servicio API».

Posibles estados de suscripción:

STATUS_WAIT – La activación está pendiente.

STATUS_SUBSCRIBE – La suscripción está firmada / activada.

STATUS_UNSUBSCRIBE – El cliente no suscrito.

STATUS_UNSUBSCRIBE_BY_SERVICE – El cliente se dio de baja del servicio.

STATUS_INVALID_EMAIL – El correo electrónico no existe.

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 inicio de sesión en el sistema es «nombre_de_usuario».

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'] = 'nombre_de_usuario';
// 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 GetLeadGroupStatuses y decodificar los datos recibidos.
$resp = json_decode(Send('https://nombre_de_usuario.soloclic.com/api/GetLeadGroupStatuses', $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);
}

// Comprobando el 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.
}