Webex API/SDKのFAQ

arkawaka · ‎2022-06-15

この情報は2022年4月時点での情報です。

「Device limit exceeded for participant(参加者のデバイス制限を超えました)」というエラーメッセージの意味と、それを解決するにはどうすればよいですか？
APIを使用してスペース(ルーム)を作成しましたが、APIを使用してユーザーをスペースに追加するプレビューにはどうすればよいですか？
1つのゲスト発行者アプリ(Guest Issuer)で何人のゲストユーザーを作成できますか？
アカウントに対して一度に発行できる有効なトークンの数はいくつですか？
REST APIを使用して会議を作成しようとすると、トークンのスコープが正しいにもかかわらず、次のエラーが表示されます。これはなぜですか？「サーバーは要求を理解しましたが、アクセストークンに必要なスコープがないか、ユーザーに必要な役割またはライセンスがないため、要求を満たすことを拒否しました。」
会議品質データを取得するためのリクエストに使用される「meetingId」を取得するにはどうすればよいですか？
Webex APIのホワイトリストに登録する必要があるIPアドレスまたは範囲は何ですか？
統合の承認を取り消すにはどうすればよいですか？
peopleAPIでユーザーステータスをポーリングします。組織の一部のユーザーが「ステータス」情報を返さないのはなぜですか？
組織の完全な管理者として、組織内の他のユーザーの会議をスケジュールし、記録を取得することはできますか？
コンプライアンスオフィサーとして、組織内のすべてのチーム/ルームのリストを取得するにはどうすればよいですか？
社内の他の人がボットを使用できるようにするには、ボットをWebex App Hubに送信する必要がありますか？
実際のユーザーは統合を承認する必要がありますか、それとも承認をプログラムで完了することができますか？
統合に割り当てられたスコープを変更した場合、新しく追加されたスコープを呼び出すために、ユーザーは統合を再承認する必要がありますか？
アプリ（ボット、統合、ゲスト発行者）はAPIを介して作成できますか？
当社のボットを作成した従業員が退社しました。アカウントが非アクティブ化または削除された場合、ボットは引き続き機能しますか？
ある従業員によって作成されたボットを、組織内の別の従業員のアカウントに転送することは可能ですか？
ボットとWebhookを作成しましたが、ボットはWebhookをトリガーするメッセージを読み取ることができません。これは何が原因でしょうか？
Webhookが通知の受信を停止しました。これを修正するにはどうすればよいですか。また、なぜこれが発生したのでしょうか。
最初にモバイルアプリを作成してデプロイすることなく、モバイルSDK機能をテストする方法はありますか？
最初にモバイルアプリを作成してデプロイすることなく、モバイルSDK機能をテストする方法はありますか？
アダプティブカードの最大幅はどれくらいですか？
誰かがアダプティブカードに応答したときに、アプリケーションはどのように通知されますか？
有効期間が14日より長い、または期限切れにならないaccess_tokenを取得することは可能ですか？
プログラムでaccess_tokenを「更新」または維持する方法を示す利用可能な例はありますか？
アクセストークンを生成しようとするときの「tokenlimit_reached」とはどういう意味ですか？
authentication_code以外に、統合で他の承認方法が可能ですか？
xAPI、xCommandおよびxStatusは、個人に登録されているデバイスで機能しますか。
私はWebexを初めて使用し、組み込みアプリを開発したいと考えています。どうすれば始められますか？
私の会社はWebexのパートナーまたは顧客です。組み込みアプリの開発を開始するにはどうすればよいですか？
埋め込みアプリを作成するにはWebexアカウントが必要ですか？
自分の組織内でのみ使用するアプリケーションを開発できますか？
私はWebex組織の管理者です。組織内で使用するプライベートアプリを承認するにはどうすればよいですか？
会議の参加者やスペースメンバーに関する情報を取得するにはどうすればよいですか？
アプリケーションは、電子メールやユーザー名などのユーザーの個人識別情報（PII）にアクセスできますか？
組み込みアプリAPIを介して会議主催者の電子メールアドレスを取得できません。私は何が欠けていますか？
埋め込みアプリから直接WebexAPIを呼び出すことはできますか？
私はWebex組織の管理者です。特定のアプリの個人情報（PII）へのアクセスを有効にするにはどうすればよいですか？
Webexは埋め込みアプリをレンダリングするためにどのブラウザエンジンを使用しますか？
組み込みアプリはユーザーのマイクまたはカメラにアクセスできますか？
埋め込みアプリでCookieまたはローカルストレージを使用できますか？

「Device limit exceeded for participant(参加者のデバイス制限を超えました)」というエラーメッセージの意味と、それを解決するにはどうすればよいですか？

このエラーは、SDKのデバイス登録しようとしているユーザーがデバイス登録できる回数の制限に達したことを示しています。各ユーザーは、一度に最大100のSDKのデバイス登録が許可されます。meetings.unregisterを呼び出していない場合、登録は7日後に自動的に削除されるまで残ります。このエラーを回避するには、通話が終了した後、またはブラウザウィンドウを閉じたり更新したりする前に、meetings.unregisterを呼び出す必要があります。

APIを使用してスペース(ルーム)を作成しましたが、APIを使用してユーザーをスペースに追加するプレビューにはどうすればよいですか？

スペースへのユーザーの追加は、/membershipsAPIを使用して行われます。POSTリクエストでは、スペースにroomIdを指定し、スペースに追加する人にpersonIdまたはpersonEmailを指定します。

1つのゲスト発行者アプリ(Guest Issuer)で何人のゲストユーザーを作成できますか？

単一のゲスト発行者アプリケーション(Guiest Issuer)で作成できるゲストユーザーの数に定義された制限はありません。

アカウントに対して一度に発行できる有効なトークンの数はいくつですか？

アカウントには、一度に最大750のアクティブなアクセストークンが許可されます。その制限に達すると、ユーザーは新しいアクセストークンを生成できなくなり、一部のアクティブなアクセストークンの有効期限が切れるまでhttps://developer.webex.comなどのWebexサイトにログインできないという問題が発生する可能性があります。Integrationによって生成されたアクセストークンは14日間有効であるため、この制限に達しないようにするための良い方法は、既存のトークンが有効期限切れになる14日毎に1回新しいトークンを生成することです。ユーザーは、 https：//idbroker.webex.com/idb/profile#にログインし、ページの下部にある[デバイス]をクリックしてから、セッションの横にある[セッションの終了]をクリックして終了することで、トークンを解放できます。組織管理者は、Authorizations APIを使用してトークンを取り消すことができます。

REST APIを使用して会議を作成しようとすると、トークンのスコープが正しいにもかかわらず、次のエラーが表示されます。これはなぜですか？「サーバーは要求を理解しましたが、アクセストークンに必要なスコープがないか、ユーザーに必要な役割またはライセンスがないため、要求を満たすことを拒否しました。」

これは、ユーザーにWebex Meetingライセンスが割り当てられていない場合、または管理者のみが実行できるAPI要求を実行しようとしている非管理者など、ユーザーの役割で許可されていないAPI要求を実行しようとしている場合に発生する可能性があります。

会議品質データを取得するためのリクエストに使用される「meetingId」を取得するにはどうすればよいですか？

Meeting Qualities APIを使用する場合は、会議のinstanceIdが必要です。これは、GETリクエストのパラメータを使用して/MeetingsAPIを呼び出すことで取得できます。meetingType=meetingこれにより、進行中および終了した会議が返され、返される「id」値は会議のinstanceIdになります。会議のinstanceIdがどのようにフォーマットされるか例は以下の通りです。06263e1088604fc1b3ca17fbe49fe97d_I_195989045032040979。

Webex APIのホワイトリストに登録する必要があるIPアドレスまたは範囲は何ですか？

TBA

管理

アンカー

統合の承認を取り消すにはどうすればよいですか？

組織管理者は、 Authorizations APIを使用して、組織内のユーザーのアクセストークンを取り消すことができます。

peopleAPIでユーザーステータスをポーリングします。組織の一部のユーザーが「ステータス」情報を返さないのはなぜですか？

ユーザーの「ステータス」が「不明」として返され、そのユーザーが組織のメンバーである場合、それはユーザーが30日以上非アクティブになっていることを意味します。

組織の完全な管理者として、組織内の他のユーザーの会議をスケジュールし、記録を取得することはできますか？

はい。詳細については、https：//developer.webex.com/docs/meetings#adminorganization-level-authentication-and-scopesをご覧ください。コンプライアンスオフィサーが会議関連のAPIで実行できることの詳細については、https：//developer.webex.com/docs/meetings#compliance-officer-level-authentication-and-scopesを参照してください。

コンプライアンスオフィサーとして、組織内のすべてのチーム/ルームのリストを取得するにはどうすればよいですか？

現時点では、組織内のすべてのチームを一覧表示する方法はありません。回避策は、コンプライアンス担当者が/ events APIからデータを取得してroomIdsを取得し、/rooms/を使用してスペースの詳細を取得することです。APIそれがチームの一部であるかどうかを確認し、teamIdを取得します。teamIdsを取得したら、チームの詳細を取得して、チームメンバーシップを一覧表示できます。コンプライアンス担当者が組織内のすべてのチームとスペースを直接一覧表示できるようにする今後の改善がありますが、これらがいつ利用可能になるかについてのETAはありません。

社内の他の人がボットを使用できるようにするには、ボットをWebex App Hubに送信する必要がありますか？

いいえ、ボットを組織内の他のWebexユーザーが利用できるようにするために、ボットをAppHubに送信する必要はありません。アプリをAppHubに送信する必要があるのは、 Webex App Hubにリストして、すべてのWebexユーザーが利用できるようにする場合のみです。

実際のユーザーは統合を承認する必要がありますか、それとも承認をプログラムで完了することができますか？

実際のユーザーは、Webブラウザーを介して統合を承認する必要があり、プログラムで統合を承認する方法はありません。ただし、OAuthフローを一度実行し、最初のアクセストークンと更新トークンを取得したら、更新トークンを使用して、プログラムで新しいアクセストークンを生成できます。

統合に割り当てられたスコープを変更した場合、新しく追加されたスコープを呼び出すために、ユーザーは統合を再承認する必要がありますか？

はい。新しく追加されたスコープの統合へのアクセスを許可するには、OAuthフローを再度実行する必要があります。

アプリ（ボット、統合、ゲスト発行者）はAPIを介して作成できますか？

いいえ。開発者ポータルでのみ作成できます。

当社のボットを作成した従業員が退社しました。アカウントが非アクティブ化または削除された場合、ボットは引き続き機能しますか？

はい。

ある従業員によって作成されたボットを、組織内の別の従業員のアカウントに転送することは可能ですか？

はい。組織管理者は、アプリケーション転送アプリを使用してこれを行うことができます。

ボットとWebhookを作成しましたが、ボットはWebhookをトリガーするメッセージを読み取ることができません。これは何が原因でしょうか？

Webhookが通知の受信を停止しました。これを修正するにはどうすればよいですか。また、なぜこれが発生したのでしょうか。

最初にモバイルアプリを作成してデプロイすることなく、モバイルSDK機能をテストする方法はありますか？

アダプティブカードの最大幅はどれくらいですか？

アダプティブカードの最大幅は432pxです。

誰かがアダプティブカードに応答したときに、アプリケーションはどのように通知されますか？

有効期間が14日より長い、または期限切れにならないaccess_tokenを取得することは可能ですか？

プログラムでaccess_tokenを「更新」または維持する方法を示す利用可能な例はありますか？

アクセストークンを生成しようとするときの「tokenlimit_reached」とはどういう意味ですか？

Webexユーザーは、一度に最大750のアクティブなアクセストークンを持つことができます。ユーザーがその制限に達してさらにトークンを生成しようとすると、「tokenlimit_reached」エラーが返されます。これに対する解決策は、https： //idbroker.webex.com/idb/profile#/にログインしてセッションの一部を終了するか、devsupport @ webex.comにチケットを送信して、アカウントのすべてのアクセストークンを取り消すことです。

authentication_code以外に、統合で他の承認方法が可能ですか？

いいえ。サポートされているメソッドはAuthorization_codeのみであり、現在、他のメソッドを追加する予定はありません。

xAPI、xCommandおよびxStatusは、個人に登録されているデバイスで機能しますか。

いいえ。デバイスはクラウドに登録し、ワークスペースに登録する必要があります。

私はWebexを初めて使用し、組み込みアプリを開発したいと考えています。どうすれば始められますか？

まず、デベロッパーポータルで埋め込みアプリを作成するために使用できるテスト組織を提供するデベロッパーサンドボックスをリクエストする必要があります。次に、開発者のクイックスタートに従って、最初の埋め込みアプリを作成、構成、テストし、埋め込みアプリのJavaScriptフレームワークに慣れます。

私の会社はWebexのパートナーまたは顧客です。組み込みアプリの開発を開始するにはどうすればよいですか？

Webexパートナーまたは顧客として、組織向けの組み込みアプリの作成をすぐに開始できます。開発者のクイックスタートに従って、最初の組み込みアプリを作成、構成、およびテストします。また、Embedded AppsJavaScriptFrameworkについても理解してください。

メインのWebex組織の外部で埋め込みアプリを作成してみたい場合は、開発者サンドボックスをリクエストできます。これにより、テスト用の「ダミー」組織が提供されます。

埋め込みアプリを作成するにはWebexアカウントが必要ですか？

埋め込みアプリを作成するには、デベロッパーサンドボックスをリクエストする必要があります。これにより、埋め込みアプリの作成とテストに使用できるテスト組織とWebex管理者アカウントが提供されます。

自分の組織内でのみ使用するアプリケーションを開発できますか？

はい。Webex組織の管理者によって承認されると、組織のメンバーのみが使用できるプライベートアプリを作成できます。プライベート埋め込みアプリの承認をリクエストするには、デベロッパーポータルの埋め込みアプリの構成ページで[管理者承認のリクエスト]をクリックします。

私はWebex組織の管理者です。組織内で使用するプライベートアプリを承認するにはどうすればよいですか？

Webex組織の管理者は、ControlHubのEmbeddedAppsビューから開発中のアプリを承認できます。

会議の参加者やスペースメンバーに関する情報を取得するにはどうすればよいですか？

現在、組み込みアプリAPIは、会議の参加者またはメッセージングスペースのメンバーに関する情報を一覧表示または取得する方法を提供していません。アプリケーションがWebexRESTAPIを介してユーザー情報を取得できるようにする組み込みアプリとWebex統合ソリューションを組み合わせて作成することができます。

アプリケーションは、電子メールやユーザー名などのユーザーの個人識別情報（PII）にアクセスできますか？

デフォルトでは、組み込みアプリは、getUser（）、 getMeeting（）、またはgetSpace（） APIメソッドによって返される個人識別情報（PII）にアクセスできません。この設定は、ユーザーのWebex組織管理者がアプリごとに制御できます。

デフォルトでは、PIIを含む値は空白（空の文字列）であるか、「派生」値を含みます。導出された値はサードパーティには不透明ですが、特定のユーザーに対して一貫性があることが保証されています。これにより、PIIへのアクセスが許可されていない場合でも、ユーザーをアプリケーションセッションに関連付ける方法がアプリに提供されます。詳細については、「個人情報（PII）および組み込みアプリ」を参照してください。

組み込みアプリAPIを介して会議主催者の電子メールアドレスを取得できません。私は何が欠けていますか？

個人情報にアクセスするためのアプリの設定に関係なく、会議の主催者に関する情報は現在SDKを介して利用できません。SDKによって提供される唯一のユーザー情報は、組み込みアプリを使用する会議参加者向けです。詳細については、「個人情報（PII）および組み込みアプリ」を参照してください。

組み込みアプリとWebex統合ソリューションを組み合わせて作成し、会議の主催者に関する情報を取得できます。

埋め込みアプリから直接WebexAPIを呼び出すことはできますか？

埋め込みアプリは、 WebexAPIを直接呼び出すことはできません。ただし、組み込みアプリと統合で構成される複合ソリューションを作成して、このタイプのアプリケーションを有効にすることができます。このシナリオでは、組み込みアプリは、組み込みアプリに代わってWebex API呼び出しを行うバックエンドプロセス（統合）によって支援されます。組み込みアプリは、統合によって処理されたAPI呼び出しの結果を表示します。詳細については、『Embedded Apps Developer Guide』の「 About Combined Embedded AppandIntegrationSolutions 」を参照してください。

私はWebex組織の管理者です。特定のアプリの個人情報（PII）へのアクセスを有効にするにはどうすればよいですか？

Webex組織の管理者は、ControlHubのEmbeddedAppsビューにあるアプリの構成ページからPIIへのアプリアクセスを許可できます。

Webexは埋め込みアプリをレンダリングするためにどのブラウザエンジンを使用しますか？

MacOSでは、プラットフォームにインストールされているWebKitエンジンを使用して、会議スペースとメッセージングスペースの両方で実行される組み込みアプリをレンダリングします。

Windowsでは、Webexは会議中のアプリにWebView2を使用します。これは、MicrosoftEdgeブラウザーと同じChromiumコアに基づいています。メッセージングスペースで実行されているアプリの場合、Webexは現在Chromium Embedded Framework（CEF）を使用しています。

Linuxでは、CEFは会議スペース

とメッセージングスペースの両方で実行されるアプリに使用されます。

組み込みアプリはユーザーのマイクまたはカメラにアクセスできますか？

組み込みアプリの初期段階では、ユーザーのカメラへのアクセスとマイク/オーディオアクセスはサポートされていません。

埋め込みアプリでCookieまたはローカルストレージを使用できますか？

はい。ユーザーがWebexまたはMeetingCenterクライアントを閉じて、後で再度開くと、アプリケーションが設定するCookieとローカルストレージデータが利用可能になります。詳細については、「Cookieとローカルストレージの使用」を参照してください。