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 を生成または設定し、連携ページに入力します。両側の値は完全に一致している必要があります。一致しない場合、コールバックリクエストを復号できません。
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 公式サイトにログインします。
- ページ右上のアバターをクリックしてユーザーセンターに移動し、企業管理 > 詳細設定 > 企業自社アプリを選択します。
- アプリを追加をクリックし、アプリ名を入力して、企業のデータアクセス範囲に応じてアプリタイプを選択して送信します。アプリレベルでは権限範囲を個別に設定でき、エンタープライズレベルではデフォルトで企業範囲内のデータにアクセスでき、権限範囲メニューは表示されません。
- 作成したアプリに移動し、基本情報を補充して、アプリの状態を有効に設定します。
- アプリレベルアプリを作成した場合は、企業自社アプリの一覧でアプリ名をクリックして詳細に移動し、左側の権限範囲を選択して、企業会議の詳細情報の管理権限を検索して有効にします。この権限は、会議の作成と入会リンクの取得に使用します。権限に承認が必要な場合は、アプリ管理者が承認を完了してください。エンタープライズレベルアプリではこの手順は不要です。
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 を割り当てている場合は、このパラメータが入力されていることも確認してください。その後、アプリが有効な状態であり、企業会議の詳細情報の管理権限が設定されていることを確認し、会議作成者 User ID が現在の企業内で正常な状態かつ会議を開始する権限を持つメンバーに対応していることも確認してください。
関連情報¶
以下のコンテンツにもご興味があるかもしれません。