Перейти к содержанию

Интеграция со сторонними системами с помощью специальной ссылки для создания пользователя и открытия страницы скачивания приложений

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

Сервис Neon позволит вам предоставить пользователям АТС возможность использования преднастроенных десктопных и мобильных софтфонов с минимальными усилиями.

Для этой цели используйте специальную ссылку, которую будет открывать ваш пользователь из вашего личного кабинета. После перехода пользователя АТС по ссылке из личного кабинета АТС будет создан Пользователь Neon, и в браузере пользователя откроется страница для скачивания Приложений Neon.

Пример размещения ссылки в личном кабинете АТС на странице пользователя

Расположить ссылку для скачивания приложения можно, например, на странице пользователя в личном кабинете вашей АТС:

Пример размещения ссылки в личном кабинете АТС

Адрес ссылки и её параметры описаны в следующем разделе.

Получение ссылки для создания пользователя и открытия страницы скачивания приложений

Получить ссылку для размещения в личном кабинете вашей АТС вы можете на странице Настройки компании вашей Панели управления версиями, пользователями и настройками Neon:

Получить ссылку для создания пользователя и открытия страницы скачивания приложений

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

https://neonsoftphone.ru/admin/api/v1/link/get?TENANT_ID=neon&USER_ID=101&SIP_MOBILE_LOGIN=101&SIP_MOBILE_PASSWORD=UGFzczEyMzQ1

Для работы ссылки предварительно создайте версию приложения, как описано в руководстве Быстрый старт.

Клик по ссылке или отправка GET запроса на указанный адрес приведёт к созданию пользователя в системе Neon. В созданном пользователе будут сохранены настройки, переданные в ссылке или запросе.

Параметры, которые отсутствуют в запросе, заменяются на значения по умолчанию (указаны в таблице).

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

Параметры, доступные для передачи в ссылке:

Название и описание Формат Значение по умолчанию и пример
TENANT_ID
Обязательный параметр
ID компании со страницы Настройки компании Панели управления версиями, пользователями и настройками Neon.		 string По умолчанию: нет значения.

Пример: neon
USER_ID
Обязательный параметр
Идентификатор пользователя (например, номер на АТС). Используется в сочетании с TENANT_ID в качестве логина приложения.
Должен быть уникальным в рамках личного кабинета Neon.
Если на момент открытия ссылки пользователь уже существует, настройки будут обновлены в соответствии с новыми настройками, полученными по ссылке.		 string По умолчанию: нет значения.

Пример: 101
APP_VERSION
ID версии, которую будет использовать пользователь. Если не задан, используется ID актуальной версии, выбранной в личном кабинете.		 string По умолчанию:
ID актуальной версии

Пример:1
USES_APPS
Какие приложения использует пользователь. Возможные значения:
  • PC
    Только приложения для компьютера;
  • MOBILE
    Только приложения для мобильных устройств;
  • ALL
    Приложения для компьютера и телефона.
 enum По умолчанию: ALL

Пример: ALL
TAGS
Теги, которыми помечается пользователь. Разделяются запятой, могут содержать пробелы. Значение параметра кодируется в URL Encode.		 string По умолчанию: пустое значение.

Пример: %D0%9F%D1%80%D0%BE%D0%B4%D0%B0%D0%B6%D0%B8%2C%20%D0%9C%D0%BE%D0%B1%D0%B8%D0%BB%D1%8C%D0%BD%D0%B0%D1%8F%20%D0%B2%D0%B5%D1%80%D1%81%D0%B8%D1%8F
APP_PASSWORD
Пароль приложения в кодировке Base64.		 string По умолчанию: генерируется автоматически*

Пример: YXBwcGFzczEyMw==
PUSH_ID
Идентификатор пользователя для отправки PUSH уведомления на мобильное устройство. Если не задан, выключается галочка Задать PUSH ID и используется значение поля SIP_LOGIN, если задан - галочка включается и в поле PUSH ID задаётся переданное в параметре значение		 string По умолчанию: значение SIP_LOGIN

Пример: push101
SIP_MOBILE_LOGIN
Обязательный параметр*
SIP логин мобильного приложения.		 string По умолчанию: нет значения.

Пример: 101
SIP_MOBILE_AUTH
SIP имя авторизации мобильного приложения		 string По умолчанию: совпадает с SIP_LOGIN

Пример: auth101
SIP_MOBILE_PASSWORD
Обязательный параметр*
SIP пароль мобильного приложения в кодировке Base64		 string По умолчанию: нет значения.

Пример: UGFzczEyMzQ1
SIP_PC_LOGIN
Обязательный параметр*
SIP логин десктопного приложения. Если не заполнен, галочка Использовать отдельную SIP учётную запись в приложении на компьютере у пользователя выключена, если заполнен - включена.		 string По умолчанию: нет значения.

Пример: pc_101
SIP_PC_AUTH
SIP имя авторизации десктопного приложения		 string По умолчанию: если задан SIP_PC_LOGIN совпадает с ним, иначе нет значения

Пример: authpc101
SIP_PC_PASSWORD
Обязательный параметр*
SIP пароль десктопного приложения в кодировке Base64.		 string По умолчанию: нет значения.

Пример: UGFzczEyMzQ1Ng==
SIP_CODECS
Кодеки, которые использует софтфон для совершения и приёма звонков. Несколько кодеков разделяются пробелами. Пробелы и символы / кодируются в URL Encode.		 string По умолчанию:
значение из версии

Пример:
PCMA%2F8800%2F1%20PCMU%2F8000%2F1
SIP_SERVER
SIP сервер учётных записей (для компьютера и смартфона)		 string По умолчанию: значение из версии

Пример: sip.example.com
SIP_PROXY
SIP прокси учётных записей (для компьютера и смартфона)		 string По умолчанию: значение из версии

Пример: sipproxy.example.com
SIP_DOMAIN
SIP домен учётных записей (для компьютера и смартфона)		 string По умолчанию: значение из версии

Пример: sipdomain.example.com

Пример ссылки с полными параметрами:

https://neonsoftphone.ru/admin/api/v1/link/get?DASHBOARD_ID=neon&USER_ID=101&APP_VERSION=1&USES_APPS=ALL&TAGS=%D0%9F%D1%80%D0%BE%D0%B4%D0%B0%D0%B6%D0%B8%2C%20%D0%9C%D0%BE%D0%B1%D0%B8%D0%BB%D1%8C%D0%BD%D0%B0%D1%8F%20%D0%B2%D0%B5%D1%80%D1%81%D0%B8%D1%8F&PUSH_ID=push101&SIP_MOBILE_LOGIN=101&SIP_MOBILE_AUTH=auth101&SIP_MOBILE_PASSWORD=UGFzczEyMzQ1&APP_PASSWORD=YXBwcGFzczEyMw==&SIP_PC_LOGIN=pc_101&SIP_PC_AUTH=authpc101&SIP_PC_PASSWORD=UGFzczEyMzQ1Ng==&SIP_CODECS=PCMA%2F8800%2F1%20PCMU%2F8000%2F1&SIP_SERVER=sip.example.com&SIP_PROXY=sipproxy.example.com&SIP_DOMAIN=sipdomain.example.com

В зависимости от полученного параметра USES_APPS отличается набор необходимых параметров SIP учётных записей:

  • PC
    Пользователь работает только в приложениях для компьютера. В запросе должны содержаться параметры SIP_PC_LOGIN и SIP_PC_PASSWORD;
  • MOBILE
    Пользователь работает только в приложениях для мобильных устройств. В запросе должны содержаться параметры SIP_MOBILE_LOGIN и SIP_MOBILE_PASSWORD;
  • ALL
    Пользователь работает в приложениях для компьютера и телефона. Если в запросе есть только один набор параметров SIP учётной записи (SIP_MOBILE_* или SIP_PC_*), приложения для компьютера и телефона используют одну и ту же SIP учётную запись. Чтобы передать данные отдельных SIP учётные записей для компьютера и мобильного приложения, передайте два набора параметров.