のために: 管理者
ハブキー付きのケースを探す
ハブ内のケース(オープンまたはクローズ済み)を一覧表示し、タグIDまたはタイトルで検索し、独自のソフトウェアからケースのIDを検索できます。
この記事では7 セクション
始める前に
このページでは、ハブキーがケースを見つけるために使用する呼び出しについて説明しています。各経路はhttps://prd-api-app.caseactive.com/v1/<hub id>の下に記載されています。
電話
| 電話 | その機能 |
|---|---|
GET /cases | 自分の拠点で開いている、または閉じている案件の一覧です。 |
GET /cases/search | タグIDまたはタイトルで検索を行います。 |
GET /whoami | ユーザーの設定を読み取ります。例えば、カスタマイズされたタイプやフィールドページなどの情報です。 |
GET /roles | 自分のハブが担っている役割を一覧表示します。 |
GET /stages | 自分のハブが経由する各段階をリストアップしてください。 |
GET /schemas | ユーザーのカスタムフィールドや、ハブの情報を読み取ります。 |
Hubキーは、あなたのHubとして機能します。 バーチャルアシスタントバーチャルアシスタント 会社への歓迎メッセージ、チェックイン、ステージングに関する投稿を行う自動化されたチームメンバー。その投稿にはバーチャルアシスタントのバッジが付いています。, つまり、どのケースにおいても、これらの呼び出しは、あなたのハブ内のすべてのケースに到達します。ここには、2つのサンプルケースが含まれています。
Hubキーでは、ケースを作成することはできません。 POST /cases 回答数:403 HostCreateCaseNotEnabledException. ソフトウェアからケースを作成するには、管理キーを使用してください。詳細はこちらをご覧ください。 キーワードを管理することで、ケースを作成し、更新することができます。.
事例一覧
| パラメータ | その機能 | 必須 | デフォルト |
|---|---|---|---|
status | 1は、未解決の案件の場合を表し、0は解決済みの案件の場合を表します。 | いいえ。 | 1 |
limit | 1ページに収まるケースの数は、最大で1000件です。 | いいえ。 | 20 |
start_key | 前のページにあるstartKey | いいえ。 | 最初のページ |
curl "https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases?status=1" \
-H "Authorization: Bearer YOUR_API_KEY"
{
"data": {
"items": [
{
"case_id": "cc-1a2b3c4d5e6f70",
"case_ref_id": "ca-7e6d5c4b3a2f10::rear-end-2026",
"title": "Jane Sample auto accident",
"team": {
"cu-7e6d5c4b3a2f10": "role::bots",
"cu-4f1c2a9e8b7d60": "role::clients",
"cu-9d8c7b6a5f4e30": "role::staff"
}
}
],
"currentItemCount": 1,
"selfLink": "https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases?status=1"
}
}
- ケースは、「タグIDタグID ケースに付ける永続的なラベル。例えば、rear-end-2026 など。参照 ID としても表示され、インポート時に使用されます。」の順番で整理されており、日付順ではなく、ZからAへと並んでいます。
case_ref_idは、あなたのハブのIDです。2つのコロンと、ケースのタグIDが含まれています。teamは、ケースに登場する各人物に対して、役割役割 スタッフやクライアントなど、特定の人物が案件に関して何を見たり、何を実行したりできるかを決定する一連の権限。を割り当てます。名前については、ケースのチームの情報を参照してください。詳細は Hubキーを使ってケースの詳細を読み取り、更新するをご覧ください。- まだ多くのケースが存在しているが、そのページには、次のページの完全なアドレスである
nextLinkやstartKeyも含まれている。nextLinkを呼び出すか、startKeyをstart_keyとして送信し続ける。そうして、何らかのページがそれらを持たない状態で戻ってくるまで続ける。 - 削除されたケースは除外されるため、あるページには
limit件未満のケースが存在しても、実際にはまだ多くのケースが残っていることになります。数ではなく、nextLinkを基準にしてください。 - ここでのケースのタイトルやステータスは、数秒間変動することがあります。
ケースの検索
GET /cases/searchは、ケースのタグID内のどこかに、またはタイトルの最初の部分で、単語と一致します。また、小さな誤字も許容されます。ただし、説明内容については検索しません。
| パラメータ | その機能 | 必須 | デフォルト |
|---|---|---|---|
query | 探すべき言葉です。各ケースについて、*を送信してください。 | はい。 | — |
status | 1は、未解決の案件の場合を表し、0は解決済みの案件の場合を表します。 | いいえ。 | 1 |
limit | 1ページに表示される結果の数は、最大で250件です。 | いいえ。 | 20 |
page | どのページからの結果なのか、1番目のページからです。 | いいえ。 | 1 |
sort_by | 数値フィールドや方向を示すものです。例えば、created_on:descのようなものです。これには、created_on、date_opened、last_activity、updated_on、users_ct、case_statusといった値が含まれます。 | いいえ。 | 最も適したものを先に選ぶ |
curl "https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases/search?query=rear-end-2026" \
-H "Authorization: Bearer YOUR_API_KEY"
{
"data": {
"found": 1,
"page": 1,
"hits": [
{
"document": {
"case_id": "cc-1a2b3c4d5e6f70",
"ref_id": "rear-end-2026",
"title": "Jane Sample auto accident",
"case_status": 1,
"case_type": "general",
"case_stage": "stage::20260927120000_8c1f0e2d3b4a59",
"date_opened": 1772668800,
"created_on": 1791043509,
"last_activity": 1791050112,
"users_ct": 3
}
}
],
"selfLink": "https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases/search?query=rear-end-2026"
}
}
- 各ヒットの
documentには、そのケースのID、単純なタグID、タイトル、ステータス、ケースの種類ケースの種類 自動化処理を適切なケースに向けるために使用される、一般的なケースなどのカテゴリ。、ステージステージ 案件が進む段階の一つで、例えば「受付」や「請求書送付」などがあり、企業が名称と説明を付け、案件ページに表示されます。、関与する人数、そしてUTC時刻で表された日付が記録されています。 foundは、どれだけのケースが一致するかを示しています。それらのケースをpageで一覧表示してください。nextLinkはありません。- 変更があった瞬間に、そのケースを検索することができます。
タグIDによるケースの検索
タグIDによる正確な検索はできません。まず、そのタグIDを指定して検索してください。そうすると、document.ref_idがそのタグIDと完全に一致する結果が表示されます。なぜなら、検索ではrear-end-2025などの類似した値も含めて結果が表示されるからです。また、status=1やstatus=0を指定して検索することで、開いているケースや閉じているケースもカバーできます。
ケースのIDを取得したら、そのケースに関するすべての呼び出しでそのIDを使用します。詳細については、「Hubキーを使ってケースの情報を読み取り、更新する方法」を参照してください。
ハブの設定
| 電話 | 答えは |
|---|---|
GET /whoami | キーのユーザーID、ホブの名前、持っているケースタイプ、どのセクションに該当するか、そしてhost_default_schemasという、ケースやユーザーフィールドのページです。 |
GET /roles | すべての役割において、バーチャルアシスタントにはrole::botsが含まれています。また、role_id、name、description、color、reads_notesも含まれています。つまり、その役割がメモを読むことができるということです。 |
GET /stages | すべての段階において、最初から最後まで、stage_id、name、description、orderを使用します。 |
GET /schemas | default_schemas、あなたのハブのケースやユーザー定義のフィールドページについてです。各ページには、それぞれのフィールドのキー、ラベル、タイプが記載されています。 |
どのページも、すべての質問に答えています。
電話が拒否された場合
| 状態 | message | なぜ |
|---|---|---|
| 400 | SchemaFieldsException | パラメータが不足しているか、無効です。例えば、queryが空の場合や、statusが0や1以外の値を取り得る場合などです。また、errorsという名前のパラメータも存在しません。 |
| 400 | InvalidStartKeyException | start_keyは、別のリストから来たものです。 |
| 400 | SearchParameterException | この検索では、テキストフィールド上のsort_byのようなパラメータは受け付けません。また、limitが250を超える場合も受け付けません。reasonは、どの値を指定するかを示します。 |
| 403 | HostCreateCaseNotEnabledException | Hubキーが、あるケースを作成しようとした。 |
エラー内容やその他のコードについては、APIのエラーやステータスコードの処理方法を参照してください。