IM アプリ¶
IM アプリは、Lark または Tencent Meeting を連携し、インシデントウォールームにグループチャットの作成、会議の作成、インシデント情報の同期などの機能を提供します。
ワークスペース管理またはインテグレーション管理の権限を持つメンバーは、インテグレーション > IM アプリから、接続済みのアプリを表示・管理できます。アプリ一覧にはアプリ情報と接続状態が表示され、アプリ名で検索できます。アプリをクリックすると詳細を表示できます。
| プラットフォーム | ウォールーム機能 |
|---|---|
| Lark | プライベートグループチャットの作成、メンバーの招待、インシデントカードの送信・更新、カード操作への応答、グループチャットの解散 |
| Tencent Meeting | クイック会議の作成、会議番号と参加リンクの生成 |
アプリを接続¶
インテグレーション > IM アプリに移動し、アプリを接続をクリックして、接続するプラットフォームを選択します。その後、画面の指示に従って認証情報を入力し、プラットフォーム側の設定を完了します。
Lark への接続¶
1. Lark アプリを作成¶
- Lark オープンプラットフォームにログインし、企業内製アプリを作成します。
- アプリ機能でボット機能を追加します。
2. アプリパラメータを入力¶
インテグレーション > IM アプリに移動し、アプリを接続をクリックして、Larkを選択します。アプリ名と以下のパラメータを入力してください。
| 項目 | 必須 | 説明 |
|---|---|---|
App ID |
必須 | Lark アプリの一意の識別子 |
App Secret |
必須 | アプリのアクセス認証情報を取得するために使用します。暗号化されて保存され、画面には表示されません |
Verification Token |
必須 | カードコールバックが現在のアプリから送信されたものかを検証するために使用します |
Encrypt Key |
必須 | Lark から送信されたカードコールバックリクエストを復号するために使用します |
各パラメータは、Lark オープンプラットフォームの以下の場所で取得できます。
App ID、App Secret: 開発者バックエンド > アプリを選択 > 基本情報 > 認証情報と基本情報から取得します。Verification Token: 開発者バックエンド > アプリを選択 > 開発設定 > イベントとコールバック > 暗号化ポリシーに移動し、システムに表示されている Verification Token をコピーします。Encrypt Key: 同様に暗号化ポリシーページで取得します。この項目に未設定と表示されている場合は、リセットまたはカスタム編集をクリックして Encrypt Key を生成・設定し、接続ページに入力してください。Lark 側と接続ページで値が完全に一致している必要があります。一致しない場合、コールバックリクエストを復号できません。
3. アプリ権限を有効にする¶
Lark オープンプラットフォームの権限管理で、アプリに以下の権限を有効にします。
| 権限 | 用途 |
|---|---|
im:chat |
ウォールームのグループチャットの作成・管理・解散、メンバーの招待、グループ共有リンクの生成 |
im:message |
インシデントカードの送信と更新 |
contact:user.id:readonly |
メールまたは電話番号で Lark ユーザーを照合し、メンバーの自動招待に使用 |
アドレス帳のデータ範囲を設定¶
contact:user.id:readonly を有効にした後、この権限がアクセスできるアドレス帳のデータ範囲を設定する必要があります。
- 権限管理で
contact:user.id:readonlyを見つけ、アクセス可能なデータ範囲 > 設定をクリックします。 - アドレス帳で全メンバーを選択するか、アクセスを許可する部門とメンバーを指定します。
- データ範囲に、ウォールームに招待される可能性のあるすべてのメンバーが含まれるようにしてください。
アドレス帳のデータ範囲は、招待対象メンバーをカバーしている必要があります
システムは、権限付与された範囲内の Lark ユーザー情報のみを取得できます。メンバーが contact:user.id:readonly のアドレス帳データ範囲に含まれていない場合、システムはメールまたは電話番号でそのメンバーを特定できないため、ウォールームのグループチャットを作成する際に、そのメンバーを招待できません。
4. カードコールバックを設定¶
認証情報の検証が成功すると、接続ページの手順 3 でカードコールバック URL が生成されます。Lark オープンプラットフォームの開発設定 > イベントとコールバック > コールバック設定に移動し、以下の設定を完了します。
- 「コールバックを開発者サーバーに送信」を選択し、接続ページで生成されたカードコールバック URL を入力します。
- コールバックを追加:
card.action.trigger。
カードコールバックは後から設定できます。コールバックを設定していなくても、アプリが接続済みと表示されることやグループチャットの作成には影響しませんが、グループ内のインシデントカードの引き受けやクローズなどの操作は一時的に利用できません。
5. アプリを公開し、利用可能範囲を設定¶
アプリを公開し、利用可能範囲を正しく設定する必要があります
Lark オープンプラットフォームでアプリバージョンを必ず公開し、アプリの利用可能範囲を「全メンバー」に設定するか、ウォールームを作成・処理・参加する可能性のあるすべてのメンバーをカバーするようにしてください。アプリを公開していない場合や利用可能範囲が狭すぎる場合は、関連するメンバーの Lark アカウントを照会できず、自動グループ作成が失敗します。
- Lark オープンプラットフォームのアプリ公開 > バージョン管理と公開に移動し、「バージョンを作成」をクリックします。
- アプリの利用可能範囲を「全メンバー」に設定します。範囲を制限する場合は、部門とメンバーを指定することもできますが、ウォールームを作成・処理・参加する可能性のあるすべてのメンバーをカバーする必要があります。
- バージョンを提出して公開を完了します。
一部のメンバーまたは部門を選択した場合は、ウォールームの利用者に変更があった際に利用可能範囲を速やかに調整し、アプリバージョンを再公開してください。
6. 接続を完了¶
アプリの認証情報の検証が完了すると、アプリのステータスが「接続済み」と表示されます。上記の手順に従って、アプリ権限、カードコールバック、アプリ公開、利用可能範囲がすべて設定されていることを確認してから、そのアプリを使用してウォールームを作成してください。アプリ詳細の「コールバック設定」に移動すると、コールバックのステータスを確認したり、コールバックアドレスをコピーしたりできます。
Tencent Meeting への接続¶
バージョンとアカウントの要件
接続企業は、Tencent Meeting のビジネス版、エンタープライズ版、または教育版を使用する必要があります。個人版、無料組織、およびビジネス版、エンタープライズ版、教育版の無料アカウントでは、企業内製アプリを作成できません。会議を作成する企業メンバーには、会議作成資格も必要です。プラットフォームのサポート範囲を確認するには、Tencent Meeting のアプリタイプの紹介を参照してください。
1. 企業内製アプリを作成¶
以下の手順に従って、企業内製アプリを作成します。
- Tencent Meeting の企業管理者アカウントを使用してTencent Meeting 公式サイトにログインします。
- ページ右上のアバターをクリックしてユーザーセンターに移動し、企業管理 > 詳細設定 > 企業内製アプリを選択します。
-
アプリを追加をクリックし、アプリ名を入力して、企業のデータアクセス範囲に応じてアプリタイプを選択します。アプリレベルでは権限範囲を個別に設定でき、エンタープライズレベルではデフォルトで企業内のデータにアクセスでき、権限範囲メニューは表示されません。
ホワイトリスト設定: Guance が Tencent Meeting API を正常に呼び出せるように、現在のワークスペースが所在するサイトに応じて、グローバルホワイトリストに対応する IP アドレスを入力してください。複数の IP アドレスは改行で区切ります。
サイト IP アドレス cn147.97.178.215cn268.79.7.77cn3115.191.33.136cn4124.71.63.1cn68.217.159.66eu294.139.255.222ap13.1.104.3ap247.84.142.109eu118.157.152.101id143.129.51.192us135.164.41.209za1203.123.87.65
上記の設定が完了したら、アプリを提出します。
-
作成したアプリに移動し、基本情報を入力して、アプリのステータスを有効中に設定します。
- アプリレベルアプリを作成した場合は、企業内製アプリの一覧でアプリ名をクリックして詳細に移動し、左側の権限範囲を選択して、企業会議詳細情報の管理権限を検索して有効にします。この権限は、会議の作成と参加リンクの取得に使用します。権限に承認が必要な場合は、アプリ管理者が承認を完了してください。エンタープライズレベルアプリではこのステップは不要です。
Tencent Meeting の企業内製アプリバックエンドを直接開くこともできます。Tencent Meeting プラットフォームでの作成ルールの詳細については、企業内製アプリの操作説明を参照してください。
アプリを作成したら、以下のパラメータを取得し、インテグレーション > IM アプリでアプリを接続 > Tencent Meetingをクリックして入力を完了してください。
| 項目 | 必須 | 説明 |
|---|---|---|
App ID |
必須 | Tencent Meeting バックエンドの企業 ID に対応します |
Secret ID |
必須 | 企業内製アプリの認証情報 |
Secret Key |
必須 | 企業内製アプリの認証キー |
会議作成者 User ID |
必須 | 会議を作成する固定の企業メンバーの User ID |
SDK ID |
企業の設定による | Tencent Meeting がアプリに SDK ID を割り当てている場合に入力必須。未割り当ての場合は空のままにします |
パラメータの取得場所は以下のとおりです。
App ID、Secret ID、Secret Key: 企業管理 > 詳細設定 > 企業内製アプリに移動し、アプリを選択した後、基本情報と認証情報でまとめて取得します。接続ページのApp IDは Tencent Meeting バックエンドの企業 ID に対応しており、企業管理 > アカウント管理 > アカウント情報でも確認できます。SDK ID: 同様に基本情報と認証情報で確認します。このページに SDK ID が表示されている場合は入力必須です。表示されていない場合は空のままにします。会議作成者 User ID: 企業管理 > ユーザー管理 > ユーザー一覧に移動し、会議を作成する企業メンバーを見つけて、その UserID をコピーします。一覧にこの項目が表示されない場合は、一覧フィールド設定で表示できます。このメンバーは正常な状態で、会議を開催する権限を持っている必要があります。
パラメータを入力して認証情報の検証を完了すると、接続が完了します。その後、Tencent Meeting ウォールームを作成する際、システムは設定した企業メンバーを会議作成者として使用します。
アプリの表示と管理¶
アプリの行をクリックすると詳細が表示され、基本情報、接続状態、ウォールーム機能、操作ログを確認できます。
- Lark アプリには「コールバック設定」があり、カードコールバック URL の確認とコピーができます。
- アプリ名やアプリ認証情報などは変更できます。
- 詳細ページで不要なアプリを選択して削除できます。
Lark カードコールバック URL は、IM アプリ管理権限を持つワークスペース管理者のみが表示・コピーできます。表示、コピー、設定変更、アプリ削除などの操作は、すべて監査記録に書き込まれます。
アプリを削除するには、事前に再確認が必要です。削除後、設定は復元できず、新しいウォールームの作成にも使用できません。すでに作成された外部グループチャット、会議、アクセス記録には影響しません。
接続状態¶
| ステータス | 説明 |
|---|---|
| 未検証 | アプリ認証情報が検証されていないため、ウォールームの作成には使用できません |
| 接続済み | 認証情報と基本機能の検証に成功しており、ウォールームの作成に使用できます |
| 接続エラー | 認証情報の無効化、権限不足、または企業側アプリが利用できないため、新しいウォールームを作成できません |
Lark アプリでは、コールバック設定ステータスが個別に表示されます。
| ステータス | 説明 |
|---|---|
| 未設定 | 検証済みのカードコールバックを受信していません。グループチャットの作成はできますが、カード操作は一時的に利用できません |
| 正常 | 送信元の検証を通過したカードコールバックを受信しています |
| エラー | コールバックが継続的に到達不能であるか、署名検証・復号に失敗しています。Lark プラットフォームとアプリ詳細のコールバック設定を確認してください |
アプリの接続エラー時は、画面の指示に従って認証情報、アプリ権限、アプリの利用可能範囲を確認してください。既存のウォールームの外部グループチャットや会議が、これによって自動的に閉じられることはありません。
よくある質問¶
アプリの接続が完了しないのはなぜですか？¶
画面の指示に従って、以下の設定を確認してください。
- アプリ認証情報が正しいこと
- Lark アプリにボット機能が追加され、アプリバージョンが公開されていること
- Lark の権限、アドレス帳のデータ権限、アプリの利用可能範囲がすべて設定されていること
- Tencent Meeting の企業向けバージョン、アプリ権限、会議を作成するアカウントが必要な要件を満たしていること
接続済みのアプリがウォールームを作成できないのはなぜですか？¶
ウォールームを作成できるのは、ステータスが接続済みのアプリのみです。アプリ詳細で接続状態と操作ログを確認し、エラーの指示に従って設定を修正してください。
Secret を変更した後、プラットフォームの権限を再設定する必要がありますか？¶
アプリ ID とアプリ自体に変更がなければ、Secret の変更だけであれば、通常はプラットフォームの権限やコールバックを再設定する必要はありません。新しい Secret を保存した後、アプリが接続済み状態に戻ることを確認してください。
Lark アプリは接続済みなのに、カード操作が反映されないのはなぜですか？¶
アプリ詳細でコールバック設定ステータスを確認してください。
- ステータスが未設定の場合: カードコールバック URL を Lark オープンプラットフォームに設定し、
card.action.triggerコールバックを追加してください。 - ステータスがエラーの場合: コールバックアドレスを確認し、
Verification TokenとEncrypt Keyが Lark オープンプラットフォームの設定と完全に一致していることを確認してください。
コールバックが正常に復帰するまでは、Lark グループチャットの作成と参加はできますが、グループ内のインシデントカード操作は処理できません。
Tencent Meeting アプリは接続済みなのに、会議の作成に失敗するのはなぜですか？¶
App ID、Secret ID、Secret Key が正しく入力されているか確認してください。Tencent Meeting がアプリに SDK ID を割り当てている場合は、そのパラメータも入力されていることを確認してください。次に、ホワイトリスト設定に現在のワークスペースが所在するサイトの IP アドレスが含まれていること、アプリが有効な状態であること、企業会議詳細情報の管理権限が有効になっていることを確認してください。また、会議作成者 User ID が現在の企業内で正常な状態にあり、会議を開催する権限を持つメンバーに対応していることを確認してください。
関連情報¶
以下のコンテンツもご覧いただけます。