мессенджер на сайте для онлайн семинаров

Для установки мессенджера достаточно расставить ссылки в необходимых частях вашего сайта. Ссылки должны генерироваться на языке программирования на стороне сервера.

Так как сервис общения не требует регистрации пользователей, а использует данные с вашего сайта, вы должны во всех ссылках на мессенджер, передавать минимально необходимую информацию о пользователях: id пользователя, ник или имя и пол. Тогда эти данные будут доступны пользователям в списке контактов.

Для защиты от подмены ссылок используется md5-хэш строки, содержащей пароль из настроек мессенджера, IP-адрес пользователя и передаваемые в ссылке данные. Вы вычисляете md5-ключ на своем сервере и перенаправляете пользователя по ссылке с этим ключом. На нашем сервере ключ вычисляется по тем же правилам и сравнивается с вашим. При совпадении ключей запускается мессенджер.

Пароль должен быть достаточно сложным для подбора, а код, где он будет прописан, надежно защищен на вашем сервере от просмотра. Если пароль будет украден, то злоумышленники смогут открывать чужую переписку, читать и посылать сообщения от имени владельца. В случае обнаружения утечки пароля необходимо срочно его поменять.

Ссылки на открытие окна мессенджера должны быть следующего вида:

http://talkdriver.ru/?sid=<sid>&user=<user>&to=<to>&key=<key>

где:

<sid> ID мессенджера, зарегистрированного на этом сайте, доступно на странице "Вход".
<user> данные текущего залогиненного пользователя на вашем сайте в виде: id;ник;пол. Обязательным полем является только id. Пол: 0 - без пола, 1 - мужской, 2 - женский.
<to> данные пользователя, кому необходимо послать сообщение, также в виде: id;ник;пол.
<key> ключ для защиты от подмены ссылки в формате md5("<psw><ip><sid><user><to>").
<psw> пароль, указанный в настройках мессенджера.
<ip> IP-адрес текущего пользователя, чтобы нельзя было перехватить ссылку и зайти в окно переписки с другого IP.

ID пользователей это 32-битные числа от 1 до 2147483647 и они должны быть уникальны в пределах одного ID мессенджера (параметр sid).

Параметры user и to для передачи в ссылках необходимо кодировать функцией rawurlencode или urlencode, так как имена пользователей могут содержать спецсимволы. Параметр to может отсутствовать, в этом случае будет открыто окно мессенджера со списком контактов без начала общения с каким-либо пользователем.

Все ссылки должны открываться в одном и том же отдельном окне. Для этого в них необходимо указать атрибут target. Рекомендуем во всех ссылках использовать такой вариант: target="msg<sid>". Не используйте вариант target="_blank" для ссылок. В таком случае мессенджер будет открываться каждый раз в разных окнах, и, если их одновременно будет открыто несколько, то произойдет конфликт. Мессенджер позволяет общаться с несколькими пользователями в одном окне, поэтому нет необходимости в нескольких запущенных окнах одновременно.

Примеры ссылок в HTML-коде:

Спойлер:

Если вы хотите, чтобы мессенджер открывался в окне заданного размера, то воспользуйтесь кодом:

Спойлер:

Примеры кода на сервере

Все примеры представлены на языке .

Спойлер:

Ссылка на открытие окна мессенджера текущего пользователя без адресата $to:

Спойлер:

Для оповещения пользователей о новых сообщениях добавьте картинку со следующим адресом после ссылки на мессенджер в меню пользователя. В картинке будет отображаться количество новых сообщений.

Спойлер:

Для отображения статуса пользователей (онлайн или офлайн) используйте картинку со следующим адресом.

Спойлер:

Упрощенный вариант ссылок

Для удобства рекомендуем создать отдельный файл-скрипт на сервере, в котором будет происходить редирект на страницу мессенджера со всеми необходимыми параметрами, например, "msg.php" в корне веб-сервера. В таком случае все ссылки на сайте делаются в виде: "/msg.php" - открыть окно, "/msg.php?to=".$to_id - открыть окно и начать переписку с пользователем $to_id. При таком варианте все ссылки выглядят простыми и локальными, ведущими на основной домен сайта, а вся логика по генерации ссылок выносится в отдельный файл.

Пример скрипта "msg.php":

Спойлер:

Пример ссылки:

Спойлер:

Домен сервиса

Вместо адреса talkdriver.ru возможно использовать любой другой с тем же IP-адресом. Таким образом, вы можете настроить поддомен в вашем домене на сервис мессенджера, и для пользователей он будет выглядеть разделом вашего сайта.

Чтобы не зависеть от смены IP-адреса в будущем, для поддомена лучше всего прописать альяс CNAME в DNS настройках:

Спойлер:

Информационный фрейм

В окне мессенджера имеются два верхних фрейма, в которых будет загружаться информация о пользователях-собеседниках. Слева − текущий пользователь мессенджера, справа − активный пользователь из списка контактов, с которым идет переписка. Адрес для фреймов вводится в настройках мессенджера и должен указывать на скрипт вашего сайта. Скрипту будут передаваться в параметрах ID пользователя из контактов и ID текущего пользователя мессенджера. Таким образом, вы сможете, например, выводить фотографию пользователя или другие данные. Высота фреймов 80 пикселей. Если адрес не указать в настройках, то фреймы не будут выводиться.

Передаваемые параметры (метод GET):

<id> ID пользователя из списка контактов, информацию о котором необходимо отобразить во фрейме.
<uid> ID пользователя мессенджера.

Кроме этих параметров будут переданы все те, что вы укажете в настройках мессенджера в адресе скрипта после знака "?".

Например, если указать в настройках адрес "http://mysite.ru/msg_user.php", то адрес фрейма будет "http://mysite.ru/msg_user.php?id=<contact_id>&uid=<user_id>", а примерный скрипт будет выглядеть так:

Спойлер:

Картинки пользователей в списке контактов

Вы также можете в настройках мессенджера указать адрес скрипта на вашем сервере, через который будут загружаться картинки пользователей в списке контактов для лучшего восприятия списка. Ваш скрипт будет получать ID пользователя из контактов и должен выводить соответствующую этому пользователю картинку или фото размером 28x28 пикселей в формате jpg, gif или png. Если этот адрес не будет указан в настройках, то контакты будут выводиться без картинок в более компактном виде.

Передаваемые параметры (метод GET):

<id> ID пользователя из списка контактов.

Кроме этого параметра будут переданы все те, что вы укажете в настройках мессенджера в адресе скрипта после знака "?".

Например, если указать адрес "http://mysite.ru/msg_icon.php", то адрес картинок будет "http://mysite.ru/msg_icon.php?id=<contact_id>", а примерный скрипт будет выглядеть так:

Спойлер:

Пример приведен только для формата картинок jpeg. При необходимости доработайте его и для других форматов.

WAP-версия мессенджера

Для WAP-версии мессенджера необходимо использовать адрес: wap.talkdriver.ru или wap.<ваш поддомен>.

Для своего поддомена необходимо добавить альяс в DNS настройки:

Спойлер:

Так как в мобильных телефонах обычно используется только одно окно в браузере, и окно мессенджера открывается поверх основной страницы, то в WAP версии дополнительно в ссылках на мессенджер используется параметр r, через который передается адрес для возврата на основной сайт, чтобы пользователи могли вернуться после отправки или прочтения сообщений.

Спойлер:

Мессенджер для службы поддержки

Наш сервис общения можно использовать не только для пользователей вашего сайта, но и для службы поддержки или консультантов. Для этого необходимо завести мессенджер в нашей системе и прописать ссылки на вашем сайте для одного или нескольких ваших работников. ID для работников придумайте такие, чтобы они не могли совпасть с ID пользователей. Если хотите, чтобы посетители сайта могли писать сообщения без регистрации, генерируйте каждый раз уникальный ID для посетителей-гостей и сохраняйте его в сессии или куках на случай, если посетитель закроет окно общения и захочет снова в него зайти.

Примеры ссылок для работников:

Спойлер:

Примеры ссылок для посетителей:

Спойлер:

Параметр <to> в последнем примере содержит только ID пользователя-работника, так как после первого открытия мессенджера работниками в базе сохранятся данные этих пользователей, и далее нет необходимости их передавать.
Специальный режим для службы поддержки

Для облегчения задачи по подключению мессенджера в качестве службы поддержки существует простой способ, который включается в настройках мессенджера флажком "Использовать мессенджер для службы поддержки".

В этом варианте вы просто должны разместить на своем сайте следующий HTML-код:

Спойлер:

Данный код можно подключить к любому сайту даже на бесплатном хостинге − он не требует программирования. После размещения кода ваши посетители смогут задавать вам вопросы прямо с сайта и получать ответы в реальном времени или заходя на сайт позже. В этом варианте все пользователи будут обращаться к вам анонимно, т.е. без регистрации на сайте. ID для пользователей будет выбираться уникальным в диапазоне от 10000000. После того как пользователь один раз откроет окно, его ID сохранится в куках, и позже он всегда будет обращаться в службу поддержки под этим ID и видеть ответы и предыдущую переписку.

Если вы хотите, чтобы зарегистрированные пользователи могли обращаться к вам под своими постоянными именами и ID, то для них дополнительно передайте в обеих ссылках параметры <user> и <key>, которые должны генерироваться на вашем сервере по описанным выше правилам.

В качестве ID пользователя для службы поддержки в этом режиме используется число 99999999. Для входа в окно мессенджера под этим пользователем вы можете использовать ссылку "Вход" со страницы управления на этом сайте, либо разместить ссылку на своем сайте в недоступном для посетителей месте. Ссылку необходимо генерировать на сервере с учетом пароля и IP-адреса по описанным выше правилам.

Параметр <sid> в коде - это ID мессенджера, а <crc> - контрольный ключ для защиты ссылки. Эти параметры будут доступны после создания мессенджера по ссылке "Код для установки" на странице управления.

Javascript, выводимый командой document.write, предназначен для отображения ответа от службы поддержки − мигающего конверта. Когда новых ответов нет, пользователь будет видеть пустой конвертик, который можно отключить, установив параметр js в адресе скрипта в значение 2.

Если вы подключили один сервис поддержки к нескольким сайтам, то можете использовать дополнительный параметр site в команде открытия окна "open", например, "&site=mysite.ru". Тогда к именам пользователей будет добавлен этот текст.

Для отображения статуса службы поддержки (онлайн или офлайн) используйте упрощенный вариант картинки:

Спойлер:

Для отображения своей картинки в зависимости от статуса оператора можно использовать код:

Спойлер:

Программный интерфейс (API)

Вы можете автоматически рассылать сообщения со своего сервера от одного пользователя другому. Например, сообщения от администратора или разные уведомления о событиях на сайте. Также возможно посылать одно сообщение сразу всем пользователям.

Для рассылки сообщений воспользуйтесь скриптом:

http://talkdriver.ru/send.php?sid=<sid>&user=<user>&to=<to>&key=<key>&msg=<msg>

Параметры здесь такие же, как в разделе "Описание сервиса". Дополнительный параметр <msg> содержит текст посылаемого сообщения и должен быть закодирован функцией rawurlencode. Для генерации ключа <key> используется IP-адрес вашего сервера, с которого будет выполнен вызов скрипта.

Если параметр <to> отсутствует или равен 0, то будет выполнена рассылка всем пользователям мессенджера.

Данный скрипт можно вызывать методом GET или POST. При отправке сообщения пользователи (отправитель и получатель) автоматически добавляются друг другу в контакты, но при массовой рассылке новый контакт будет добавлен только получателям сообщений.

Поиск пользователей в списке контактов

В мессенджере имеется функция поиска новых пользователей и добавления их в список контактов. Для возможности искать пользователей по вашей базе на сайте укажите в настройках адрес для скрипта на вашем сервере, который будет возвращать данные пользователя по введенному в строке поиска имени или нику. Если скрипт не указать, то поиск будет осуществляться по нашей базе среди пользователей, хотя бы один раз зашедших в мессенджер.

Передаваемые параметры (метод GET):

<sid> ID мессенджера.
<uid> ID пользователя, выполняющего поиск.
<data> строка с введенным именем пользователя.

Кроме этих параметров будут переданы все те, что вы укажете в настройках мессенджера в адресе скрипта после знака "?".

Ваш скрипт должен вернуть строку с данными пользователя в формате "id;ник;пол", если пользователь будет найден, и пустую строку в другом случае. Обязательным полем в возвращаемой строке является только id пользователя.

Пример скрипта:

Спойлер:

Рассылка уведомлений о новых сообщениях

Для уведомления пользователей о новых сообщениях вы можете создать специальный скрипт на вашем сервере и указать его адрес в настройках мессенджера. Наша система периодически проверяет базу сообщений пользователей, собирает информацию о новых сообщениях и передает эти данные на ваш скрипт. Задача вашего скрипта - получить для каждого пользователя контакты из базы, например, адрес e-mail, и послать по ним уведомление о новых сообщениях. Таким образом, рассылка сообщений будет происходить с вашего сервера, и нет необходимости передавать контакты пользователей в нашу систему. Если же вы не укажете в настройках адрес скрипта, то уведомления будут рассылаться нашим сервером только для пользователей, у которых указан e-mail. Адрес e-mail пользователи могут вводить сами в настройках, или его можно передавать в ссылках на открытие мессенджера 4-м параметром в данных о пользователе.

Передаваемые вашему скрипту параметры методом POST:

<sid> ID мессенджера.
<data> строка с данными о новых сообщениях в формате:
"user:from-cnt:from-cnt:...;user:from-cnt:from-cnt:...;...",
где user - ID пользователя, получившего сообщения, from - ID пользователя отправившего сообщение, cnt - количество новых сообщений от пользователя from.

Кроме этих параметров будут переданы все те, что вы укажете в настройках мессенджера в адресе скрипта после знака "?".

В вашем скрипте необходимо будет распарсить строку data, сгенерировать текст уведомления со списком отправителей и количеством сообщений для каждого пользователя-получателя и разослать им сообщение с этим текстом, например, на e-mail.

Пример скрипта:

Спойлер:

Демонстрация работы мессенджера:

Приводим пример готового подключенного мессенджера с фиксированным набором пользователей.
Код этого примера:

Спойлер:

Пример мессенджера для службы поддержки:

Приводим пример мессенджера для службы поддержки, используемого на этом сайте. Ссылка на вход в мессенджер вверху страницы. Пример позволяет обращаться в службу поддержки как зарегистрированным пользователям, так и анонимным гостям.

Код для вывода ссылки на сайте для общения со службой поддержки:

Спойлер:

Код для вывода ссылки для службы поддержки для общения с посетителями:

Спойлер: