ヘルプセンター統合

のために: 管理者

ハブキーを使用してケースの詳細を読み取り、更新します。

案件の詳細と担当チームを確認し、管理者がバーチャルアシスタントの役割で変更を許可している詳細(ステージやカスタムフィールドなど)を変更します。

この記事では8 セクション

始める前に

このページでは、ハブキーを使って、あるケースの詳細を読み取り、変更する方法について説明しています。パスはhttps://prd-api-app.caseactive.com/v1/<hub id>/<case id>の下に記載されています。

電話

電話その機能
GET /case事件の詳細を読みます。
PUT /caseキーの詳細が変わる可能性があります。
GET /whoamiどの詳細が、このケースにおいて変更される可能性があるかを明記しています。また、どの部分が変更されるかも示されています。
GET /teamこの件に関わる人々のリストです。
GET /placeholdersこのケースにおいて、テンプレートのコードが代入する値を読み取ります。

Hub Keyが読み取り、変更できる内容は、Hubの機能に応じて異なります。 バーチャルアシスタントバーチャルアシスタント 会社への歓迎メッセージ、チェックイン、ステージングに関する投稿を行う自動化されたチームメンバー。その投稿にはバーチャルアシスタントのバッジが付いています。, ボット. この機能では、デフォルトでケースの標準的な詳細情報が読み取られます。アドミニストレーターが許可するまで、どの詳細も変更することはできません。

キーの変更の詳細

中 設定 › ロール, ボットの役割を編集し、その下で… 場合, チク ロールで指定されている、すべてのケースフィールドを更新してください。 そして、その詳細は、キーが変わる可能性があります。 タイトル, 説明, オープン日, 状態, ステージ またはカスタムフィールドを選択することもできます。カスタムフィールドを読み取りできるようにするには、その下にチェックを入れてください。 ロールで指定されている、すべてのケースフィールドを読み取ります。. 見てください。 どのような役割が可能かを変えてみることです。.

GET /whoamiは、このケースにおいて鍵となる役割を果たします。case_read_fieldsやcase_write_fieldsは、それが読み取り、変更できる詳細情報です。case_write_fieldsについては、何も変更されない場合もあります。カスタムフィールドは、meta_data.<field key>として表示されます。また、case_modulesは、このケースで表示されるセクションを示します。つまり、ユーザーのハブのセクションを表しており、このケースでは隠されているセクションは含まれません。このケースに含まれていないセクションへの呼び出しは拒否されます。

事例を読む

curl https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/case \
  -H "Authorization: Bearer YOUR_API_KEY"
{
  "data": {
    "case_id": "cc-1a2b3c4d5e6f70",
    "host_id": "ca-7e6d5c4b3a2f10",
    "ref_id": "rear-end-2026",
    "title": "Jane Sample auto accident",
    "description": "Rear-end collision on Route 9. Waiting on the insurer's estimate.",
    "case_type": "general",
    "case_status": 1,
    "case_stage": "stage::20260927120000_8c1f0e2d3b4a59",
    "date_opened": "2026-03-05",
    "meta_data": {
      "schema": [{"schema": {"type": "object", "properties": {"policy_number": {"type": "string", "title": "Policy number"}}}}],
      "content": [{"policy_number": "PN-5521"}]
    },
    "selfLink": "https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/case"
  }
}
  • デフォルトでは、キーは case_id、ref_id(タグIDタグID ケースに付ける永続的なラベル。例えば、rear-end-2026 など。参照 ID としても表示され、インポート時に使用されます。)、case_status、date_opened、title、description、case_type、case_stageという形式で表示されます。詳細については、省略されています。
  • case_stageは、ステージステージ 案件が進む段階の一つで、例えば「受付」や「請求書送付」などがあり、企業が名称と説明を付け、案件ページに表示されます。のIDです。GET /v1/<hub id>/stagesには、そのステージに登場するキャラクターの名前が記載されています。
  • meta_data.contentには、各フィールドページごとに設定されたカスタムフィールドの値が保持されています。フィールドキーによって、そのキーで読み取れるフィールドのみが表示されます。デフォルトでは、何も読み取りしません。そのため、最初のページは空のままです。例えば、管理者が「ポリシー番号」を読み取らせるように設定している場合があります。meta_data.schemaは、各ページに表示されるフィールドを記述しています。
  • hidden_modulesは、このケースで非表示になっているセクションをリストしています。もしそういうセクションがある場合です。

ケースの変更

PUT /caseは、これらのフィールドのうち任意のものをJSON形式で受け取り、送信したフィールドのみを変更します。

分野その機能必須デフォルト
titleその事件の名前は、すべての人に示されています。いいえ。変わらない
descriptionスタッフ向けの説明です。""を送信すると、その内容が消去されます。いいえ。変わらない
date_openedこの事件が開始された日付、例えば 2026-03-15いいえ。変わらない
case_status0 を使って、そのケースを閉じることができます。ハブキーを使っても、再びそのケースを開くことはできません。いいえ。変わらない
case_stageGET /v1/<hub id>/stagesからのステージのIDです。""を送信して、そのステージからそのケースを取り除きましょう。いいえ。変わらない
meta_dataカスタムフィールドの値:各フィールドページに1つのオブジェクトが表示され、それぞれのオブジェクトには、そのフィールドのキーに対応する値が格納されています。ここでは、最初のページのみを変更できます。また、クリアするフィールドとしては""やnullを送信する必要があります。必須フィールドはクリアできません。いいえ。変わらない
curl -X PUT https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/case \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"case_stage": "stage::20260927120000_8c1f0e2d3b4a59", "meta_data": [{"policy_number": "PN-5521"}]}'

200は、そのケースのIDで回答されます。送信したフィールドがキーに含まれていない場合、その値はケースの値と異なることになります。その場合、403エラーが返され、何も変更されません。reasonは、フィールドの名前を表しています。meta_data.<field key>は、カスタムで定義されたフィールドの名前です。既にケースが持っている値を持つフィールドを送信した場合、それは変更されることなく、無視されるだけです。何も変更されない呼び出しの場合は、204が返されます。

  • 開いているケースを別のステージに移動すると、そのステージに関するマイルストーンが追加されます。もしHubにバーチャルアシスタントがある場合は、ケースが特定のステージに達したときに自動的に投稿を追加するを参照してください。他には何も投稿されたり送信されたりしません。ケースを終了したり、その詳細を変更したりしても、誰にも伝えられません。
  • 一度案件が終了すると、ハブキーを使って行われるあらゆる変更は拒否されます。再開することもできません。管理パネルや、別の管理キーを使って再開するしかありません。詳細はこちらをご覧ください。 案件を閉じるか、再開する.
  • ここでは、Tag IDやケースタイプを変更することはできません。管理キーを使ってタイプを変更することが可能です。

チーム

GET /teamでは、このケースに関わる全員の情報が一覧で表示されます。その中には、バーチャルアシスタントや障害を持つ人々も含まれています。1つのケースには最大20人までしか登録できないようです。バーチャルアシスタントが数えた結果です。

{
  "data": {
    "items": [
      {
        "case_id": "cc-1a2b3c4d5e6f70",
        "user_id": "cu-4f1c2a9e8b7d60",
        "case_role_id": "role::clients",
        "case_designation": "primary",
        "case_notify": 1,
        "host_user_status": 1,
        "given_name": "Jane",
        "family_name": "Sample",
        "locale": "en",
        "zoneinfo": "America/New_York"
      }
    ],
    "currentItemCount": 1,
    "selfLink": "https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/team"
  }
}
  • case_role_id このケースにおいて、その人が果たすべき役割とは何か。 case_designation 彼らの 指定/名称指定 事件における担当者の役職を表すラベル。例えば、主任弁護士、パラリーガル、後見人など。, 例えば、 primary.
  • host_user_statusは、あなたの拠点にいる障害を持つ人々にとっては、0になります。
  • 各人の名前、言語locale) そして、タイムゾーンも含まれています。zoneinfo) デフォルトで戻ってくることです。メールアドレスや電話番号は、決して戻ってきません。
  • Hubキーでは、ユーザーを追加したり削除したりすることはできません。そのような通話は、403 HostAddCaseUserNotEnabledExceptionおよびHostRemoveCaseUserNotEnabledExceptionで応答されます。管理用のキーを使用してください。詳細は、「管理用キーを使ってケースメンバーを追加/削除する方法」を参照してください。

テンプレート値

GET /placeholdersは、placeholdersの下で、テンプレート内の各コードが代入する値を表しています。例えば、clients.primary.full_name、clients.primary.email、case_ref_id、company.phoneなどです。このケースでは、誰も所有していないデザイン名に関するコードは省略されています。また、ケースで「チーム」セクションがオフになっている場合、すべてのチームコードは省略されますが、他のコードは引き続き表示されます。詳細については、ケースの詳細情報を使ってフォームフィールドをプリフェッチするを参照してください。

電話が拒否された場合

状態messageなぜ
400SchemaFieldsExceptionフィールドが有効ではありません。例えば、titleが空であったり、必須のカスタムフィールドが空のまま送信されたり、ホバーのステージに該当するフィールドが存在しない場合です。errorsはそのフィールドの名前です。
403CaseFieldNotWritableExceptionあなたが送信したフィールドは、キーとなるものではありません。reasonという名前で呼ばれています。
403CaseClosedExceptionこの事件は、もう終了しました。
403HostModuleDisabledExceptionこの事件の詳細や、関与するチームの情報は、このページには表示されていません。また、ユーザーの端末では、その情報が表示されないようになっています。
403CaseModulePermissionDeniedExceptionボットが担当する役割では、そのケースの詳細やチームの情報を読み取ることはできないかもしれません。
404CaseNotFoundExceptionそのケースは存在しません。別のハブに属しているか、または削除されている可能性があります。

エラー内容やその他のコードについては、APIのエラーやステータスコードの処理方法を参照してください。

関連記事

APIで何ができるかを理解しましょう管理キーとハブキーがそれぞれどのような範囲にアクセスできるのか、なぜすべてのキーが仮想アシスタントとして機能するのか、そして完全な技術仕様書はどこにあるのかを学びましょう。統合ハブキー付きのケースを探すハブ内のケース(オープンまたはクローズ済み)を一覧表示し、タグIDまたはタイトルで検索し、独自のソフトウェアからケースのIDを検索できます。統合役割ができることを変更するロールの権限、読み取りまたは変更可能なケースフィールド、およびアップロード制限を編集します。これには、組み込みロールも含まれます。セキュリティとアカウント · 5 minAPIエラーとステータスコードを処理するエラー本文を読み、400、401、403、404、500、503の意味、そしてキーで確認できない項目が404エラーを返す理由を確認してください。統合