DeleteSubscribe. Dar de baja un contacto de un grupo.

Puede cancelar la suscripción de contactos de un grupo en su cuenta SoloClic solicitando una consulta al servicio API utilizando métodos de software.

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

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

• lead_email es el correo electrónico del contacto que canceló la suscripción
• rass_name es el identificador del grupo de contactos del cliente que cancela la suscripción

Ambos campos son obligatorios.

¿Como funciona?

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

La carta de confirmación de activación no llegará después de volver a suscribirse.

Ejemplo de cambio de datos de contacto en PHP

En el ejemplo, damos de baja al usuario con el correo electrónico «[email protected]» del grupo «super». El 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'] = '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 = array(
   'lead_email' => '[email protected]', // correo electrónico del usuario
   'rass_name' => 'super' // grupo de cancelación de suscripción

   );
// Formando el hash a los datos transmitidos.
$send_data['hash'] = GetHash($send_data, $user_rs);
// Llame a la función DeleteSubscribe en la API y decodifique los datos recibidos
$resp = json_decode(Send('https://username.soloclic.com/api/DeleteSubscribe', $send_data));
// Comprobando la respuesta del servicio.
if(!CheckHash($resp, $user_rs)){
 echo "¡Error! ¡El hash de respuesta no es válido!" ;
 exit;
}
if($resp->error_code == 0)
 echo "El usuario canceló la suscripción al grupo: {$send_data['rid[0]']}. Respuesta de servicio: {$resp->error_code}";
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
}