AddLeadToGroup. Agregar un contacto a un grupo

Puede agregar nuevos contactos a su cuenta SoloClic solicitando una consulta al servicio API utilizando métodos de software.

Puede agregar un contacto a varios grupos al mismo tiempo.

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

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

Los parámetros de consulta coinciden con los parámetros del formulario de suscripción (consulte «Cómo crear un formulario de suscripción» para obtener más detalles), de la siguiente manera:

• rid[0] es el primer grupo al que se agregará el contacto (el identificador simbólico del grupo);
• rid [1] es el segundo grupo al que se agregará el contacto, y así sucesivamente (opcional);
• lead_namees el nombre del contacto, el nombre completo del contacto o el apodo (opcional; si está vacío, será reemplazado por «Estimado amigo»);
• lead_correo es el correo electrónico de contacto;
• lead_phone es el número de teléfono de contacto (opcional);
• lead_city es la ciudad de residencia del contacto (opcional);
• tag es una etiqueta de cadena no especificada que marcará el contacto (opcional);
• doneurl2 es la dirección de redireccionamiento del contacto después de la confirmación de la suscripción (opcional);
• activationes un parámetro que le permite decidir si solicitar al suscriptor que confirme la suscripción o no. (No necesariamente, se utiliza solo en la tarifa «Guru» para la activación obligatoria de la confirmación de suscripción.);
• utm [utm_medium] es el parámetro utm del canal (opcional);
• utm [utm_source] es el parámetro utm de origen (opcional);
• utm [utm_campaign] es el parámetro utm de la campaña (opcional);
• utm [utm_content] es el parámetro de publicidad (opcional);
• utm [utm_term] es el parámetro utm clave (opcional);
• utm [aff_medium] es el parámetro de afiliado del canal (opcional);
• utm [aff_source] es el parámetro de afiliado de origen (opcional);
• utm [aff_campaign] es el parámetro de afiliación de la campaña (opcional);
• utm [aff_content] es el parámetro de afiliado de publicidad (opcional);
• utm [aff_term] es el parámetro de afiliado clave (opcional).

Solo se requieren los dos campos rid [0] y lead_correo. El resto depende de usted.

Si desea enviar información de que el suscriptor proviene de un socio, transmita 2 parámetros utm [utm_medium] y utm [utm_source] de la siguiente manera:

'utm[utm_medium]' => 'affiliate', // solo 'afiliado' y nada más
'utm[utm_source]' => 'username', // inicio de sesión del socio en el sistema SoloClic

También puede utilizar utm_marks afiliado (utm [aff_ …]). En este caso, el socio especificado debe ser necesariamente un miembro del programa de afiliados, y los datos de la etiqueta (utm [aff_ …]) se mostrarán solo en el gabinete del socio.

Si desea confirmar la suscripción del usuario, debe pasar TRUE al campo de activación.

¿Como funciona?

Agregar un contacto es lo mismo que usar el formulario de suscripción, es decir, si se requiere la activación de la suscripción, se enviará una notificación relevante al correo electrónico indicado.

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

Ejemplo de cómo agregar un suscriptor al grupo en PHP

En el ejemplo, agregamos al usuario con el correo electrónico «[email protected]» en el 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'] = '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 = array(
 'rid[0]' => 'xxxxxxxxxx.xxxxxxxxxx', // <span style="font-weight: 400;" data-mce-style="font-weight: 400;">the group the subscriber will go to.</span>
 'lead_name' => 'Nombre',
 'lead_email' => '[email protected]',
 'lead_phone' => '+788888888',
 'lead_Ciudad' => 'Ciudad',
 'tag' => 'esto es etiqueta', // etiqueta no especificada
 'doneurl2' => 'http://soloclic.com/', // dirección después de la confirmación de suscripción
 'activation' => true, // requiriendo confirmación de suscripción
 'utm[utm_medium]' => 'cpc',
 'utm[utm_source]' => 'direct',
 'utm[utm_campaign]' => 'My_Campaña',
 'utm[utm_content]' => '<span style="font-weight: 400;" data-mce-style="font-weight: 400;">content_123</span>',
 'utm[utm_term]' => 'my_etiqueta',
 );
 // Formando el hash a los datos transmitidos.
 $send_data['hash'] = GetHash($send_data, $user_rs);
 // Llamar a la función AddLeadToGroup en la API y decodificar los datos recibidos.
 $resp = json_decode(Send('http://nombre_de_usuario.soloclic.com/api/AddLeadToGroup', $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 " Usuario agregado 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
 }

Vaya a su Lista creada o elegida y en la pestaña «API» encontrará el valor en el campo «ID de lista». Toma esto por el valor de "rid [0] como:
'rid [0]' = '1605274062.9371563956' (por ejemplo).