Содержание
Данный метод пришел на замену устаревшему GetLeadGroups
Вы можете получить список групп, в которых состоит контакт по его е-мейлу, сформировав запрос к API сервиса программными методами.
В ответе ваша система получит массив, в котором для каждой группы будут пререданы:
- ID группы
- название группы
- статус контакта в данной группе
- время подписки контакта в данную группу
Запрос передаётся методом POST в формате URLencode на адрес: https://username.expertam.ru/api/GetLeadGroupStatuses
где username — это логин пользователя в системе, а так же его домен 3-его уровня в сервисе Expertam.
Параметры передаваемые в запросе
Обязательным и единственным полем является email — это e-mail подписчика, для которого нужно получить список групп, в которых он состоит с временем подписки и текущим статусом.
Как работает
Вы передаёте email клиента в функцию API GetLeadGroupStatuses, в ответ ваша система получит результат выполнения функции и массив с группами подписки в переменной result. Массив групп будет выглядеть следующим образом:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 |
Array ( [0] => stdClass Object ( [rass_name] => ID группы 1 [rass_title] => Название группы 1 [rass_status] => статус подписки в группе 1 [subscription_time] => время подписки в группу 1 ) [1] => stdClass Object ( [rass_name] => ID группы 2 [rass_title] => Название группы 2 [rass_status] => статус подписки в группе 2 [subscription_time] => время подписки в группу 2 ) [2] => stdClass Object ( [rass_name] => ID группы 3 [rass_title] => Название группы 3 [rass_status] => статус подписки в группе 3 [subscription_time] => время подписки в группу 3 ) ) |
Ответ кодирован в формате JSON. Подробнее смотрите «Ответы API сервиса».
Возможные статусы подписки:
- STATUS_WAIT — ожидает активации
- STATUS_SUBSCRIBE — подписан/активирован
- STATUS_UNSUBSCRIBE — отписан
- STATUS_UNSUBSCRIBE_BY_SERVICE — отписан сервисом
- STATUS_INVALID_EMAIL — не существует
Пример на PHP получениия списка групп подписки
В примере получаем группы подписки для пользователя с и-мейлом [email protected], ваш логин в системе «username».
Функция GetHash — формирует подпись к передаваемым данным.
Функция CheckHash — проверяет подпись к ответу сервиса.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 |
// Логин в системе Expertam $user_rs['user_id'] = 'username'; // Ключ для формирования подписи. См. раздел API (ссылка в правом нижнем углу в личном кабинете) $user_rs['user_rps_key'] = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'; // Формируем массив данных для передачи в API $send_data['email'] = '[email protected]'; // e-mail клиента, для которого получаем список групп, в которых он состоит // Формируем подпись к передаваемым данным $send_data['hash'] = GetHash($send_data, $user_rs); // Вызываем функцию получение списка групп по мейлу клиента и декодируем полученные данные $resp = json_decode(Send('http://username.expertam.ru/api/GetLeadGroupStatuses', $send_data)); // проверяем ответ сервиса if(!CheckHash($resp, $user_rs)){ echo "Ошибка! Подпись к ответу не верна!"; print_r($resp); exit; } if($resp->error_code == 0){ echo "Список групп:"; print_r($resp->result); } else echo "Ошибка код:{$resp->error_code} - описание: {$resp->error_text}"; // =========== Функции отправки, получения и обработки ответа ============ // Отправляем запрос в 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); // выводим ответ в переменную $res = curl_exec($ch); curl_close($ch); return $res; } // Формируем подпись к передаваемым в 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); } // Проверяем полученную подпись к ответу 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; // подпись верна else return false; // подпись не верна } |
Загрузка...