ヘルプセンター統合

のために: 管理者

ハブキーを使用してフォームを送信し、回答を読みます。

テンプレートから案件に関するフォームを作成し、記入すべき担当者に公開して、回答を読みます。

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

始める前に

このページでは、フォームを送信したり、その回答内容を読み取る方法について説明しています。各パスはhttps://prd-api-app.caseactive.com/v1/<hub id>/<case id>の下に記載されています。

電話

電話その機能
GET /forms/templatesご自身のフォームテンプレートの一覧です。
POST /formsそのケースに関するフォームを作成しますが、まだ公開されていません。
PUT /forms/<form_id>/publishそれを公開し、受信者に送ります。
GET /forms?filter=allこのケースのフォームを一覧で示しています。
GET /forms/<form_id>1つのフォームを読み取ります。
PUT /forms/<form_id>名前、締切日、リマインダー、または受取人を変更することができます。
DELETE /forms/<form_id>それと、その回答も一緒に削除します。
GET /forms/<form_id>/responsesその答えを一覧で示しています。
GET /forms/<form_id>/responses/<response_id>一つの回答を読む
DELETE /forms/<form_id>/responses/<response_id>ある人の回答を削除し、その人が再びその回答を書き込めるようにする。

フォームの作成には、2つのステップがあります。まず、フォームを作成し、次にそれを公開します。公開されるまで、受信者はそのフォームを見ることができず、また、誰にもそのことを伝えられません。

フォームの作成

GET /forms/templates 公開されているフォームの一覧です。 テンプレートテンプレート 図書館に保管され、ケースにコピーされる、再利用可能なフィード投稿、フォーム、電子署名、メモ、またはタスク。, 最も古いものから順番に、それぞれのものを… asset_id, title, description, due_mins (送信してから、どれくらいの時間が経ったか) rrule (繰り返し) notifications そして、 instant_notify.

POST /formsは、以下のような値を取ります:

分野その機能必須デフォルト
nameこのフォームのタイトルです。文字、数字、スペース、そして& ' - _ ( ) . /です。コンマやコロンは含まれていません。はい。—
duration{"due_date": "2026-10-09T17:00:00-04:00", "rrule": "FREQ=MONTHLY"} 締切日には、その地域のタイムゾーンを考慮する必要があります。rruleは、繰り返し処理を行う際の条件であり、オプションです。zoneinfoは、繰り返し処理が行われるタイムゾーンです。例えば、America/New_Yorkのように、この値がない場合は、繰り返し処理はホップのタイムゾーンで行われます。つまり、時刻が変わる日時に、その地域のタイムゾーンで処理が行われます。はい。—
participants_idsその情報を記入する人々:つまり、そのケースに関わる人々のユーザーIDです。GET /teamからの情報です。いいえ、ただ、公開する必要がありました。誰も
template{"owner": "host", "template_id": "<asset_id>"} は、テンプレートのドキュメントを使用するためのものです。いいえ。なし
descriptionフォームと一緒に表示されるメモいいえ。テンプレートの内容です。
notifications注意事項:{"names": ["days", "hours"], "values": [-1440, -60]}。締切日までの時間を分単位で示します。いいえ。テンプレートがある場合、または何もない場合。
instant_notifyfalse は、公開時にどのようなリクエストも送信しない。ただし、リマインダーだけは送信される。いいえ。テンプレートのことです、つまりtrue

テンプレートは、その文書や説明、リマインダーなどを含んでいます。 instant_notify, しかし、その時期ではないし、繰り返すこともない。仕事をこなすしかない。 due_date から due_mins, そして、それを送り出すのです。 rrule もし、そうであれば。

curl -X POST https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/forms \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Case intake form", "duration": {"due_date": "2026-10-09T17:00:00-04:00"}, "participants_ids": ["cu-4f1c2a9e8b7d60"], "template": {"owner": "host", "template_id": "form::20260915101500_3c2b1a0f9e8d70"}}'

これにより、201はform_idで置き換えられます。テンプレートのドキュメントはバックグラウンドでコピーされます。フォームを読み進めて、copyingがなくなるまで続け、その後、それを公開します。

代わりに、自分で文書を送信したい場合は、templateを含まない形式でフォームを作成し、PDFファイルをアップロードしてください。その後、準備が整うのを待ちます。詳細については、「Hubキーを使ってファイルをアップロードし、添付する方法」を参照してください。

出版

PUT /forms/<form_id>/publishは、どんな値も受け取らず、代わりに200という値を返します。

  • 各受信者には、そのフォームに記入するようのメールが送られます。もしメールアドレスが確認できない場合は、テキストメッセージで連絡が行われます。ただし、それ以外の場合は、すぐにそのフォームに記入するように促されます。 instant_notify はい false. それは、彼らの上に現れているようです。 やるべきことやること 記入すべき書類、署名すべき文書、確認すべきイベントなど、あなたがやらなければならないことのリスト。 そして、彼らのポータル通知にも表示されます。
  • リマインダーは、notificationsの時点で毎回送信されます。しかし、期限内に何も送信されない場合があります。その場合、回答は期限を過ぎてから受け付けられます。
  • 繰り返し行われる形式では、各回ごとに次の締め切り日が来ます。その際、答えは明確になり、すべての人に対して再び質問が行われます。ただし、instant_notifyがfalseの場合は除きます。
  • このケースから除外された人は、フォームから外されます。

フォームが公開された後では、その文書を変更することはできません。文書の名前、締切日、リマインダー、受信者、説明などは、PUT /forms/<form_id>で指定されます。また、zoneinfoなしで繰り返し送信すると、既存のタイムゾーンが保持されます。締切日やリマインダーを変更すると、まだ応答していない人全員にその情報が即座に送信されます。また、instant_notifyやfalseを使用しても、リマインダーが送信されるまで待たされることはありません。

回答を読む

GET /forms/<form_id>/responsesでは、各人の回答が、年齢の順に一覧で表示されます。同じ形式で表示されるのは、現在の日付のみです。以前の日付の回答については、response_idによって引き続き表示されます。

{
  "data": {
    "items": [
      {
        "response_id": "response::20261003153012_9f8e7d6c5b4a30",
        "parent_id": "form::20261002150000_1a2b3c4d5e6f70",
        "user_id": "cu-4f1c2a9e8b7d60",
        "created_on": "2026-10-03T15:30:12+00:00",
        "response": {
          "format": "https://pspdfkit.com/instant-json/v1",
          "formFieldValues": [
            {"v": 1, "type": "pspdfkit/form-field-value", "name": "client_name", "value": "Jane Sample"},
            {"v": 1, "type": "pspdfkit/form-field-value", "name": "accident_date", "value": "2026-09-14"}
          ]
        }
      }
    ],
    "currentItemCount": 1,
    "selfLink": "https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/forms/form::20261002150000_1a2b3c4d5e6f70/responses"
  }
}
  • formFieldValuesは、その人が入力した各フィールドを表しています。各フィールドの値は、nameによって指定されています。署名や絵画は、annotationsとattachmentsに属します。
  • このフォームが自動的に表示する情報には、誰が回答したかが記載されています。responsesは、各ユーザーのIDを、response_idという値にマッピングしています。
  • 誰かが申請を提出した場合、その案件を担当するスタッフは、自分で申請書を送った場合と同じように、そのことを伝えられます。

{"user_id": "<their ID>"}というボディを持つ、ある人の回答を削除すると、その人が待っているフォームに再びその回答が戻ります。誰にも通知は送られません。キーを使ってフォームに入力することはできないのです。

リストフォーム

GET /formsには、filterが必要です。

filterリストされている内容
allこのケースに含まれるすべてのフォーム、未発表のものも含めて、最新のものから順番に表示されています。
selfバーチャルアシスタントが送信される際には、あなたのキーを使って送信することも、自動化されたプロセスによって送信することも可能です。
completed, uncompletedそのフォームには、電話をかけてきた人が記入する必要があります。しかし、そのフォームは、キーがない場合には常に空欄のままです。

各フォームには、form_id、name、participants_ids、due_date、published(1は一度だけ公開されます)、responses、responses_ctが保持されています。また、各フォームの下には、その文書がmediaとして記録されています。

DELETE /forms/<form_id>は、いつでもそのフォームと、その中に含まれる回答内容を削除することができます。そして、そのフォームは、もう誰の待ち受けリストにも表示されなくなります。誰にもそのことを伝えません。

電話が拒否された場合

状態messageなぜ
400SchemaFieldsExceptionフィールドが欠落しているか、有効でない場合があります。例えば、name内にカンマが含まれている場合や、オフセットが設定されていない締切日がある場合、または、そのケースに含まれていない人がいる場合です。errorsは、そのフィールドの名前を表しています。
400SchemaFieldsException、ItemCopyNotAllowedExceptionはtemplateの値を持ちます。そのテンプレートは、公開されていないか、ボットのロールにアクセスできない状態です。また、そのファイルもまだ処理中の状態です。
403PublishAlreadyPublishedExceptionもう、出版されています。
403PublishAlreadyAnsweredExceptionすでに、その質問に答えてくれている人がいます。
403PublishMediaMissingExceptionまだ、その文書は存在していません。
403PublishMediaNotReadyExceptionその文書は、今もなおコピーされているか、変換されている最中です。
403PublishMediaFailedExceptionその文書は、変換されませんでした。
403PublishDueTimePassedException期限が過ぎてしまいました。
403PublishRecipientsMissingException送る相手がいないのです。
403BotNotAllowedException鍵が、それを埋めることを試みている。
403CaseClosedExceptionこの事件は、もう終了しました。
404ItemNotFoundExceptionそのフォームや回答は存在しません。

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

関連記事

APIで何ができるかを理解しましょう管理キーとハブキーがそれぞれどのような範囲にアクセスできるのか、なぜすべてのキーが仮想アシスタントとして機能するのか、そして完全な技術仕様書はどこにあるのかを学びましょう。統合ハブキーを使用して電子署名を送信し、署名を読み取るテンプレートから案件の電子署名を作成し、各項目に署名する人を選択し、署名のために公開し、全員が署名したらロックされたコピーをダウンロードします。統合ハブキーを使用してファイルをアップロードおよび添付します。アップロード先アドレスを取得し、ファイルをアップロードして、投稿、メモ、タスク、フォーム、または電子署名に添付し、ケースのファイルをダウンロードします。統合APIエラーとステータスコードを処理するエラー本文を読み、400、401、403、404、500、503の意味、そしてキーで確認できない項目が404エラーを返す理由を確認してください。統合