帮助中心集成

为了: 管理员

使用中心密钥发送表单并查看答案

根据模板创建案件表格,发布给需要填写表格的人员,并阅读他们的回答。

在本文中7 个部分

开始之前

此页面介绍了如何使用hub键发送表单以及读取表单的回复内容。相关路径位于https://prd-api-app.caseactive.com/v1/<hub id>/<case id>之下。

电话

称呼它的作用
GET /forms/templates列出您的表单模板
POST /forms在案例中创建了一个尚未发布的表单。
PUT /forms/<form_id>/publish将其发布出去,然后发送给接收者们。
GET /forms?filter=all列出了案件的各种形式/类别
GET /forms/<form_id>读取了一个表单
PUT /forms/<form_id>更改名称、截止日期、提醒事项或接收者信息
DELETE /forms/<form_id>删除它,包括所有的答案。
GET /forms/<form_id>/responses列出所有的答案
GET /forms/<form_id>/responses/<response_id>阅读了一条回答
DELETE /forms/<form_id>/responses/<response_id>删除某人的回答,这样他们就可以重新填写该答案了。

一个表单的创建过程分为两个步骤:首先创建表单,然后将其发布。在表单被发布之前,接收者是无法看到它的,也不会有人知道这个表单的存在。

创建表单

GET /forms/templates 列出了您已发布的表单 模板模板 可重复使用的动态帖子、表单、电子签名、笔记或任务保存在库中,并复制到案例中。,这些模板按照更新顺序排序,最新的在最前面。每个模板还包含了 asset_id、title、description、due_mins(发送后经过的分钟数)、rrule(重复频率)、notifications 以及 instant_notify 等信息。

POST /forms 的接受值包括:

场地它的作用必需的默认
name该表单的标题。只能使用字母、数字、空格以及& ' - _ ( ) . /作为字符,不得包含逗号或冒号。是的—
duration{"due_date": "2026-10-09T17:00:00-04:00", "rrule": "FREQ=MONTHLY"}。截止日期需要加上时区偏移量。rrule,即重复规则,是可选的。zoneinfo,即重复事件发生的时区,例如America/New_York所指示的时区,也是可选的:如果没有指定时区,那么重复事件将发生在主节点的所在时区,在时钟变化的那一天发生。是的—
participants_ids填写这些信息的人:指的是该案件中的相关人员身份识别码,来自GET /team不,但需要将其发布出来。没有人
template{"owner": "host", "template_id": "<asset_id>"} 使用模板中的文档内容不没有
description与表格一起显示的注释不该模板的…
notifications提醒:{"names": ["days", "hours"], "values": [-1440, -60]},每个数值表示截止日期前还有多少分钟时间剩余不使用该模板,或者不使用任何模板。
instant_notifyfalse在发布时不会发送任何请求,只会发出提醒信息。不该模板的内容,或者可以说就是true

模板会携带文档内容、描述信息、提醒事项等要素。 instant_notify, 但不是现在就该行动的时候,也无需重复:行动起来吧。 due_date 从 due_mins, 并发送它…… rrule 如果它有一个的话。

curl -X POST https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/forms \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Case intake form", "duration": {"due_date": "2026-10-09T17:00:00-04:00"}, "participants_ids": ["cu-4f1c2a9e8b7d60"], "template": {"owner": "host", "template_id": "form::20260915101500_3c2b1a0f9e8d70"}}'

这回答了问题。 201 随着 form_id. 模板中的文档正在后台被复制:请继续阅读表单内容,直到无法再阅读为止。 copying, 然后将其发布出去。

如果您希望自己上传文档,可以创建一个不包含template的表单,然后将其作为文档上传PDF格式的文件。等待文件上传完成后即可使用。详情请参阅使用中心密钥上传和附加文件的相关说明。

出版

PUT /forms/<form_id>/publish没有具体对象,其响应结果为200。

  • 每个接收者都会立即收到一封电子邮件,要求他们填写相关信息;如果接收者没有确认接收电子邮件的权限,则会通过短信进行通知。除非…… instant_notify 是 false. 它出现在他们的身上/周围 待办事项去做 箱子上列着你需要处理的事项清单,例如需要填写的表格、需要签署的文件或需要确认的事项。 以及出现在他们的门户通知中。
  • 提醒信息会在每次时间notifications时发送。如果某个时间点没有收到通知,那么只有在之后才会接受相关回复。
  • 每个重复表单都会按时进入下一个到期日期,其答案也会立即被确认。不过,如果满足instant_notify等于false的条件,那么所有相关人员的信息将会再次被询问。
  • 从案例中移除的人员将从名单上删除。

该文档在发布后无法进行修改。其名称、截止日期、提醒信息、接收者以及描述等属性都不会发生变化。PUT /forms/<form_id>用于重复发送邮件,而zoneinfo则不会产生影响,同时仍会保留原有的时区设置。如果修改了截止日期、重复发送或提醒次数,那么请求会立即再次发送给所有尚未回复的人;而通过instant_notify和false的组合使用,则直到提醒功能生效之后才会执行任何操作。

阅读答案

GET /forms/<form_id>/responses 会列出每个人的答案,按照时间顺序排序,所有信息都展示在同一个页面上。而重复出现的表单则只显示当天的答案;对于更早时间的答案,仍然可以通过其 response_id 来查看。

{
  "data": {
    "items": [
      {
        "response_id": "response::20261003153012_9f8e7d6c5b4a30",
        "parent_id": "form::20261002150000_1a2b3c4d5e6f70",
        "user_id": "cu-4f1c2a9e8b7d60",
        "created_on": "2026-10-03T15:30:12+00:00",
        "response": {
          "format": "https://pspdfkit.com/instant-json/v1",
          "formFieldValues": [
            {"v": 1, "type": "pspdfkit/form-field-value", "name": "client_name", "value": "Jane Sample"},
            {"v": 1, "type": "pspdfkit/form-field-value", "name": "accident_date", "value": "2026-09-14"}
          ]
        }
      }
    ],
    "currentItemCount": 1,
    "selfLink": "https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/forms/form::20261002150000_1a2b3c4d5e6f70/responses"
  }
}
  • formFieldValues 将每个字段的内容都保存在该字段所代表的对象中。 name. 签名或手印属于……类别 annotations 以及 attachments.
  • 该表单的显示方式可以显示出是谁进行了回答:responses会将每个人的用户ID与他们的response_id关联起来。
  • 当有人提交文件后,负责处理此案的工作人员就会收到通知,就像他们自己亲自提交文件一样。

删除某人的回答,使用{"user_id": "<their ID>"}作为表单的标识,之后该表单会重新出现在该用户的待办事项中。没有人会被通知这一操作。钥匙本身是无法填写表单的。

列表表格

GET /forms需要filter:

filter它列出了什么
all该案例中的所有形式,包括尚未发表的内容在内,都已经被整理好了。最新的内容排在最前面。
self虚拟助手所发送的表单:可以通过任何键盘输入,也可以通过自动化程序来操作。
completed, uncompleted这是 caller 被要求填写的表格。对于钥匙来说,这些表格通常都是空的。

每种形式都包含其form_id、name、participants_ids、due_date、published(一旦发布后还会包含1)、responses、responses_ct,以及位于media下的相关文档。

DELETE /forms/<form_id>可以在任何时间删除某个表单及其答案,并将其从所有人的待办事项列表中移除。没有人会知道这件事。

如果电话被拒绝

地位message为什么
400SchemaFieldsException某个字段缺失或无效,例如name中的逗号格式不正确,或者到期日期没有偏移量,又或者该人并不属于该案例的成员;errors中已记录了该字段的名称。
400SchemaFieldsException,其中ItemCopyNotAllowedException位于template处该模板尚未发布,也无法被机器人角色访问,或者其文件目前仍在处理中。
403PublishAlreadyPublishedException已经发布出来了。
403PublishAlreadyAnsweredException已经有人回答过这个问题了。
403PublishMediaMissingException目前还没有相关的文档记录。
403PublishMediaNotReadyException该文档目前仍正在被复制或转换中。
403PublishMediaFailedException该文档未能成功转换格式。
403PublishDueTimePassedException到期日已经过去
403PublishRecipientsMissingException它没有可以寄送的对象或目的地。
403BotNotAllowedException一名警察试图填写相关信息。
403CaseClosedException此案已经结案。
404ItemNotFoundException该表单或答案并不存在。

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

相关文章

了解 API 的功能了解管理密钥和中心密钥各自的权限范围,为什么每个密钥都充当虚拟助手,以及完整的技术清单在哪里。集成使用中心密钥发送电子签名和读取签名从模板创建案例的电子签名,选择每个字段的签名人,发布以供签名,并在所有人签名后下载锁定副本。集成使用集线器密钥上传和附加文件获取上传地址,上传文件,将其附加到帖子、笔记、任务、表单或电子签名中,并下载案件文件。集成处理 API 错误和状态码阅读错误正文,了解 400、401、403、404、500 和 503 的含义,以及为什么您的密钥无法查看的项目会返回 404。集成