帮助中心集成

为了: 管理员

使用中心密钥添加帖子和评论

作为虚拟助手,您可以使用自己的软件向案件动态添加帖子、回复评论、阅读、编辑或删除帖子。

在本文中11 个部分

开始之前

此页面介绍了如何使用中心密钥来添加和阅读某个案例的帖子和评论。相关路径位于https://prd-api-app.caseactive.com/v1/<hub id>/<case id>之下。

电话

称呼它的作用
GET /posts列出该案例的相关帖子,最新内容在最上方。
POST /posts添加一篇帖子
GET /posts/<post_id>阅读了一篇帖子
PUT /posts/<post_id>修改了帖子,并添加了关键词。
DELETE /posts/<post_id>删除所有的帖子以及相关的评论。
GET /posts/templates列出了适用于此情况的订阅模板列表。
GET /posts/<post_id>/comments列出帖子的评论内容,最新的评论排在最前面。
POST /posts/<post_id>/comments关于某篇帖子的评论
GET /posts/<post_id>/comments/<comment_id>阅读了一条评论
PUT /posts/<post_id>/comments/<comment_id>修改了键所写的注释。
DELETE /posts/<post_id>/comments/<comment_id>删除所有评论。

所有由密钥用户发布的帖子都会出现在案例的信息流饲料 案件相关帖子的时间线,公司会在这里分享新闻,案件中的每个人都可以发表评论。中,作为你中心平台的虚拟助手虚拟助手 一个自动化的团队成员,负责发布欢迎信息、签到信息和公司动态;其发布的帖子带有虚拟助理徽章。来展示。这些帖子会以你的公司名称呈现,并带有虚拟助手的徽章。如需上传文件,请参考如何使用密钥上传文件的说明。那些由人工智能生成的技术页面则供平台内的用户使用:拥有密钥的用户可以访问这些页面,否则将会出现403 BotNotAllowedException错误。

添加帖子

场地它的作用必需的默认
message帖子的文本长度最多可达20,000个字符。文本中的换行符被保留了下来。是的—
permissions那些可以访问该内容的角色角色 一组权限,用于决定某人(例如员工或客户)可以查看和处理案件的哪些内容。,比如["role::staff"]。对于案件中的所有成员来说,可以将该内容排除在外。不每个人
template一个用于导入文件的模板:{"owner": "host", "template_id": "<asset_id>"}不没有
curl -X POST https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/posts \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"message": "Hi <@cu-4f1c2a9e8b7d60>, the insurer has acknowledged your claim. We expect their estimate within two weeks."}'

该回答使用了帖子ID来指代201:

{"data": {"case_id": "cc-1a2b3c4d5e6f70", "post_id": "post::20261002154134_b0accfaac139a9", "selfLink": "https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/posts"}}
  • 文本。 请发送纯文本信息。门户网站将会显示结果。 **bold**, [a link](https://example.com) 并且以格式化后的方式显示裸网地址;电子邮件则显示原始的文字内容。
  • 提及/提到 写作 <@user_id> 为了提及与本案相关的某个人,需要使用那些身份识别信息。 GET /team, 或者某种标识码,比如 <@clients.primary>, 这些位置会被匹配到相应的人身上。门户网站会显示每个人的信息。 @ 还有他们的名字。如果提到的是与本案无关的人,或者使用的代码无人知晓,那么相关的信息就会被忽略。一旦被丢弃,就会收到一条无内容的消息,同时还会被拒绝接收400条消息。 FieldRequiredException 在……时候 message, 而没有任何东西被保存下来。
  • 只有看到它的人才能看到它。 通过使用permissions功能,只有处于相应角色的用户才能看到它,此外,任何负责管理帖子的用户也能看到它。而作为员工,默认情况下可以查看所有帖子。

谁被告知

一旦该帖子被添加进来:

  • 如果没有特别说明的话,那么所有涉及此案的人都可以看到相关信息。如果有所提及,那么只有那些被点名的人才会收到通知。
  • 每个人都会通过电子邮件收到通知,如果他们没有设置好电子邮件地址,则会通过短信进行通知。而那些已禁用邮件通知功能的成员,以及关闭了通知功能的人,则不会收到任何通知。
  • 回复电子邮件时,会将回复内容作为评论显示出来,即由发件人看到的回复内容。
  • 您的Web钩子已收到add_post。

之后附上的文件也会计入邮件中的附件数量。

使用模板发帖

GET /posts/templates 列出了您已发布的订阅源 模板模板 可重复使用的动态帖子、表单、电子签名、笔记或任务保存在库中,并复制到案例中。,这些模板按照更新时间排序,最新的在最上方。每个模板的 asset_id、title 和 message 属性也已明确标注。在 message 中给出的标识代码则对应着本案中的具体人员。

要发布一篇内容,请发送相应的文章吧。 message, 无论是原样还是经过修改后,都是如此。 template 凭借其 asset_id 为了加载模板中的文件。不过,模板本身并不会自动加载相应的角色:需要手动进行配置。 permissions 你自己。

阅读帖子

GET /posts接受limit作为参数(默认值为20,最大可达1000),同时还接受start_key。而每篇帖子都包含nextLink和startKey这些参数,就像大多数列表一样。每篇帖子包含以下内容:

场地它包含什么
post_id, case_id它们的标识符
user_id是谁发布了这个内容?该虚拟助手的身份标识是cu-,而您所在系统的14位身份标识则如下:
message其文本中包含这样的引用形式:<@user_id>
permissions在有限的情况下,这些角色可能会发挥什么作用
media, media_ct这些文件的性质,以及数量是多少
comments_ct, commenters, last_reply相关评论如下:有多少人发表了这些评论?最后一次评论是什么时候?
system对于已添加的自动化或导入操作,可以使用true来表示其状态。
language这种语言被用来记录某些内容。
created_on, updated_on该内容发布并最后一次被修改的时间是UTC时间。

一名关键人员会阅读所有与这一案件相关的帖子,包括那些篇幅较短的报道。

编辑和删除

  • PUT /posts/<post_id>接受message和permissions作为参数,仅修改你发送到的内容。一个“关键节点”只能包含虚拟助手自己创建的帖子,以及你的自动化程序添加的欢迎帖、签到帖和里程碑帖子。没有人会知道具体发生了什么;当文本发生变化时,你的Web钩子会收到modify_post。
  • 若要更改谁可以查看某篇帖子,请发送包含所有角色的列表。如果列表为空,则请求将被拒绝。若希望让所有人再次看到该帖子,请发送包含您之后添加的角色的列表,格式为"permissions": null;如果不需要包括后来添加的角色,则可以只发送所有角色的列表。
  • DELETE /posts/<post_id>会删除该案件中的所有帖子,包括相关的评论和文件。没有人会被通知这一情况;你的Web钩子将会收到delete_post的信号。

评论

POST /posts/<post_id>/comments 接受 message, 遵循与帖子相同的规则,答案也亦然。 201 随着 comment_id. 所有看到该帖子的人都会被通知,关于这个帖子的信息,只会展示给那些被该帖子提及的人看。 GET 这些列表按照最新顺序排列,依次为…… comment_id, user_id, message, media 以及它们的时代。

一个键只能修改自己的注释,可以通过使用PUT来替换原有的注释,并添加新的message注释。同时,该键也可以删除任何注释。

网络钩子

您的Web钩子能够捕捉到帖子与评论发生的所有变化。密钥中包含以下标识:add_post、modify_post、delete_post、add_post_media和delete_post_media,而评论的标识同样为这五个。每个事件的who.user_id标识代表帖文或评论的作者,因此密钥中包含了虚拟助手的ID;请确认这一点,否则您的系统会将新的帖子视为原有的帖子进行处理。更多详细信息请参阅Web钩子事件与负载部分。

语言

该用户的帖子和评论中没有任何语言内容,因此这些内容会以原始形式显示,无需翻译。不过,使用特定模板制作的帖子会有不同的情况:这类帖子的标签会标明所使用的语言,并且会为使用其他语言的读者进行翻译。详见了解帖子和评论是如何被翻译的部分。

如果电话被拒绝

地位message为什么
400SchemaFieldsException某个字段缺失或无效,例如 message 为空,permissions 的列表为空,或者您的中心没有该角色;errors 则用于标识这样的字段。如果更改后没有任何字段被指定,那么该操作也会被拒绝。
400SchemaFieldsException,其中ItemCopyNotAllowedException位于template处该模板尚未发布,也无法被机器人角色访问,或者其文件目前仍在处理中。
403ItemAuthorOnlyException那个关键人物试图修改其他人所写的帖子或评论。
403CaseClosedException此案已经结案。
403BotNotAllowedException这个关键点被称为“AI草图调用”之一。
404ItemNotFoundException该帖子或评论不存在,或者属于另一个案件。

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

相关文章

了解 API 的功能了解管理密钥和中心密钥各自的权限范围,为什么每个密钥都充当虚拟助手,以及完整的技术清单在哪里。集成使用集线器密钥上传和附加文件获取上传地址,上传文件,将其附加到帖子、笔记、任务、表单或电子签名中,并下载案件文件。集成查找 webhook 事件和有效载荷十个信息流事件分别发送什么内容,消息是如何加密的,以及如何使用你的密钥解密。集成处理 API 错误和状态码阅读错误正文,了解 400、401、403、404、500 和 503 的含义,以及为什么您的密钥无法查看的项目会返回 404。集成