ヘルプセンター統合

のために: 管理者

管理キーを使用してユーザーを追加および更新します。

ハブのメンバー一覧を表示したり、クライアントを追加したり、個々のユーザーの詳細情報や案件を閲覧したり、アクセス権を無効化または有効化したりできます。

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

始める前に

このページでは、お使いのハブ内のユーザーに関する操作について説明しています。道筋は https://prd-api-manage.caseactive.com/v1/<hub id> の下に表示されています。キーを使用すると、ユーザーを追加できますが、彼らがログインできるかどうかのみを変更できます。つまり、誰かを管理者やマネージャーにするわけではなく、また、追加した後の情報も変更することはできません。

電話

電話その機能
GET /users/relations自分の拠点にいる人々のリストです。
POST /users/relations誰かを追加する
GET /users/relations/<user_id>一人の人を読む
PUT /users/relations/<user_id>ある人を無効にするか、再び有効にする
GET /users/relations/<user_id>/cases誰がどのような状況にあるかを一覧で示しています。

人物一覧

パラメータその機能必須デフォルト
type1は、活動中の人々向けです。0は、障害を持つ人々向けです。名前からわかるように、このフィルターはユーザーの種類ではなく、ステータスによって行われます。いいえ。どちらも
limit1ページに表示できる人数は、最大で1000人です。いいえ。20
start_key前のページにあるstartKeyいいえ。最初のページ

各人には、それぞれ特徴があります。 user_id, given_name, family_name, email, phone, email_verified, phone_verified, locale, zoneinfo, host_user_type (admin, manage または user), host_user_status (1 活発な、 0 障害を持つ人々) host_ref_id, host_default_role, host_staff_designation, host_cases_ct (そのケースの数) host_granted_status (approve, または reject 彼らが、あなたのハブが自分たちのプロフィールにアクセスできないようにした後です。 created_on. このリストは、特別な順序に沿って並んでいません。ここには、あなたのハブに関する情報が含まれています。 バーチャルアシスタントバーチャルアシスタント 会社への歓迎メッセージ、チェックイン、ステージングに関する投稿を行う自動化されたチームメンバー。その投稿にはバーチャルアシスタントのバッジが付いています。, その人/そのもの host_user_type はい bot, そして、各新しいハブで始まる2人のサンプル人物のうち、1人はStaff Demoです。 host_user_type staff. まだ多くの人々が残っている限り、呼びかけ続けてください。 nextLink, または送信してください。 startKey そのように start_key.

誰かを追加する

分野その機能必須デフォルト
username彼らのメールアドレス、または国番号が付いた携帯電話番号です。例えば、「+12035556677」のような形式です。国番号がない番号は、アメリカの番号と解釈されます。はい。—
given_name, family_name名前は、タイプしたままにしておきます。小文字のみで書かれた場合や、すべて大文字で書かれた場合は、単語ごとに大文字を使用します。例えば、mary smithという文字列は、Mary Smithとして保存されます。はい。—
locale言語:ar、de、en、es、fr、id、it、ja、pl、pt、ru、またはzhいいえ。en
zoneinfoタイムゾーン、例えば America/New_Yorkいいえ。US/Eastern
host_ref_id自分のIDを、例えばクライアント番号のようなものとして使用します。文字、数字、ハイフンやスラッシュなどを含むものですが、すべて小文字で表記されます。同じIDを複数の人が共有することはできません。いいえ。なし
host_default_roleその役割は、role::clientsのように、ケースに追加される際に最初に選ばれます。しかし、それによって何かを得ることはできません。いいえ。role::clients
host_staff_designation彼らの通常のスタッフの呼称は、primary、attorney、paralegal、case_manager、lead_attorney、またはlead_paralegalです。いいえ。primary
birthdate生年月日、例:1985-04-12いいえ。なし
genderMale または Femaleいいえ。なし
address1, address2, locality, region, postal_code住所、2行目の内容、都市名、州名、郵便番号いいえ。なし
country2文字で構成される国コードです。例:USいいえ。なし
company, title会社名および職位いいえ。なし
host_meta_data彼らのカスタムフィールドは、ユーザーフィールドの各ページに1つのオブジェクトずつ表示されます。ページを読む際には、GET /schemas?schema_type=usersを使って表示させます。必須とマークされたフィールドは省略しても問題ありません。編集ユーザーのみがそのフィールドをチェックします。いいえ。なし
curl -X POST https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/users/relations \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"username": "jane.sample@example.com", "given_name": "Jane", "family_name": "Sample", "zoneinfo": "America/New_York", "host_ref_id": "cl-1042"}'

それは、201に対して、user_idで答えます。

{"data": {"host_id": "ca-7e6d5c4b3a2f10", "user_id": "cu-4f1c2a9e8b7d60", "selfLink": "https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/users/relations"}}
  • キーを追加する人は、すべてユーザーです。どのようなユーザーであっても、送信した内容は有効になります。
  • キーは、どんな人にもポータルの機能を与えることはできません。つまり、事件を作成したり、人々を事件に追加したり、または彼らを事件から除外したりすることはできません。host_create_case、host_add_case_user、host_remove_case_userのようなメッセージの送信も拒否されます。また、誰も追加されることはありません。アドミンがそれらの設定を行います。ユーザーを編集で設定されます。
  • もし、そのアドレスや番号がすでに他の会社で登録されている場合、または登録されていない場合でも、その人はそのアカウントにリンクされます。そうでない場合は、新しいアカウントが作成されます。どちらの場合も、誰にもメールやテキストメッセージは送られません。あなたがその人を案件に追加する際にのみ、その人から連絡が来ます。詳細は 管理キーを使って案件のメンバーを追加/削除する方法をご覧ください。

誰かの心を読み取る

GET /users/relations/<user_id>は、リストに記載されているすべての情報を含んでいます。さらに、生年月日、性別、住所、勤務先や役職、カスタムフィールド、通知の選択肢、最後にアクセスした時刻なども記載されています。GET /users/relations/<user_id>/casesには、現在進行中の案件が一覧表示されており、それぞれの案件について、case_id、title、case_ref_id(ホブのID)、::、タグID)およびcase_statusが記載されています。また、case_role_idやcase_designationも記載されています。

誰かを無効化または再有効化する

PUT /users/relations/<user_id> 1つのフィールドを取ります。 host_user_status: 0 それらを無効にするために、 1 それらを再び有効にすることができます。これで問題は解決します。 204.

curl -X PUT https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/users/relations/cu-4f1c2a9e8b7d60 \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"host_user_status": 0}'
  • あなたの拠点では、障害を持つ人々がどこでも次のクリックを拒否されてしまいます。しかし、その人のアカウントは他の会社に保持され続けます。詳しくは ユーザーの無効化または有効化についてをご覧ください。
  • 彼らのステータスが変更されると、メールやテキストメッセージで通知が送られます。もし彼らがメールアドレスを持っていない場合は、アクセスが制限されたか、復活したことを知らせるメッセージが送られます。既に持っているステータスを変更しても、何の変化もありません。
  • キーを使って、管理者やユーザーの機能を無効化したり、再び有効化したりすることはできますが、アドミンやそのキー自体の機能を無効化したり、再び有効化したりすることはできません。

電話が拒否された場合

状態messageなぜ
400SchemaFieldsExceptionフィールドが欠落しているか、無効です。 errors それを名前で呼ぶことです。例えば、 FieldUsernameTypeException メールアドレスや電話番号ではないユーザー名の場合 FieldPhoneTypeException 有効でない電話番号の場合です。 FieldNameTypeException 名前のために
400FieldUsernameDupsExceptionあなたのハブで活動している人は、すでにそのメールアドレスや番号を持っています。reasonは、その人のuser_idを保持しています。
400HostUserDisabledExceptionその人は、あなたのハブ内にいるが、機能が制限されている状態です。そのため、彼らを再び有効にしてください。reasonは、user_idを保持しています。
400UserReferenceIdExistsException他の人も、そのhost_ref_idを持っているようです。
400HostUserTypeNotAllowedExceptionあなたは、管理者を無効化しようとしたのか、あるいは、そのキー自体を無効化しようとしたのか?
403BotRelationFieldNotAllowedException誰かを追加する際には、パワーを送信しています。他の何かを追加する場合も同様です。 host_user_status それらを変更する際には
404ItemNotFoundExceptionあなたの住む地域には、そんな人はいないよ。 user_id

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

関連記事

管理キーを使用してケースメンバーを追加および削除します。担当者に役割と役職を割り当てたり、招待メールを送信したり、担当者を確認したり、担当者を外したりすることができます。統合管理キーを持つケースとユーザーを検索独自のソフトウェアから、テキスト、フィルターを使用して、ケース、人物、ケースメンバー、役割を検索し、行をインポートします。統合ユーザーを無効にする、または再度有効にするハブからユーザーを削除せずにブロックしたり、再度アクセスを許可したりできます。どちらの場合も、メールまたはテキストメッセージで通知されます。あなたのクライアント · 1 min