のために: 管理者
ハブキーを使用してケースにメモを追加する
独自のソフトウェアを使用して案件に関する内部メモを作成し、文書とファイルを配布し、それらを閲覧できる役割を選択できます。
この記事では7 セクション
始める前に
このページでは、ハブキーを使って、ケースのノートノート 案件に関する内部メモは、その役割を担う者のみが閲覧可能であり、事務所が設定を変更しない限り、顧客は閲覧できません。を追加したり読み取ったりする方法について説明しています。パスはhttps://prd-api-app.caseactive.com/v1/<hub id>/<case id>の下に記載されています。
電話
| 電話 | その機能 |
|---|---|
GET /notes/templates | 自分のノートテンプレートを一覧表示します。 |
POST /notes | ノートを作成します。 |
GET /notes | この事件に関する注意事項を記載しています。最新の情報から順番に表示されています。 |
GET /notes/<note_id> | 一通の手紙を読む |
PUT /notes/<note_id> | ノートのタイトルを変更する、または、そのノートを見る人を変更する。 |
DELETE /notes/<note_id> | ノートと、そのファイルも一緒に削除します。 |
ノートとは、チームが保管する文書のことです。その文書には、関連するファイルも含まれます。ノートの内容は、テンプレートから作成されるか、ノートが存在した後にPDFやWordファイルをアップロードすることで作成されます。テキスト入力欄はありません。ノートが追加されたり変更されたりした際には、誰にも通知されません。また、ノートからウェブホックも送信されません。
メモを作成する
| 分野 | その機能 | 必須 | デフォルト |
|---|---|---|---|
name | そのメモのタイトルです。文字、数字、スペース、そして& ' - _ ( ) . /という記号のみです。コンマやコロン、疑問符、または引用符は含まれていません。 | はい。 | — |
permissions | ロール役割 スタッフやクライアントなど、特定の人物が案件に関して何を見たり、何を実行したりできるかを決定する一連の権限。がこのデータを閲覧できる場合があります。例えば、["role::staff"]のようなロールです。ただし、ノートを読み取ることができるロールのみがこのデータを閲覧できます。 | いいえ。 | テンプレートの役割、つまり、ノートを読むことができるすべての役割です。 |
template | {"owner": "host", "template_id": "<asset_id>"}からGET /notes/templatesへ、テンプレートのドキュメントやファイルを持ってくること。または、{"owner": "case", "template_id": "<note_id>"}からこのケースに関するメモをコピーすることも可能です。 | いいえ。 | なし |
curl -X POST https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/notes \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "Case representation letter", "permissions": ["role::staff"], "template": {"owner": "host", "template_id": "note::20260915101500_5e4d3c2b1a0f90"}}'
つまり、201はnote_idで解決されます。
- テンプレートから、このノートは、そのテンプレートに含まれる文書やファイル、役割などを取得します。クライアントの名前などのコードは、ノートが作成される際に一度だけ入力されます。また、ノートを作成した人の情報も、バーチャルアシスタントの詳細から取得されます。バーチャルアシスタントの詳細には、会社の名前が含まれています。ノートのタイトルはコピーされません。送信する際は
nameを使用してください。 - このケースに関するメモのコピーには、そのメモに書かれた内容がそのまま残ります。ただし、
schemaを送信してそれを置き換える場合は除きます。コピーが作成された時点で、コードも再び入力されます。 - テンプレートがない場合は、次にその文書をアップロードしてください。
media_group=schemasを使って住所を指定し、PDFやWordファイルをアップロードします。そして、PUT /notes/<note_id>/schema/mediaを使ってそのファイルを添付します。WordファイルはPDF形式に変換されます。1つのノートには1つの文書しか保存できません。詳細については、Hubキーを使ったファイルのアップロードと添付方法をご覧ください。 - 写真や録音ファイルなど、その他のファイルは、
PUT /notes/<note_id>/mediaと一緒に添付してください。
誰がそれを見るのか
メモの作成者は、そのメモを開くことができます。デフォルトでは、メモを管理する役割を持つスタッフは、どのような役割を持っている人であっても、すべてのメモを見ることができます。一方、クライアントは、管理者がクライアントにメモを見る権限を与えていない限り、メモを見ることはできません。詳細については、「どのような役割でメモを見ることができるかを変更する」をご覧ください。
読書メモ
GET /notesは、limit(デフォルトでは20から1000まで)とstart_keyを取ります。また、各ページには、通常のリストと同じように情報が記載されています。キーは、ケース内のすべてのノートを読み取ります。各ノートには、以下の情報が含まれています:
| 分野 | 中身 |
|---|---|
note_id, case_id | そのIDは |
name | そのタイトル |
user_id | 誰がそれを作ったのか?それは、バーチャルアシスタントのIDによるものです。つまり、キーや自動化された処理によって作られたのです。 |
permissions | それを見ることができる役割がある。ただし、メモを読むことができるすべての役割がそれを見ることができるわけではない。 |
schema_media | その文書のmedia_id |
media, media_ct | そのドキュメントやファイルの数は、実に多くあります。これらを、Hubキーを使ってアップロードし、ファイルを添付するようにダウンロードしてください。 |
schema | 人々が、この文書に何を入力したり、何を描いたりしたか、Instant JSON形式で表示されます。 |
template_id | それが作られたテンプレートです。 |
created_on, updated_on | 作成され、最後に変更が加えられた時点では、UTCで表されていました。 |
GET /notes/templates 公開されているメモの一覧です。 テンプレートテンプレート 図書館に保管され、ケースにコピーされる、再利用可能なフィード投稿、フォーム、電子署名、メモ、またはタスク。, 最も古いものから順番に、それぞれのものを… asset_id, title, description そして、 permissions.
変更と削除
PUT /notes/<note_id>は、nameとpermissionsを受け取り、送信された値のみを変更します。キーによって、ケース内の任意のノートが変更されることがあります。空のpermissionsリストは受け付けません。そのようなリストを送信する場合は、それを見るべきロールを指定してください。そうでない場合は、そのコンテンツは受け付けられません。
DELETE /notes/<note_id>は、その文書やファイルを含むすべてのノートを削除します。誰にもそのことを伝えません。
電話が拒否された場合
| 状態 | message | なぜ |
|---|---|---|
| 400 | SchemaFieldsException | フィールドが欠落しているか、有効ではありません。例えば、name内にカンマがある場合、空のpermissionsリストがある場合、またはハブが持っていないロールがある場合です。errorsで指定されている名前も同様です。 |
| 400 | SchemaFieldsException、ItemCopyNotAllowedExceptionはtemplateの値を持ちます。 | そのテンプレートは、公開されていないか、ボットのロールにアクセスできない状態です。また、そのファイルもまだ処理中の状態です。 |
| 400 | SchemaFieldsException、NoteRoleCannotReadNotesExceptionはpermissions.<n>の値を持ちます。 | permissions内の役割では、ノートを読むことができません。 |
| 403 | HostModuleDisabledException | ご使用のハブには、メモリがオフになっています。また、このケースに隠されている場合もあります。 |
| 403 | CaseClosedException | この事件は、もう終了しました。 |
| 404 | ItemNotFoundException | そのメモは実在しません。 |
エラー内容やその他のコードについては、APIのエラーやステータスコードの処理方法を参照してください。