ヘルプセンター統合

のために: 管理者

ハブキーを使用してファイルをアップロードおよび添付します。

アップロード先アドレスを取得し、ファイルをアップロードして、投稿、メモ、タスク、フォーム、または電子署名に添付し、ケースのファイルをダウンロードします。

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

始める前に

このページでは、ケースにファイルをアップロードしたり、ファイルを添付したり、Hubキーを使ってファイルをダウンロードする方法について説明しています。パスはhttps://prd-api-app.caseactive.com/v1/<hub id>/<case id>の下に記載されています。

仕組み

ファイルのアップロードには、3つのステップが必要です。まず、そのアイテム用のアップロード先を指定します。次に、そのファイルをアップロードします。最後に、そのファイルをそのアイテムに添付します。

アイテムアップロード先アドレス添付取り除く
投稿です。GET /posts/<post_id>/drivePUT /posts/<post_id>/mediaDELETE /posts/<post_id>/media
注釈/備考GET /notes/<note_id>/drivePUT /notes/<note_id>/mediaDELETE /notes/<note_id>/media
タスクです。GET /tasks/<task_id>/drivePUT /tasks/<task_id>/mediaDELETE /tasks/<task_id>/media
子供のタスクGET /subtasks/<subtask_id>/drivePUT /subtasks/<subtask_id>/mediaDELETE /subtasks/<subtask_id>/media
フォームや電子署名、またはメモとしての文書です。GET /<forms, signs or notes>/<id>/drive と media_group=schemasPUT /<forms, signs or notes>/<id>/schema/media—
  • キーを使ってファイルをアップロードできるのは、バーチャルアシスタントが作成した投稿のみです。他のノートやタスク、子タスクにもファイルをアップロードすることができます。
  • コメントにファイルを添付するには、そのファイルのアドレスを/driveで指定し、その後PUT /<posts, signs, tasks or subtasks>/<id>/comments/<comment_id>/mediaを使用します。キーは、自分自身のコメントに対してのみ添付できます。
  • フォームや電子署名によって、1つの文書のみが保持されます。最初の文書の変換に失敗した場合に限って、別の文書を保持することができます。

1. アップロード先アドレスを取得する

パラメータその機能必須デフォルト
media_groupファイルの種類:docs、images、audios、videos、またはfiles。フォーム、電子署名、またはメモのドキュメントの場合はschemasです。はい。—
media_extensionファイルの拡張子は、pdfのような形式です。この拡張子は、特定の形式に従って設定する必要があります。一方、filesの場合は、どのような形式でも使用できます。はい。—
tag_idファイルが保存される際の名前は、文字、数字、ハイフンを組み合わせて表されます。例えば、repair-estimateのような形式です。はい。—
親切拡張機能
docs と schemascsv、doc、docx、odt、pdf、ppt、pptx、rtf、txt、xls、xlsx
imagesBMP、GIF、JPEG、JPG、PNG、SVG、TIFF、WebP
audiosaac、aiff、amr、flac、m4a、mp3、oga、opus、wav、wmaなど、より珍しいオーディオフォーマットもあります。
videos3GP、AVI、FLV、M4V、MP4、MOV、MP4、MPG、OGG、WEBM、WMVなど、より珍しいビデオフォーマットもあります。
filesどんなものでも
curl "https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/posts/post::20261002154134_b0accfaac139a9/drive?media_group=docs&media_extension=pdf&tag_id=repair-estimate" \
  -H "Authorization: Bearer YOUR_API_KEY"

これは、アップロードするアドレスであるurl、および、ファイルと一緒に送信されるフォームの項目であるfieldsを指定しています。fields.keyというのは、ファイルが保存される場所です。このアドレスは1時間間隔で有効です。

2. ファイルをアップロードする

multipart/form-dataからurlへ、fields内の各エントリを含むPOSTメッセージを送信します。最後に、fileというファイルが存在します。fieldsには空のContent-Typeがあります。そこに、ファイルの種類を示す内容を記入してください。例えば、application/pdfのようなものです。もう一つのメッセージを送信する必要はありません。この呼び出しはAPIではなく、ファイルストアに送信されますので、キーは必要ありません。

curl -X POST "<url>" \
  --form-string "key=<fields.key>" \
  --form-string "Content-Type=application/pdf" \
  --form-string "<every other entry of fields, as given>" \
  -F "file=@repair-estimate.pdf"

fieldsのエントリを--form-stringで送信してください。-Fではなく。<で始まるエントリもあります。-Fは、そのようなファイルとして解釈されます。

それで、答えが出ました。 201. 最も大きなファイルの容量は、バーチャルアシスタントの機能制限によるもので、デフォルトでは5,000MBです。管理者はこの値を下げることができます。 設定 › ロール. その上にファイルをアップロードしても、ファイルストレージでは受け入れられません。一度もアップロードされなかったファイルは、3日後に自動的に削除されます。

3. 取り付けます

curl -X PUT https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/posts/post::20261002154134_b0accfaac139a9/media \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"media": [{"media_key": "<fields.key>"}]}'
{
  "data": {
    "items": [{"media_key": "hosts/ca-7e6d5c4b3a2f10/cases/cc-1a2b3c4d5e6f70/posts/post::20261002154134_b0accfaac139a9/media/docs/20261002154512_5f4e3d2c1b0a99/20261002154512_5f4e3d2c1b0a99.pdf", "media_id": "20261002154512_5f4e3d2c1b0a99"}],
    "currentItemCount": 1
  }
}
  • mediaは、複数のファイルを一度に処理します。各ファイルは、同じアドレスからアップロードされている必要があります。
  • 「アタッチ」という操作は、ファイルを追加するだけであり、決してそのファイルを置き換えることはありません。
  • 投稿する際には、ウェブハックを添付してください。 add_post_media 各ファイルについて、そのファイルに関する投稿の件数を示すメールが送信されます。

添付後

ファイルは、アップロード後に処理されます。画像はサイズが調整され、音声や動画は再生用に準備されます。また、ドキュメントはPDF形式に変換され、ページ内の画像も含まれます。filesという種類のファイルは、そのまま保持されます。

各アイテムの読み取り結果は、GET /posts/<post_id>のように表示されます。この場合、そのアイテムに関連するファイルはmedia.<kind>.items.<media_id>の下に表示されます。

分野中身
execution_statusRUNNING が処理されている間は、SUCCEEDEDまたはFAILEDです。
originalアップロードされたファイルです。
pdfPDF形式に変換された文書が、もう準備が整いました。
flat電子署名が有効な状態で、全員が署名をした後です。
tag_id, content_type, media_sizeその名前、種類、およびバイト単位でのサイズ

どのファイルも処理中の間は、そのファイルの情報がencodingとして表示されます。フォームや電子署名を公開するには、その文書が準備が整うまで待つ必要があります。

ファイルをダウンロードする

ファイルをダウンロードするには、以下のリンクからアクセスしてください。 https://privcdn.caseactive.com/ その後に続くものです。 original, pdf または flat, キーは、すべての呼び出しと同じヘッダー内に含まれています。

curl "https://privcdn.caseactive.com/hosts/ca-7e6d5c4b3a2f10/cases/cc-1a2b3c4d5e6f70/posts/post::20261002154134_b0accfaac139a9/media/docs/20261002154512_5f4e3d2c1b0a99/20261002154512_5f4e3d2c1b0a99.pdf" \
  -H "Authorization: Bearer YOUR_API_KEY" -o repair-estimate.pdf

キーのチェックは、すべての呼び出しに対して行われます。その際、IP範囲も含まれます。また、バーチャルアシスタントが読み取ることができる情報を、どの場所からでもダウンロードすることができます。

ファイルの削除

DELETE /<item>/mediaは、ファイルのmedia_idとmedia_groupを含むJSONボディを受け取り、200という値を返します。POSTメッセージの場合、ウェブホックはdelete_post_mediaを受け取ります。フォーム、電子署名、またはノートに記録されている文書は削除することはできません。そのため、そのアイテムを削除する必要があります。

例:新しい投稿のPDF

  1. POST /posts その投稿と一緒に。 message. すぐに、ポータル通知とともに投稿されます。メールが届くのは約30秒後です。その時点で、添付されているファイルの数が確認されるので、その時間内にファイルをアップロードしましょう。
  2. GET /posts/<post_id>/drive?media_group=docs&media_extension=pdf&tag_id=repair-estimate.
  3. ファイルを url に、fields としてアップロードしてください。
  4. PUT /posts/<post_id>/media と fields.key
  5. GET /posts/<post_id>を読み進めます。その結果、ファイル内のexecution_statusがSUCCEEDEDまたはFAILEDになるまで続けます。

電話が拒否された場合

状態messageなぜ
400SchemaFieldsExceptionパラメータが不足しているか、無効な値を含んでいます。例えば、受け入れられない拡張子であったり、スペースがあるtag_idタグを使っている場合です。errorsタグは、そのパラメータの名前を表しています。media.<n>.media_keyタグでは、アップロードが行われなかったか、別のアイテムに対して行われていたかのどちらかです。また、/schema/mediaタグでは、schemasとしてアップロードされていない場合もあります。これは、アップロードするアイテムが存在しない場合にも起こります。リクエストには、何もアップロードされていません。
403ItemUpdateFailedExceptionそのファイルはすでに添付されています。また、フォームや電子署名、メモにも、その文書が既に記載されている状態です。
403ItemAuthorOnlyExceptionそのキーは、他の人が書いた投稿やコメントにファイルを添付しようとした。
403CaseClosedExceptionこの事件は、もう終了しました。
404ItemNotFoundExceptionアップロードするためのアドレスを尋ねても、そのアイテムは存在しません。また、削除するファイルも存在しません。

アップロードされたファイルの内容は、ファイルストア独自のフォーマットで記録されます。ファイルのサイズが上限を超えた場合はEntityTooLargeとなり、アドレスが有効期限を過ぎた場合はAccessDeniedとなります。APIのエラーボディやその他のコードについては、APIのエラーやステータスコードの処理を参照してください。

関連記事

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