为了: 管理员
使用管理密钥创建和更新案例
使用您自己的软件列出、创建、读取、更新和删除您中心的案例,包括其阶段和自定义字段。
在本文中10 个部分
开始之前
此页面介绍了关于“管理键”的使用情况。相关路径位于https://prd-api-manage.caseactive.com/v1/<hub id>之下。
电话
| 称呼 | 它的作用 |
|---|---|
GET /cases | 列出您所在中心的所有案例,最新案例排在最前面。 |
POST /cases | 创建了一个案例 |
GET /cases/<case_id> | 阅读了一个案例 |
PUT /cases/<case_id> | 更改案例设置 |
DELETE /cases/<case_id> | 永久删除某个案例。 |
GET /stages | 列出您所在枢纽的各个阶段,以便查找它们的标识号。 |
GET /schemas?schema_type=cases | 读取了您所在网络中的案例自定义字段数据 |
案例列表
| 范围 | 它的作用 | 必需的 | 默认 |
|---|---|---|---|
type | 1 仅适用于未解决的案件。 0 已关闭。尽管名字如此,但实际上它是根据状态来过滤内容的,而不是案件类型。 | 不 | 两者都如此 |
limit | 每页可以容纳多少个案例?最多可达1000个。 | 不 | 20 |
start_key | 上一页中的startKey | 不 | 首页 |
curl "https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases?type=1" \
-H "Authorization: Bearer YOUR_API_KEY"
{
"data": {
"items": [
{
"case_id": "cc-1a2b3c4d5e6f70",
"host_id": "ca-7e6d5c4b3a2f10",
"ref_id": "rear-end-2026",
"title": "Jane Sample auto accident",
"case_type": "general",
"case_status": 1,
"case_stage": "stage::20260927120000_8c1f0e2d3b4a59",
"users": {
"cu-7e6d5c4b3a2f10": "role::bots",
"cu-4f1c2a9e8b7d60": "role::clients",
"cu-9d8c7b6a5f4e30": "role::staff"
},
"created_on": "2026-10-02T14:05:09+00:00"
}
],
"currentItemCount": 1,
"selfLink": "https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases?type=1"
}
}
users将案例中的每个人分配到一个相应的 角色角色 一组权限,用于决定某人(例如员工或客户)可以查看和处理案件的哪些内容。 上。其中包括了你的中心节点的 虚拟助手虚拟助手 一个自动化的团队成员,负责发布欢迎信息、签到信息和公司动态;其发布的帖子带有虚拟助理徽章。,表示为role::bots。- 虽然仍有更多页面需要处理,但该页面还保存着
nextLink,即下一页的完整地址,以及startKey。可以调用nextLink,或者将startKey作为start_key发送出去,直到找到没有这些参数的页面为止。 - 被删除的案例不会被计入统计范围内。若需根据标签ID标签 ID 您给案例赋予的永久标签,例如 rear-end-2026,也显示为参考 ID,并在导入时使用。来查找某个案例,请参考使用管理键搜索案例和用户的相关说明。
案例字段
POST /cases和PUT /cases/<case_id>将这些字段视为JSON数据。未列出的字段将被忽略。
| 场地 | 它的作用 | 必需的 | 默认 |
|---|---|---|---|
ref_id | 该案例的标签ID由字母、数字、连字符和斜杠组成,全部采用小写形式。你的中心数据库中不能存在两个具有相同标签ID的案例。该标签是在创建案例时设置的,之后无法更改。 | 是的,在创建时就可以实现。 | — |
title | 这个案件的名称,已经向所有人公示了。 | 是的,在创建时就可以实现。 | — |
description | 对于工作人员来说,这是一种描述。客户是看不到这些信息的。在发生变化时,""会清除它。 | 不 | 没有 |
case_type | 在general中,或者是你所在中心所定义的案例类型案件类型 用于处理特定案例的类别,例如“一般案例”,以便将自动化流程应用于正确的案例。之一。这些名称应以设置 › 田野的形式来书写。在做出更改之后,如果你将某个案例类型从设置中移除,那么该类型的标识仍然会被保留下来。 | 不 | general |
case_status | 对于打开的状态,使用1;对于关闭的状态,使用0。 | 不 | 1 |
case_stage | 这是它的舞台阶段 案件进展过程中的一个步骤,例如受理或发出索赔请求,公司会对其进行命名和描述,并在案件页面上显示该步骤。的标识,来自GET /stages。当发生变化时,""会将该案例从舞台上移除。 | 不 | 没有阶段/无需经历任何步骤 |
date_opened | 该案件的立案日期,例如 2026-03-15 | 不 | 今天,UTC时间 |
hidden_modules | 在此案例中需要隐藏的部分有:case、convos、events、forms、signs、invoices、notes、tasks和team。要再次显示这些部分,请发送[]。 | 不 | 没有任何隐藏的内容 |
meta_data | 这是自定义字段;详见下文。 | 不 | 没有 |
在创建任务时无法添加人员;只有虚拟助手可以被分配到新的任务中。请使用POST /cases/permissions来添加相关人员;更多详情请参阅如何使用管理键添加和删除任务成员。
创建案例
curl -X POST https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"ref_id": "rear-end-2026", "title": "Jane Sample auto accident", "case_type": "general", "date_opened": "2026-10-02"}'
它用新案例的ID来回应201。
{"data": {"case_id": "cc-1a2b3c4d5e6f70", "selfLink": "https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases"}}
没有人会收到电子邮件通知。对于每一个案件,你都可以为该案件指定负责人,并将这个人分配负责该案件的各项工作。因此,如果你之后又添加了一个人来负责这个案件,系统会认为这是重复分配任务的行为,从而拒绝接受新的人员配置。如果在某个阶段创建了某个案件,那么之后就不会有相关的工作进展报告了。
阅读案例
GET /cases/<case_id> 受理了该案件 case_id, host_id, ref_id, title, description, case_type, case_status, case_stage, date_opened, hidden_modules, meta_data, users_ct (参与这个项目的人有多少,其中包括了虚拟助手。) created_on 以及 updated_on. 想要知道谁参与了这件事,请使用相关功能。 GET /cases/permissions?case_id=<case_id>.
更改案件
PUT /cases/<case_id>可以处理任何情况字段,但只有ref_id能够执行特定的操作。它只会处理你发送过来的那些字段。至于204,则不会被处理,也就不会有任何响应。
- 将处于活动状态的案件移动到一个阶段后,该阶段的相关里程碑信息也会被添加进去。如果您的中心平台配备了虚拟助手功能,可以参考当案件达到某个阶段时自动发布相关帖子的设置。至于关闭案件或更改其类型这类操作,并不会向任何人发送任何信息。
meta_data可以替换案例中的每一个自定义字段。- 即使是一个已经结束的案件,仍然可以被重新处理。因此,可以通过
"case_status": 1来重新开启该案件。
阶段和自定义字段
GET /stages 列出了你的中心所包含的各个阶段,这些阶段是由管理员在 设置 › 阶段 下依次创建的。每个阶段的 stage_id、name、description 和 order 信息也会一并显示。虽然关键角色可以查看这些阶段的信息,但无法对其进行修改。
GET /schemas?schema_type=cases将您中心站点的自定义字段数据,这些字段位于设置 › 田野之下,以页面列表的形式呈现。每个页面都包含相应的字段键、标签以及字段类型信息。通过meta_data发送的数据格式为:每页一个对象,且各对象的字段顺序与列表中保持一致,所有对象都包含按字段键排序的值数据。
{"meta_data": [{"policy_number": "PN-5521", "insurer": "Northwind Mutual"}]}
某个值必须与其所在字段的类型相匹配,否则调用将被拒绝。需要仅会在管理面板和大厅中通过表单形式进行验证,因此在这里创建或更新表单时,如果某个必填字段为空,系统也会检测到这一问题。
删除案件
DELETE /cases/<case_id>会立即删除 204。被删除的内容将从你的列表中移除,并且将永远消失,包括相关的帖子、文件、表格、电子签名、发票、事件、任务以及笔记等。这一操作无法撤销,也不会通知任何人。一旦删除完成,该内容的标签ID将会再次变得无用。
如果电话被拒绝
| 地位 | message | 为什么 |
|---|---|---|
| 400 | SchemaFieldsException | 某个字段缺失或无效;该字段被标记为errors。该字段上存在未知的案例类型或阶段,标记为FieldValidatorFailedException。 |
| 400 | CaseReferenceIdExistsException | 已经有一个案例拥有该标签ID了,甚至还有一个案例正在被删除中。reason负责管理这个案例的case_id。 |
| 404 | ItemNotFoundException | 该案例并不存在,或者属于另一个中心节点,或者正在被删除中。 |
| 403 | ManageBillingInactiveException | 您的中心节点的管理面板在支付失败后被锁定了。 |
关于错误 bodies 以及其他代码格式,请参考 处理 API 错误和状态代码 的相关说明。