のために: 管理者
管理キーを使用してケースを作成および更新します。
ハブのケースを、ステージやカスタムフィールドを含め、独自のソフトウェアから一覧表示、作成、閲覧、更新、削除できます。
この記事では10 セクション
始める前に
このページでは、管理キーを使って行うことができる操作について説明しています。パスはhttps://prd-api-manage.caseactive.com/v1/<hub id>の下に記載されています。
電話
| 電話 | その機能 |
|---|---|
GET /cases | お使いのハブ内にあるケースの一覧です。最新のものから表示されます。 |
POST /cases | ケースを作成する |
GET /cases/<case_id> | 1つのケースを読む |
PUT /cases/<case_id> | 文字の大文字/小文字を変換する |
DELETE /cases/<case_id> | ケースを完全に削除します。 |
GET /stages | 自分のハブが経由する各ステージのIDを確認します。 |
GET /schemas?schema_type=cases | あなたのハブのケースに関するカスタムフィールドを読み取ります。 |
事例一覧
| パラメータ | その機能 | 必須 | デフォルト |
|---|---|---|---|
type | 1は、未解決の案件のみを対象としています。0は、解決済みの案件を対象としています。名前から想像しやすいように、このフィルターは案件の種類ではなく、状態によって絞り込まれます。 | いいえ。 | どちらも |
limit | 1ページに収まるケースの数は、最大で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は、文字、数字、ハイフン、スラッシュで構成されており、すべて小文字で表されます。ホブ内の2つのケースが同じタグIDを共有することはできません。この設定は作成時にのみ適用され、後から変更することはできません。 | はい、作成します。 | — |
title | その事件の名前は、すべての人に示されています。 | はい、作成します。 | — |
description | スタッフ向けの説明です。クライアントには見えません。変更がある場合、""によってそれが消去されます。 | いいえ。 | なし |
case_type | general、または、ユーザーのハブにあるケースタイプケースの種類 自動化処理を適切なケースに向けるために使用される、一般的なケースなどのカテゴリ。のいずれかです。これらは設定 › フィールズの下で記述されます。変更を行う際には、設定から削除した後でも、そのケースタイプ自体を受け入れることができます。 | いいえ。 | general |
case_status | 1が開いている場合、0が閉じている場合です。 | いいえ。 | 1 |
case_stage | そのステージステージ 案件が進む段階の一つで、例えば「受付」や「請求書送付」などがあり、企業が名称と説明を付け、案件ページに表示されます。のIDは、GET /stagesから取得されます。変更がある場合、""はそのステージからその要素を取り除きます。 | いいえ。 | どの段階でもない |
date_opened | この事件が開始された日付、例えば 2026-03-15 | いいえ。 | 今日は、UTC時間でです。 |
hidden_modules | このケースで非表示にしたいセクションは、case、convos、events、forms、signs、invoices、notes、tasks、teamのいずれかです。[]を送信すると、これらすべてを再び表示できます。 | いいえ。 | 何も隠していません。 |
meta_data | そのカスタムフィールドについては、下を見てください。 | いいえ。 | なし |
「Create」では、人々を追加することはできません。新しい案件に仮想アシスタントのみを追加することができます。次に、その他の人々を追加してください。 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"}'
これは、201に対して、新しいケースのIDを返します。
{"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には何も反映されません。
- 開いているケースを別のステージに移動すると、そのステージに関するマイルストーンが追加されます。もしHubにその機能がある場合は、ケースが特定のステージに達したときに自動的に投稿を追加するを参照してください。他には何も投稿されたり送信されたりしません。ケースを終了したり、その種類を変更したりしても、誰にも通知されません。
meta_dataは、そのケースに含まれるすべてのカスタムフィールドを置き換えます。- 閉じられたケースも、再び開くことができます。そのため、
"case_status": 1を使って、そのケースを再開することができます。
ステージとカスタムフィールド
GET /stagesには、管理者が設定 › 段階の下で設定する各段階が一覧表示されます。各段階には、stage_id、name、description、orderという情報が含まれています。キーを使ってはいけません。キーは、各段階を読むことはできますが、変更することはできません。
GET /schemas?schema_type=casesは、設定 › フィールズで設定されているホップのカスタムフィールドを、ページのリストとして表示します。各ページには、そのフィールドのキー、ラベル、タイプが記載されています。meta_dataでは、各ページに1つのオブジェクトが含まれており、そのオブジェクト内にはフィールドキーごとに値が格納されています。
{"meta_data": [{"policy_number": "PN-5521", "insurer": "Northwind Mutual"}]}
値は、そのフィールドの型に合ったものでなければなりません。そうでない場合、その呼び出しは拒否されます。必須のチェックは、Admin PanelやLobbyでのケースフォームによってのみ行われます。そのため、ここで作成または更新されるケースでは、必須フィールドが空欄のままになってしまう可能性があります。
ケースの削除
DELETE /cases/<case_id>は、204に回答します。この操作を行うと、対象のリストはすぐに削除されます。そして、そのリストに含まれていた投稿物やファイル、フォーム、電子署名、請求書、イベント情報、タスク、メモなどもすべて削除されます。この操作は元に戻せず、誰にも通知されません。削除が完了した後、そのタグのIDは再び自由になります。
電話が拒否された場合
| 状態 | message | なぜ |
|---|---|---|
| 400 | SchemaFieldsException | フィールドが欠落しているか、有効ではありません。errorsという名前で表されています。そのフィールド上にある未知のケースタイプやステージは、FieldValidatorFailedExceptionです。 |
| 400 | CaseReferenceIdExistsException | また、タグIDを持つケースもあります。そのうちの一つは、まだ削除されていない状態です。reasonは、そのケースのcase_idを保持しています。 |
| 404 | ItemNotFoundException | そのケースは存在しません。別のハブに属しているか、または削除されている可能性があります。 |
| 403 | ManageBillingInactiveException | 支払いが失敗した後、あなたのハブの管理パネルがロックされています。 |
エラー内容やその他のコードについては、APIのエラーやステータスコードの処理方法を参照してください。