のために: 管理者
ハブキーを使って投稿やコメントを追加する
仮想アシスタントとして、ケースのフィードに投稿を追加したり、コメントで返信したり、自分のソフトウェアから投稿を読んだり、編集したり、削除したりできます。
この記事では11 セクション
始める前に
このページでは、Hubキーを使って、ケースの投稿やコメントを追加したり、読んだりする方法について説明しています。パスはhttps://prd-api-app.caseactive.com/v1/<hub id>/<case id>の下に記載されています。
電話
| 電話 | その機能 |
|---|---|
GET /posts | そのケースに関する投稿を一覧表示します。最新のものから表示されます。 |
POST /posts | 投稿を追加します。 |
GET /posts/<post_id> | 1つの投稿を読む |
PUT /posts/<post_id> | 投稿内容を変更し、キーを追加します。 |
DELETE /posts/<post_id> | どの投稿も、それに付随するコメントもすべて削除します。 |
GET /posts/templates | この場合に適用される、あなたのフィードテンプレートの一覧です。 |
GET /posts/<post_id>/comments | 投稿のコメントを一覧表示します。最新のものから表示されます。 |
POST /posts/<post_id>/comments | 投稿に対するコメント |
GET /posts/<post_id>/comments/<comment_id> | コメントを1つ読む |
PUT /posts/<post_id>/comments/<comment_id> | キーボードで書かれたコメントを変更します。 |
DELETE /posts/<post_id>/comments/<comment_id> | どのコメントも削除します。 |
キーポストに掲載されている内容は、すべてこのケースに表示されます。 フィードフィード 訴訟に関する投稿のタイムライン。法律事務所がニュースを共有し、訴訟に関わる全員がコメントできる場所。 あなたのハブとして バーチャルアシスタントバーチャルアシスタント 会社への歓迎メッセージ、チェックイン、ステージングに関する投稿を行う自動化されたチームメンバー。その投稿にはバーチャルアシスタントのバッジが付いています。, 自社の名前の下に、Virtual Assistantのバッジを表示してください。ファイルを添付するには、こちらを参照してください。 Hubキーを持つファイルをアップロードして添付してください。. AIによる書類作成の際に表示される技術的な情報は、ポータル上のユーザーのために提供されているものです。しかし、403エラーが発生して、そのキーを拒否されてしまいます。 BotNotAllowedException.
投稿を追加する
| 分野 | その機能 | 必須 | デフォルト |
|---|---|---|---|
message | 投稿のテキストは、最大20,000文字までです。行切れも保持されています。 | はい。 | — |
permissions | ロール役割 スタッフやクライアントなど、特定の人物が案件に関して何を見たり、何を実行したりできるかを決定する一連の権限。がこの情報を見ることができる場合、例えば["role::staff"]のようなものです。この情報を除外しておけば、ケースに関わるすべての人にとって問題ありません。 | いいえ。 | みんな |
template | ファイルを指定した場所から取得するためのフィードテンプレートです:{"owner": "host", "template_id": "<asset_id>"} | いいえ。 | なし |
curl -X POST https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/posts \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"message": "Hi <@cu-4f1c2a9e8b7d60>, the insurer has acknowledged your claim. We expect their estimate within two weeks."}'
これは、201に対して、投稿のIDを返します。
{"data": {"case_id": "cc-1a2b3c4d5e6f70", "post_id": "post::20261002154134_b0accfaac139a9", "selfLink": "https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/posts"}}
- テキストです。 平文のテキストを送信してください。ポータルでは、
**bold**や[a link](https://example.com)、そして単純なウェブアドレスが正しく表示されます。一方、メールでは、そのテキストが実際に書かれた形で表示されます。 - 言及されていること。 書く
<@user_id>この件に関して、ある人物を言及するために、そのIDを使うことです。GET /team, または、「指定コード」のようなものです。<@clients.primary>, そして、それぞれのポータルには、該当する人物が表示されています。@そして、その人の名前も含まれます。この件に関与していない人や、コードが一致しない人については、何も記載されません。彼らが去った後に残されたメッセージは無視されます。400回の試みがありました。FieldRequiredExceptionその時message, そして、何も保存されません。 - 誰がそれを見ることができるでしょうか。 それを持っている人と一緒に
permissions, そのような役割を持つ人々だけが、それを見ることができます。また、投稿を管理する役割を持つ人々も同様です。これは、デフォルトでスタッフとして機能する人々の場合も同じです。
誰に伝えられるか
投稿が追加されるとすぐに…
- 言及されていない場合は、その件に関わるすべての人に伝えられます。一方、言及されている場合は、その人々だけが知らされることになります。
- 各人には、メールで通知が送られます。もしメールアドレスが確認できない場合は、テキストメッセージで通知されます。また、ポータルの通知機能を無効にしている人々には、通知は届きません。
- メールに返信する際には、その返信を、返信した人自身のコメントとして追加します。
- あなたのウェブホックから、
add_postが受信されます。
その後に添付されるファイルも、メールの件数に含まれます。
テンプレートからの投稿
GET /posts/templates 公開されているフィードの一覧です。 テンプレートテンプレート 図書館に保管され、ケースにコピーされる、再利用可能なフィード投稿、フォーム、電子署名、メモ、またはタスク。, 最も古いものから順番に、それぞれのものを… asset_id, title そして、 message. 指定コードについて message この件に関わる人々の情報は、すでに記入されています。
1つのテンプレートを投稿するには、そのままの状態でmessageを送信し、また、テンプレートのファイルを渡すためにtemplateとasset_idも送信してください。テンプレート自体はロールを持ちませんので、permissionsは自分で送信してください。
記事を読む
GET /postsは、limit(デフォルトでは20から1000まで)とstart_keyを受け取ります。また、nextLinkとstartKeyを持つページもあります。各投稿には、以下の情報が含まれます:
| 分野 | 中身 |
|---|---|
post_id, case_id | そのIDは |
user_id | 誰がそれを投稿したのでしょうか。バーチャルアシスタントのIDはcu-です。また、ユーザーのHub IDは14文字です。 |
message | そのテキストには、<@user_id>という記述が含まれています。 |
permissions | 制限されている場合に、それが果たす役割 |
media, media_ct | そのファイルの数や、どのような内容かについては、詳細は不明です。 |
comments_ct, commenters, last_reply | そのコメントの数は?誰が書いたのか?最後に投稿されたのはいつか? |
system | true は、自動化やインポートによって追加されたポストのためのものです。 |
language | この文章が書かれている言語は、何を記録しているのか。 |
created_on, updated_on | この内容が投稿され、最後に変更されたのは、UTC時間で記録されています。 |
キーパーは、この件に関するすべての投稿を読みます。たとえ、限られた情報だけでもです。
編集と削除
PUT /posts/<post_id>は、messageとpermissionsを受け取り、送信したデータのみを変更します。キーは、バーチャルアシスタントが作成した投稿のみを変更できます。つまり、自分自身が作成した投稿や、自動化されたプロセスによって追加される「ようこそ」や「チェックイン」などの投稿も変更可能です。誰にも通知は送られません。テキストが変更されたとき、ウェブホックはmodify_postを受け取ります。- 誰がその投稿を見るかを変更するには、すべての役割の一覧を送信してください。空の一覧は受け付けません。後から追加される役割も含めて、すべての人にその投稿を表示したい場合は、
"permissions": nullを送信してください。後から追加された役割は、この一覧には含まれません。 DELETE /posts/<post_id>は、その件に関するすべての投稿、コメント、ファイルを削除します。誰にも通知はありません。ウェブホックはdelete_postを受け取ります。
コメント
POST /posts/<post_id>/comments 受け取る message, 投稿と同じルールで、回答も同じです。 201 そのうちに comment_id. この投稿を見ることができる人は、その投稿の内容や、その投稿に言及されている人々についてのみ知らされるのです。 GET それらを、最新のものから順番にリストアップしています。 comment_id, user_id, message, media そして、彼らの時代もそうでした。
キーは、PUTと新しいmessageを使って、自分自身のコメントのみを変更することができます。また、任意のコメントを削除することも可能です。
ウェブフック
ウェブホックは、投稿やコメントに起こるすべての変更を受け取ります。キー自体には、add_post、modify_post、delete_post、add_post_media、delete_post_mediaという値が含まれています。また、コメントについても同じ5つの値が使われます。各イベントのwho.user_idは、その投稿やコメントの作成者を示しています。したがって、キーにはバーチャルアシスタントのIDが含まれています。これを確認してください。そうでなければ、システムは自動的にその投稿を新しいものとして扱ってしまいます。詳細については、「ウェブホックのイベントとペイロード」を参照してください。
言語
キーの投稿やコメントには、どの言語も記録されていないため、そのまま表示され、翻訳されることはありません。ただし、特定のテンプレートを使って作成された投稿には、そのテンプレートが使用されている言語が表示されます。そうした投稿は、他の言語を使用する読者にも理解できるように翻訳されて表示されます。詳細はこちらをご覧ください。 投稿やコメントがどのように翻訳されるかを理解しましょう。.
電話が拒否された場合
| 状態 | message | なぜ |
|---|---|---|
| 400 | SchemaFieldsException | フィールドが欠落しているか、無効な状態になっています。例えば、messageが空の場合や、permissionsのリストが空の場合、または、ハブが持っていないロールがある場合です。errorsで指定された名前を持つフィールドに変更を加えても、それは認められません。 |
| 400 | SchemaFieldsException、ItemCopyNotAllowedExceptionはtemplateの値を持ちます。 | そのテンプレートは、公開されていないか、ボットのロールにアクセスできない状態です。また、そのファイルもまだ処理中の状態です。 |
| 403 | ItemAuthorOnlyException | そのキーは、他の人が書いた投稿やコメントを変更しようとしたのです。 |
| 403 | CaseClosedException | この事件は、もう終了しました。 |
| 403 | BotNotAllowedException | そのAIによる設計案の一つを選ぶためのキーです。 |
| 404 | ItemNotFoundException | その投稿やコメントは存在しないか、別のケースに属しています。 |
エラー内容やその他のコードについては、APIのエラーやステータスコードの処理方法を参照してください。