Для: Администраторы
Добавляйте и обновляйте пользователей с помощью управляющего ключа.
Составляйте списки пользователей вашего центра, добавляйте клиентов, читайте подробные сведения и обращения пользователей, а также отключайте или повторно включайте их доступ.
В этой статье7 разделов
Прежде чем начать
На этой странице указаны способы обращения к людям, работающим в вашем центре обработки заказов. Пути доступа указаны под https://prd-api-manage.caseactive.com/v1/<hub id>. Ключ позволяет добавлять людей в список пользователей, а также изменять информацию о них – только в том случае, если они могут войти в систему. Нельзя сделать кого-либо администратором или менеджером, а также невозможно изменить их контактную информацию после добавления в список пользователей.
Звонки
| Вызов | Что это делает |
|---|---|
GET /users/relations | Список людей, находящихся в вашем центре управления. |
POST /users/relations | Кто-то добавляет что-то. |
GET /users/relations/<user_id> | Читает одного человека |
PUT /users/relations/<user_id> | Отключает или снова активирует кого-либо |
GET /users/relations/<user_id>/cases | Перечисление случаев, в которых человек находится. |
Список людей
| Параметр | Что это делает | Необходимый | По умолчанию |
|---|---|---|---|
type | 1 предназначено только для активных людей, а 0 – для людей с ограниченными возможностями. Несмотря на название, фильтр работает на основе статуса пользователя, а не его типа. | Нет. | Оба |
limit | Сколько человек может находиться на одной странице – до 1000 человек. | Нет. | 20 |
start_key | startKey из предыдущей страницы | Нет. | Первая страница |
У каждого человека есть следующие параметры: user_id, given_name, family_name, email, phone, email_verified, phone_verified, locale, zoneinfo, host_user_type (admin, manage или user), host_user_status (1 активно используется, 0 неактивно), host_ref_id, host_default_role, host_staff_designation, host_cases_ct (количество случаев использования этих параметров), host_granted_status (approve или reject после того, как доступ к профилю этого человека снимается с вашей платформы) и created_on. Список не имеет определенной последовательности. В список включен Виртуальный помощникВиртуальный помощник Автоматизированный член команды, который публикует приветственные сообщения, проводит проверки и организует публикации для компании; его публикации отмечены значком виртуального помощника. вашего центра обработки данных; его параметр host_user_type равен bot. Также в список включены два примера людей, которые используются каждым новым центром обработки данных. Один из этих человеков, Staff Demo, имеет параметры host_user_type staff. Если в списке еще есть люди, позвоните по номеру nextLink или отправьте сообщение по адресу startKey как start_key.
Добавление кого-либо
| Поле | Что это делает | Необходимый | По умолчанию |
|---|---|---|---|
username | Имя и адрес электронной почты, или номер мобильного телефона с кодом страны, например +12035556677. Номер без кода страны считается номером из США. | Да. | — |
given_name, family_name | Имя и фамилия должны быть указаны в напечатанном виде. Если одно из имени или фамилии написано в строчных буквах, а другое – в заглавной форме, то такие слова также нужно указывать с заглавной буквы: mary smith сохраняется как Mary Smith. | Да. | — |
locale | Язык: ar, de, en, es, fr, id, it, ja, pl, pt, ru или zh | Нет. | en |
zoneinfo | Часовая зона, например: America/New_York | Нет. | US/Eastern |
host_ref_id | У вас должна быть своя идентификационная информация для них – например, номер клиента. Эта информация состоит из букв, цифр, диакритических знаков. Все символы должны писаться в строчных буквах. Ни один человек не может использовать одну и ту же информацию для нескольких людей. | Нет. | Ничего. |
host_default_role | Эта роль принимается в первую очередь, когда элементы добавляются в определенную структуру, например, в role::clients. Однако она не предоставляет никаких преимуществ. | Нет. | role::clients |
host_staff_designation | Их обычные обозначения персонала: primary, attorney, paralegal, case_manager, lead_attorney или lead_paralegal | Нет. | primary |
birthdate | Дата рождения, например: 1985-04-12 | Нет. | Ничего. |
gender | Male или Female | Нет. | Ничего. |
address1, address2, locality, region, postal_code | Адрес: второй столбец, город, штат и почтовый индекс | Нет. | Ничего. |
country | Двухбуквенный код страны, например: US | Нет. | Ничего. |
company, title | Компания и должность | Нет. | Ничего. |
host_meta_data | У них есть собственные поля для отображения информации – по одному объекту на страницу пользователей. Страницы можно просматривать с помощью символа GET /schemas?schema_type=users. Поле, помеченное как необходимые, может быть опущено: проверяется только поле “Изменить пользователя”. | Нет. | Ничего. |
curl -X POST https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/users/relations \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"username": "jane.sample@example.com", "given_name": "Jane", "family_name": "Sample", "zoneinfo": "America/New_York", "host_ref_id": "cl-1042"}'
Это соответствует значению 201 их значения user_id.
{"data": {"host_id": "ca-7e6d5c4b3a2f10", "user_id": "cu-4f1c2a9e8b7d60", "selfLink": "https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/users/relations"}}
- Каждый человек, которому вы добавляете ключ, становится пользователем. Он будет активен, независимо от того, что вы ему отправляете.
- Ключ не может давать никому права управления порталами: создание дел, добавление людей в дела или их удаление. Передача значений
host_create_case,host_add_case_userилиhost_remove_case_userтакже невозможна; никто не может быть добавлен в дела. Администратор может установить эти значения на Редактировать пользователя. - Если у адреса или номера уже есть учетная запись, принадлежащая какой-либо другой компании, то человек соединяется с этой учетной записью. В противном случае создается новая учетная запись. В любом случае никто не получает электронных писем или сообщений. Они узнают о вас только тогда, когда вы добавляете их в список участников проекта с помощью соответствующего ключа управления. См. раздел Добавление и удаление участников проекта с помощью ключа управления.
Чтение кого-либо
GET /users/relations/<user_id> отвечает за все данные из списка. Кроме того, в нем указаны дата рождения, пол, адрес, компания и должность человека. Также имеются переменные данных, варианты уведомлений, а также информация о последнем времени входа в систему. GET /users/relations/<user_id>/cases отображает список дел, в которых человек участвует; включая закрытые дела. В каждом деле указаны следующие данные: case_id, title, case_ref_id (ID вашей базы данных), :: и ID тегов). Также указаны case_status, а также case_role_id и case_designation для этого дела.
Лишение кого-либо дееспособности или восстановление дееспособности
Функция PUT /users/relations/<user_id> принимает один параметр – host_user_status. Параметр 0 используется для отключения этих элементов. Параметр 1 используется для снова активации этих элементов. Функция возвращает значение 204.
curl -X PUT https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/users/relations/cu-4f1c2a9e8b7d60 \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"host_user_status": 0}'
- У людей с инвалидностью отказывают во всем, что связано с использованием их аккаунта. Но они продолжают использовать свой аккаунт для работы с другими компаниями. См. раздел Отключение или регистрация пользователя.
- Когда состояние пользователя меняется, им отправляется электронное письмо или сообщение, если у них нет электронной почты. В таких случаях сообщается о том, что доступ к данному аккаунту был заблокирован или восстановлен. Передача информации о текущем состоянии пользователя ничего не изменяет и не приносит никакой пользы.
- Ключ может отключать или снова включать права управления для менеджеров и пользователей, но не для администраторов или самого ключа.
Если звонок отклонен
| Статус | message | Почему |
|---|---|---|
| 400 | SchemaFieldsException | Поле отсутствует или имеет некорректное значение. errors Называйте это так, например: FieldUsernameTypeException Для имена пользователя, который не является адресом электронной почты или номером телефона. FieldPhoneTypeException Если номер телефона некорректен… FieldNameTypeException Для имени |
| 400 | FieldUsernameDupsException | У кого-то из людей, активно использующих ваш сервер, уже есть такой адрес электронной почты или номер телефона. reason имеет право использовать user_id. |
| 400 | HostUserDisabledException | Этот человек находится в вашем лагере, но он не может двигаться. Лучше снова активировать его возможности. reason удерживает его в состоянии user_id. |
| 400 | UserReferenceIdExistsException | Кто-то другой уже имеет этот host_ref_id. |
| 400 | HostUserTypeNotAllowedException | Вы попытались отстранить администратора от должности, или же просто уничтожить сам ключ для доступа. |
| 403 | BotRelationFieldNotAllowedException | Вы отправляете данные о параметрах объекта при добавлении нового человека или любого другого элемента. Но при изменении таких параметров необходимо использовать значение host_user_status. |
| 404 | ItemNotFoundException | У вас в этом хабе никто не имеет такого user_id. |
Что касается текста ошибок и остальных кодов, см. раздел Управление ошибками API и статусными кодами.