帮助中心集成

为了: 管理员

使用管理密钥搜索案例和用户

从您自己的软件中查找案例、人员、案例成员、角色,并按文本和筛选条件导入行。

在本文中6 个部分

开始之前

此页面涵盖了以下内容: GET https://prd-api-manage.caseactive.com/v1/<hub id>/search, 该工具可以根据文本在您的个人资料中查找相关记录。它只会在您的个人资料中进行搜索。

参数

范围它的作用必需的默认
table需要搜索的内容包括:cases、host_users、case_users、host_roles、case_invoices、host_imports或import_items。是的—
query需要查找的文本为 *。仅通过过滤条件进行搜索时,该文本可以匹配所有内容。是的—
query_by需要检查的文本字段,这些字段用逗号分隔,例如 given_name,family_name,email是的—
filter_by有一个条件,例如case_status:=1。可以重复此参数以添加更多条件;所有条件都必须满足。不没有
sort_by一个数域以及一个方向,例如 created_on:desc不最佳对决
page是哪一页呢?不1
limit每页可显示的结果数量最多为250个不10
  • 在query中,从开头开始匹配一个单词即可,允许有少量的拼写错误。因此jan可以匹配到“Jane”。在标签ID、姓名、电子邮件地址、电话号码以及参考ID中,同样可以在其内部的任何位置进行匹配,所以end-2026可以匹配到rear-end-2026。
  • 过滤器由字段、操作符和值组成::=表示“精确”,:!=表示“不精确”,而对于数字,则可以使用:>、:<、:>=和:<=来表示不同的数值。条件中不得包含&&、||、括号或逗号;如果需要进行多个值的比较,可以使用多个filter_by参数来替代。值中可以包含/和+,例如ref_id:=2026/rear-end或phone:=+15551234567;在地址中,可以将+视为%2B来处理,或者将其视为空格。
  • 只有数域才具有排序功能。查询结果中的日期以Unix秒为单位表示。
  • 在记录创建或修改后,可能需要几分钟时间才能显示出来。
  • 查询内容无法通过关键词进行搜索。

表格

table文本字段,用于搜索和筛选数字字段,用于筛选和排序
casescase_id, ref_id(标签ID标签 ID 您给案例赋予的永久标签,例如 rear-end-2026,也显示为参考 ID,并在导入时使用。),title, description, case_type, case_stage, users(成员的用户ID)case_status(1打开,0关闭),users_ct,date_opened,created_on,last_activity,updated_on
host_usersuser_id, given_name, family_name, email, phone, host_ref_id, title, company, address1, address2, locality, region, postal_code, country, gender, birthdate_md(如04-12所表示的月份和日期),locale, zoneinfo, host_user_type, host_granted_status, host_default_role, host_staff_designationhost_user_status(1为活动状态,0为禁用状态),host_cases_ct,email_verified,phone_verified,created_on,updated_on
case_userscase_id、user_id、case_ref_id、case_role_id,以及该案例中的title和descriptioncase_status, created_on, updated_on
host_rolesrole_id, name, role_type, permissions, case_read_fields, case_write_fieldsusers_ct, created_on, updated_on
case_invoicesinvoice_id, name, invoice_number, po_number, host_ref_id, description, notes, status (open, paid, void, uncollectible 或 processing), status_reason, payment_gateway, case_id, user_id, participants_ids, refund_status (pending, succeeded, failed 或 canceled), refund_reason, completed_on_daytotal, subtotal, discount, tax, refund_amount, payment_attempts_ct, due_date, completed_on, created_on, updated_on
host_importsimport_id, name, source, type, user_id, statustotal, passed, failed, created_on, updated_on
import_itemsimport_id, unique_id, type, status, error_msg, error_recordcreated_on, updated_on

host_users 包括你的枢纽点在内 虚拟助手虚拟助手 一个自动化的团队成员,负责发布欢迎信息、签到信息和公司动态;其发布的帖子带有虚拟助理徽章。, 谁的 host_user_type 是 bot. case_users 不保留姓名:请找到那个人。 host_users, 然后进行过滤处理 case_users 通过 user_id. case_invoices 仅持有已公布的发票。这些发票的金额以美分为单位表示。 tax 以及 discount 都是分数而已。已退款的发票仍然有效。 status paid; 退款将在规定时间内进行。 refund_status.

示例

通过标签ID处理的案例:

curl -G https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/search \
  -H "Authorization: Bearer YOUR_API_KEY" \
  --data-urlencode "table=cases" \
  --data-urlencode "query=*" \
  --data-urlencode "query_by=ref_id" \
  --data-urlencode "filter_by=ref_id:=rear-end-2026"

那些名字或电子邮件地址以jane开头的活跃用户,按最新顺序排列:

curl -G https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/search \
  -H "Authorization: Bearer YOUR_API_KEY" \
  --data-urlencode "table=host_users" \
  --data-urlencode "query=jane" \
  --data-urlencode "query_by=given_name,family_name,email" \
  --data-urlencode "filter_by=host_user_status:=1" \
  --data-urlencode "sort_by=created_on:desc"

立即开启案件处理 阶段/步骤阶段 案件进展过程中的一个步骤,例如受理或发出索赔请求,公司会对其进行命名和描述,并在案件页面上显示该步骤。, 使用 stage_id 从 GET /stages: table=cases&query=*&query_by=title&filter_by=case_status:=1&filter_by=case_stage:=stage::20260927120000_8c1f0e2d3b4a59.

自2026年10月8日午夜UTC时间以来,所有发票信息已发生更改,更改次数较多的订单会排在前面:table=case_invoices&query=*&query_by=name&filter_by=updated_on:>1791417600&sort_by=updated_on:asc。

结果

{
  "data": {
    "found": 1,
    "page": 1,
    "hits": [
      {
        "document": {
          "case_id": "cc-1a2b3c4d5e6f70",
          "host_id": "ca-7e6d5c4b3a2f10",
          "ref_id": "rear-end-2026",
          "title": "Jane Sample auto accident",
          "case_type": "general",
          "case_status": 1,
          "users": ["cu-4f1c2a9e8b7d60", "cu-9d8c7b6a5f4e30"],
          "users_ct": 2,
          "date_opened": 1790899200,
          "created_on": 1790949909,
          "updated_on": 1790949909
        }
      }
    ]
  }
}

found表示匹配的记录数量。每个匹配记录对应的document值就是该记录的内容;这些匹配记录还包含搜索引擎自带的评分信息,不过这些信息可以忽略不计。没有nextLink字段:继续请求下一个page字段,直到获得found个结果为止。

单词搜索功能也可以匹配相似的值。因此,当您通过ID查找某条记录时,请检查一下返回的结果中是否有符合要求的条目。document

如果电话被拒绝

地位message为什么
400SchemaFieldsException缺少或无法识别table、query或query_by,或者filter_by包含了一些它无法处理的字符(例如FieldSearchFilterTypeException,在filter_by.0位置)。
400SearchParameterException搜索引擎拒绝了该请求:某个字段是未知的,过滤器无法识别该字段;文本字段位于sort_by中,或者limit中的文本长度超过250个字符。而reason则包含了搜索引擎自带的文字内容。
403BotSearchTableNotAllowedException你请求了host_inquiries,而键无法搜索该值。
500InternalError搜索引擎无法使用。请稍后再试。

相关文章

使用管理密钥创建和更新案例使用您自己的软件列出、创建、读取、更新和删除您中心的案例,包括其阶段和自定义字段。集成使用管理密钥添加和更新用户列出您中心的成员,添加客户,查看某人的详细信息和案例,以及禁用或重新启用他们的访问权限。集成