帮助中心集成

为了: 管理员

使用管理密钥添加和更新用户

列出您中心的成员,添加客户,查看某人的详细信息和案例,以及禁用或重新启用他们的访问权限。

在本文中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列出了某人当前处于的各种状态或情况

列出人员

范围它的作用必需的默认
type1 仅适用于喜欢活跃生活的人士。 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不没有
genderMale 或 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为什么
400SchemaFieldsException某个字段缺失或无效;系统会使用errors来表示这种情况。例如,FieldUsernameTypeException表示用户名不是有效的电子邮件或电话号码,FieldPhoneTypeException表示无效的电话号码,而FieldNameTypeException则表示名称无效。
400FieldUsernameDupsException在你的联系人中已经有人拥有那个电子邮件地址或电话号码了。reason正在使用他们的user_id。
400HostUserDisabledException那个人在你的枢纽中处于禁用状态。请重新启用他们的权限吧。reason负责管理他们的user_id事务。
400UserReferenceIdExistsException已经有人拥有那个了。host_ref_id
400HostUserTypeNotAllowedException你们试图罢免一名管理员,或者干脆禁用这个权限键。
403BotRelationFieldNotAllowedException在添加某人或某个对象时,你应该使用“case power”这个命令;而在删除它们时,则不应使用host_user_status这个命令。
404ItemNotFoundException在你的社区里,没有人拥有那个user_id

关于错误 bodies 以及其他代码格式,请参考 处理 API 错误和状态代码 的相关说明。

相关文章

使用管理密钥添加和删除案例成员为案件分配人员角色和职称,发送邀请邮件,查看案件中的人员,或将某人从案件中移除。集成使用管理密钥搜索案例和用户从您自己的软件中查找案例、人员、案例成员、角色,并按文本和筛选条件导入行。集成禁用或重新启用用户您可以选择不删除联系人就将其从您的 Hub 中屏蔽,或者重新授予其访问权限。无论哪种情况,您都会通过电子邮件或短信通知对方。您的客户 · 1 min