帮助中心集成

为了: 管理员

使用中心密钥读取和更新案件详情

阅读案件详情和团队信息,并更改管理员允许虚拟助理角色更改的详情,例如阶段或自定义字段。

在本文中8 个部分

开始之前

此页面介绍了如何使用中心钥匙来读取和修改某个案例的详细信息。相关路径位于https://prd-api-app.caseactive.com/v1/<hub id>/<case id>之下。

电话

称呼它的作用
GET /case阅读了案件的详细情况
PUT /case修改了细节信息,密钥可能会发生变化。
GET /whoami文中详细说明了在本案中关键信息可能呈现的形式以及它会涉及哪些部分。
GET /team列出了与这个案件相关的人员名单
GET /placeholders读取了模板中的代码在这个案例中所填充的值。

多么有趣啊,Hub Key可以读取并修改与你的Hub相关的各种设置。 虚拟助手虚拟助手 一个自动化的团队成员,负责发布欢迎信息、签到信息和公司动态;其发布的帖子带有虚拟助理徽章。, 机器人. 该系统默认会读取案件的标准信息,除非管理员进行授权,否则无法修改这些信息。

让关键变更细节

在……中 设置 › 角色, 编辑机器人的角色设置,并在相应位置进行配置。 案件, 蟋蟀 更新角色中指定的所有案例字段信息。 而细节方面,密钥可能会发生变化: 标题, 描述, 打开日期, 状态, 阶段 或者自定义字段。若希望让系统读取自定义字段,请勾选该选项。 阅读角色中指定的所有案例字段信息。. 查看 改变一个角色所能做的事情.

GET /whoami 解答了关于此案件中钥匙所扮演的关键角色的问题。 case_read_fields 以及 case_write_fields, 具体的内容可能会有所变化。 case_write_fields 被排除在外了,因为它可能并不会产生任何变化。在自定义字段中,该选项会显示为“无”。 meta_data.<field key>. 这也回答了相关问题。 case_modules, 该案例所涉及的各个部分——包括你的中心区域以及此案例中隐藏的那些部分。对于缺失的那些部分,任何请求都将被拒绝。

阅读案例

curl https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/case \
  -H "Authorization: Bearer YOUR_API_KEY"
{
  "data": {
    "case_id": "cc-1a2b3c4d5e6f70",
    "host_id": "ca-7e6d5c4b3a2f10",
    "ref_id": "rear-end-2026",
    "title": "Jane Sample auto accident",
    "description": "Rear-end collision on Route 9. Waiting on the insurer's estimate.",
    "case_type": "general",
    "case_status": 1,
    "case_stage": "stage::20260927120000_8c1f0e2d3b4a59",
    "date_opened": "2026-03-05",
    "meta_data": {
      "schema": [{"schema": {"type": "object", "properties": {"policy_number": {"type": "string", "title": "Policy number"}}}}],
      "content": [{"policy_number": "PN-5521"}]
    },
    "selfLink": "https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/case"
  }
}
  • 默认情况下,这些键的显示顺序为 case_id、ref_id(即 标签ID标签 ID 您给案例赋予的永久标签,例如 rear-end-2026,也显示为参考 ID,并在导入时使用。)、case_status、date_opened、title、description、case_type 和 case_stage。不过,有些细节情况并未在说明中提及。
  • case_stage是某个阶段阶段 案件进展过程中的一个步骤,例如受理或发出索赔请求,公司会对其进行命名和描述,并在案件页面上显示该步骤。的标识符;GET /v1/<hub id>/stages则列出了这些阶段的名称。
  • meta_data.content用于保存自定义字段的值,每个字段对应一个对象,这些对象按照字段键进行排序。不过,只有那些该键能够读取的字段才会被包含在内。默认情况下,该字段不会读取任何数据,因此第一页会显示为空;在示例中,管理员允许该字段读取“政策编号”这一字段。meta_data.schema则用于描述每一页上显示的字段列表。
  • hidden_modules列出了当前案例中被隐藏的部分,如果有的话。

更改案件

PUT /case可以接受这些字段中的任意一项作为JSON数据,并且只会修改你提供的那些字段。

场地它的作用必需的默认
title这个案件的名称,已经向所有人公示了。不保持不变
description关于员工的描述。如需清除这些信息,请发送""。不保持不变
date_opened该案件的立案日期,例如 2026-03-15不保持不变
case_status0 关闭该案例。某个中心节点无法再次打开它。不保持不变
case_stage该舞台的ID为GET /v1/<hub id>/stages。请发送""以将物品从舞台上取下。不保持不变
meta_data自定义字段值:每个字段页面上显示一个条目,这些条目按照字段键的顺序排列,每个条目对应一个字段的值。这里只能修改第一页的字段值,而且只能修改你自己添加的字段值。要使用 "" 或 null 来清除某个字段,请发送相应的指令;不可编辑的字段是无法被清空的。不保持不变
curl -X PUT https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/case \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"case_stage": "stage::20260927120000_8c1f0e2d3b4a59", "meta_data": [{"policy_number": "PN-5521"}]}'

该响应会使用案例的ID来回应200。如果你发送的字段不属于允许更改的字段列表,那么该字段的值就会与案例中的值不同,此时整个调用会被拒绝,返回403状态码,且不会发生任何变化;reason字段用于标识这些字段,其中meta_data.<field key>表示自定义的字段名称。如果发送的字段值与案例已有的值相同,那么这种修改并不算作真正的更改,因此既不会被拒绝,也不会被记录下来。对于不发生任何变化的调用,响应会包含204。

  • 将处于开放状态的案件移动到某个阶段后,该阶段的相关里程碑信息会被添加进去。如果你所在的中心有虚拟助手功能的话,还可以查看当案件达到某个阶段时自动添加相关帖子的设置。除此之外,再也不会有其他关于该案件的帖子被发布或发送出去了:无论是关闭案件还是修改其详细信息,都不会通知任何人。
  • 一旦案件被关闭,通过中心密钥进行的任何修改都将被拒绝,包括重新打开案件在内。可以在管理面板中重新打开案件,或者使用管理密钥来恢复其运行。详见关闭或重新打开案件部分说明。
  • 标签ID和案例类型无法在此处进行更改;只有管理员才能修改这些设置。

团队

GET /team能够一次性列出所有与这个案件相关的人员信息,包括虚拟助手以及那些被排除在外的成员。一个案件最多只能包含20个人,虚拟助手是这样统计的。

{
  "data": {
    "items": [
      {
        "case_id": "cc-1a2b3c4d5e6f70",
        "user_id": "cu-4f1c2a9e8b7d60",
        "case_role_id": "role::clients",
        "case_designation": "primary",
        "case_notify": 1,
        "host_user_status": 1,
        "given_name": "Jane",
        "family_name": "Sample",
        "locale": "en",
        "zoneinfo": "America/New_York"
      }
    ],
    "currentItemCount": 1,
    "selfLink": "https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/team"
  }
}
  • case_role_id 这就是该人在此案件中的角色,以及…… case_designation 它们/它们 命名/称呼指定 指某人在案件中担任的职务,例如首席律师、律师助理或监护人。, 比如 primary.
  • 对于在您的中心中被认定为残疾的人士来说,host_user_status相当于0。
  • 每个人的姓名、所使用的语言……locale) 以及时区信息)zoneinfo) 默认情况下会返回原处。电子邮件地址和电话号码则不会如此。
  • 中心键无法添加或移除人员:这些电话会被设置为403状态无法接通。 HostAddCaseUserNotEnabledException 以及 HostRemoveCaseUserNotEnabledException. 使用管理键;详情请参见 使用管理键添加或移除案例成员.

模板值

GET /placeholders 答案在下方。 placeholders, 在这种情况下,你的模板中每个代码所填充的值,例如: clients.primary.full_name, clients.primary.email, case_ref_id 以及 company.phone. 该代码用于标识那些在该案件中没有任何权限的人。如果“团队”选项在案件页面上被关闭或隐藏,那么所有团队相关的代码都将无法使用;不过其余的代码仍然可以正常使用。请参见说明。 用案例详细信息填充表单字段.

如果电话被拒绝

地位message为什么
400SchemaFieldsException该字段无效,可能是空字符串或无法识别的内容。 title, 提交了一个必需的自定义字段,但该字段为空;或者你的中心没有该阶段的相关信息。 errors 将其命名为
403CaseFieldNotWritableException您提交的字段并非关键字段,其属性可能会发生变化;reason公司对此表示关注。
403CaseClosedException此案已经结案。
403HostModuleDisabledException该案件的详细信息或相关团队信息都隐藏在该案件中,或者已为您的主机关闭,无法查看。
403CaseModulePermissionDeniedException这些机器人可能无法了解案件的详细情况或团队成员的信息。
404CaseNotFoundException该案例并不存在,或者属于另一个中心节点,或者正在被删除中。

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

相关文章

了解 API 的功能了解管理密钥和中心密钥各自的权限范围,为什么每个密钥都充当虚拟助手,以及完整的技术清单在哪里。集成查找带有中心密钥的案例列出您中心的所有案件(无论已打开还是已关闭),按标签 ID 或标题搜索案件,并从您自己的软件中查找案件 ID。集成改变角色可以做什么编辑角色的权限、可以读取或更改的案例字段以及上传限制,包括内置角色。安全与账户 · 5 min处理 API 错误和状态码阅读错误正文,了解 400、401、403、404、500 和 503 的含义,以及为什么您的密钥无法查看的项目会返回 404。集成