Добавление пользователей в ЛК Team из csv файла
В описании API личного кабинета Team указан пример добавления пользователя в личный кабинет. Для автоматизации процесса добавления ,большого количества пользователей можно написать скрипт, который будет загружать данные о сотрудниках из csv таблицы и добавлять пользователей в личный кабинет. В данной статье приведён пример такого скрипта на PowerShell.
Инструкция и образец скрипта тестировались на компьютере с ОС Windows 10. На компьютере должен быть разрешён запуск Powershell скриптов.
1. Скачайте архив с файлами скрипта и файлом данных: Add_Agents_to_Team.zip
2. Распакуйте архив в папку на вашем компьютере. В архиве три файла:
- add_agents.ps1 - PowerShell скрипт, который выполняет запросы к личному кабинету Team;
- add_agents.bat - исполняемый файл с реквизитами вашего личного кабинета, который нужно отредактировать, указав реквизиты вашего личного кабинета;
- agents.csv - файл с данными о пользователях, которые нужно добавить.
3. Откройте файл agents.csv. Данные в файле приведены для примера, заполните их своими значениями. Если параметр помечен как обязательный, соответствующий столбец в строке с данными пользователя не может быть пустым. Наличие строки с заголовками обязательно.
Описание столбцов:
| Название столбца | Описание | Пример | Обязательный параметр |
|---|---|---|---|
| usesSP | Использует ли пользователь софтфон. Возможные значения: true/false. | true | да |
| name | Имя пользователя, непустая строка, длиной до 256 символов. | John | да |
| surname | Фамилия пользователя, непустая строка, длиной до 256 символов. | Doe | да |
| Электронная почта пользователя. | user@company.ru | да | |
| password | Пароль пользователя, непустая строка, длиной от 6 до 256 символов. | 123456 | да |
| role | Роль пользователя. |
EMPLOYEE - оператор; MANAGER - руководитель; RESTRICTED_ADMIN - администратор (без управления подпиской). |
да |
| groupsIn | ID групп, в которых пользователь будет состоять, один или несколько через запятую.
ID групп можно получить в адресной строке браузера во время настройки группы. |
1 - пользователь состоит в группе с ID 1; 2,4,7 - пользователь состоит в группах с ID 2, 4 и 7. |
да |
| groupsMan | ID групп, которыми пользователь будет управлять, если его роль MANAGER или RESTRICTED_ADMIN, один или несколько через запятую. Для роли EMPLOYEE - пустое значение. ID групп можно получить в адресной строке браузера во время настройки группы. |
1 - пользователь управляет группой с ID 1; 2,4,7 - пользователь управляет группами с ID 2, 4 и 7. |
нет |
| siplogin | Логин SIP учётной записи пользователя, строка длиной до 256 символов. | sip101 | нет |
| sippassword | Пароль SIP учётной записи, строка длиной до 256 символов. | sippass123 | нет |
| sipdisplayname | Отображаемое имя SIP учётной записи пользователя, строка длиной до 256 символов. | sip101 | нет |
| sipauthname | Имя авторизации SIP учётной записи пользователя, строка длиной до 256 символов. | sip101 | нет |
| ext | Добавочный номер SIP учётной записи пользователя на АТС, строка длиной до 256 символов. | 101 | нет |
4. Сохраните файл.
При работе с csv файлом в сторонних редакторах убедитесь, что в сохраняемом файле используется разделитель точка с запятой (;) для отделения значений, а не запятая.
5. Откройте файл add_agents.bat в текстовом редакторе и укажите в параметрах token, dashboard и filepath настройки, необходимые для работы скрипта:
- token - укажите токен Администратора личного кабинета, полученный как описано в пункте Логин и получение токена описания API личного кабинета Team;
- dashboard - укажите адрес вашего личного кабинета Team в виде https://{YOUR_TENANT}.softphone.pro, где {YOUR_TENANT} это адрес вашего ЛК в сервисе Team, строка после https:// до первой точки;
- filepath - если файл agents.csv находится в той же папке, что и скрипты, оставьте значение .\agents.csv. Если вы хотите использовать файл в другой папке, укажите полный путь к CSV файлу.
Сохраните изменения в файле.
6. Запустите файл add_agents.bat двойным кликом и дождитесь выполнения скрипта.
Если пользователь из таблицы был добавлен успешно, вы увидите в открывшемся окне строку вида:
Successfully added Agent #1 from csv
Номер после # в строке соответствует порядковому номеру строки с данными пользователя из csv файла (без учёта заголовков).
Если пользователь не был добавлен, вы увидите строку вида:
Error adding Agent #2 from csv, got error 500 from Team Dashboard.
В данной строке указан порядковый номер пользователя из файла, которого не удалось добавить, и код ошибки, полученной из личного кабинета сервиса Team.