Подключение нового профиля

Новый профиль содержит расширенную информацию о пользователе.

Часть информации завязана на интеграции и недоступна для редактирования пользователем.

Данные зависящие от интеграции:

• отдел
• должность
• место работы
• день рождения – заполняется при интеграции, но на UI не отображается
• режим работы – гибрид/офис/удаленный
• номер телефона

Данные поля не будут отображаться в UI, если не настроена интеграция или данные поля не были заполнены.

подсказка

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

Другая часть информации доступна для ручного заполнения в разделе Профиль -> Настройки профиля.

Данные, заполняемые пользователем:

• дополнительные контакты
• график работы

Интеграция

Для интеграции необходимо использовать метод API (ниже приведено описание метода).

Для обновления полей профиля необходимо создать бота с правами системного администратора, и через токен аутентификации этого бота, вызывать API.

Обновление профиля пользователя

Требует авторизацию от бота и права update_user_profiles (по умолчанию роль system_admin)

Метод запроса

PATCH /users/{user_id}/profile

Параметры запроса:

Название	Тип	Обязательность	Описание
user_id	string	да	id пользователя

Тело JSON-запроса

{
  "phone": "string",
  "additional_contact_name": "string",
  "additional_contact": "string",
  "hide_additional_contact": false,
  "schedule": "string",
  "hide_schedule": false,
  "work_place": "string",
  "work_scheme": "string",
  "department": "string",
  "position": "string",
  "birthday": "string",
  "profile_url": "string"
}

Описание параметров:

Название	Тип	Обязательность	Описание
phone	string	нет	Номер телефона пользователя, в произвольном формате.
schedule	string	нет	График работы пользователя, в произвольном формате.
hide_schedule	boolean	нет	Установите значение в true, чтобы скрыть время работы от других пользователей, false — показывать для всех. По умолчанию — false.
work_place	string	нет	Место работы, в произвольном формате.
work_scheme	string	нет	Режим работы, в произвольном формате. Например: гибрид/офис/удаленный.
department	string	нет	Отдел пользователя.
position	string	нет	Должность пользователя.
birthday	string	нет	День рождения пользователя в формате RFC3339. Данный параметр не отображается на UI.
profile_url	string	нет	Ссылка на профиль пользователя в другой системе. Например, в той, с которой настроена интеграция.
additional_contact	string	нет	Дополнительный контакт. Например: ссылка на соц. сети.
additional_contact_name	string	нет	Название дополнительного контакта. Например: telegram.
hide_additional_contact	boolean	нет	Для скрытия дополнительного контакта от других пользователя установите значение в true, для показа — true. По умолчанию false.

Пример ответа кодом 200

200 Response

{
  "user_id": "string",
  "phone": "string",
  "is_public_phone": false,
  "additional_contact_name": "string",
  "additional_contact": "string",
  "hide_additional_contact": false,
  "schedule": "string",
  "hide_schedule": false,
  "work_place": "string",
  "work_scheme": "string",
  "department": "string",
  "position": "string",
  "birthday": "string",
  "profile_url": "string"
}

Варианты ответа на запрос

Код ответа	Значение	Описание
200	OK	Запрос выполнен успешно
400	Bad Request	Ошибка в запросе
401	Unauthorized	Предоставлен неверный токен
403	Forbidden	Доступ запрещен

Ответ для кода 200

Параметры ответа:

Название	Тип	Обязательность	Описание
user_id	string	да	Идентификатор пользователя.
phone	string	нет	Номер телефона пользователя, в формате E.164.
is_public_phone	boolean	нет	Для показа номера телефона другим пользователям установите параметр в true, чтобы скрыть — false. По умолчанию: false.
schedule	string	нет	Время работы пользователя, в произвольном формате.
hide_schedule	boolean	нет	Установите значение в true, чтобы скрыть время работы от других пользователей, false — показывать для всех. По умолчанию: false.
work_place	string	нет	Расположение рабочего места, офис, в произвольном формате.
work_scheme	string	нет	Схема работы, в произвольном формате.
department	string	нет	Департамент работы пользователя.
position	string	нет	Роль или должность пользователя.
birthday	string	нет	День рождения пользователя в формате RFC3339.
profile_url	string	нет	Ссылка пользователя во внешней системе.
additional_contact	string	нет	Дополнительный контакт, например ссылка на соц. сети.
additional_contact_name	string	нет	Название дополнительного контакта, например Telegram.
hide_additional_contact	boolean	нет	Для скрытия дополнительного контакта от других пользователя установите значение в true, для показа — true. По умолчанию: false

Ответ для кода 400

Параметры ответа:

Название	Тип	Обязательность	Описание
status_code	integer	нет	Код ответа.
id	string	нет	id ответа.
message	string	нет	Сообщение ответа.
request_id	string	нет	id запроса.

Ответ для кода 401

Параметры ответа:

Название	Тип	Обязательность	Описание
status_code	integer	нет	Код ответа.
id	string	нет	id ответа.
message	string	нет	Сообщение ответа.
request_id	string	нет	id запроса.

Ответ для кода 403

Параметры ответа:

Название	Тип	Обязательность	Описание
status_code	integer	нет	Код ответа.
id	string	нет	id ответа.
message	string	нет	Сообщение ответа.
request_id	string	нет	id запроса.

Ответ для кода 404

Параметры ответа:

Название	Тип	Обязательность	Описание
status_code	integer	нет	Код ответа.
id	string	нет	id ответа.
message	string	нет	Сообщение ответа.
request_id	string	нет	id запроса.

Включение нового профиля

Для включения нового профиля пользователя необходимо:

• в конфигурации сервера установить переменную среды (env): TIME_SERVICESETTINGS_ENABLENEWPROFILE: true
• перезагрузить клиенты webapp, desktop и mobile

примечание

Для изменения параметра в SaaS инсталляции Time обратитесь в техническую поддержку.

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