> ## Documentation Index
> Fetch the complete documentation index at: https://developers.hubspot.jp/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# ビデオ会議拡張機能
export const postmanIcon =
;
# ビデオ会議拡張機能
ビデオ会議APIを使用すると、[Google Meet](https://knowledge.hubspot.com/integrations/use-hubspots-integration-with-google-meet)連携や[Zoom](https://knowledge.hubspot.com/integrations/use-hubspots-integration-with-zoom)連携と同じように、ユーザーが[ビデオ会議を作成する](https://knowledge.hubspot.com/meetings-tool/create-and-edit-scheduling-pages#overview)ときにビデオ会議のリンクを追加するための[公開アプリ](/apps/legacy-apps/public-apps/overview)を構成できます。このAPIを使用するには、次の作業が必要です。
1.ビデオ会議拡張機能Webhookを使用した公開アプリをセットアップします。このアプリに、HubSpotがミーティングの作成、更新、削除イベントが発生した時点でユーザーに通知するために使用するURIを設定します。2.ミーティングの作成Webhookと更新Webhookを処理するカスタムのバックエンドをセットアップします。3. 必要に応じて、ユーザーID検証Webhookを処理するようにバックエンドをセットアップします。
ビデオ会議APIに送信する全てのリクエストには、開発者アカウントの開発者APIキーを使用した認証が必要になります。このキーを`hapikey`クエリーパラメーターに格納して、リクエストURLの末尾に追加します。開発者アカウントで[開発者APIキーを確認](/apps/legacy-apps/public-apps/overview#developer-api-keys)できます。
## 前提条件
手順を開始する前に、[開発者アカウント](/getting-started/account-types#developer-accounts)を作成し、そのアカウント内で[公開アプリ](/apps/legacy-apps/public-apps/overview)を作成します。
## Webhook URLを設定する
まず、HubSpotがミーティングの作成、更新、削除イベントが発生した時点で送信する通知の宛先を把握できるよう、Webhook URLを設定します。
それには、`PUT`リクエストを`/crm/v3/extensions/videoconferencing/settings/{appId}?hapikey=YOUR_HUBSPOT_DEVELOPER_API_KEY`に送信します。
リクエスト本文に`createMeetingUrl`フィールドを含め、このフィールドに、HubSpotがミーティング作成Webhookのペイロードの送信先とするURLを設定する必要があります。必要に応じて、他のWebhook URLも追加できます。これらの値は、同じリクエストURLを使用して後で更新できます。
```json theme={null}
// Example request
{
"createMeetingUrl": "https://example.com/create-meeting",
"updateMeetingUrl": "https://example.com/update-meeting",
"deleteMeetingUrl": "https://example.com/delete-meeting"
}
```
| フィールド | 型 | 説明 |
| ------------------ | --- | ------------------------------------------------------------------------------------------------------------ |
| `createMeetingUrl` | 文字列 | 新しいミーティングが作成されたときにHubSpotが通知するURL。このフィールドに、ミーティングの詳細を含むJSONペイロードが格納されます。URLでは、`https`プロトコルを使用する必要があります。 |
| `updateMeetingUrl` | 文字列 | 既存のミーティングが更新されたときにHubSpotが通知するURL。このフィールドに、更新されたミーティングの詳細を含むJSONペイロードが格納されます。URLでは、`https`プロトコルを使用する必要があります。 |
| `deleteMeetingUrl` | 文字列 | 既存のミーティングが削除されたときにHubSpotが通知するURL。このフィールドに、削除されたミーティングの`conferenceId`が格納されます。URLでは、`https`プロトコルを使用する必要があります。 |
| `userVerifyUrl` | 文字列 | HubSpotが外部ビデオ会議システム内に当該ユーザーが存在することを確認するために使用するURL。 |
**レスポンスの例：**
```json theme={null}
// Example 200 response
{
"createMeetingUrl": "https://example.com/create-meeting",
"updateMeetingUrl": "https://example.com/update-meeting",
"deleteMeetingUrl": "https://example.com/delete-meeting"
}
```
### Webhook URLを取得する
既存のアプリ用に構成されたWebhook URLを取得するには、`GET`リクエストを`/crm/v3/extensions/videoconferencing/settings/{appId}`に送信します。
返されるレスポンスに、現在構成されているWebhook URLが含まれます。
```json theme={null}
// Example 200 response
{
"createMeetingUrl": "https://example.com/create-meeting",
"updateMeetingUrl": "https://example.com/update- meeting",
"deleteMeetingUrl": "https://example.com/delete-meeting",
"userVerifyUrl": "https://example.com/user-verify"
}
```
## Webhookペイロード
Webhook URLを設定すると、ミーティングの作成、更新、または削除イベントの発生時に、HubSpotがこれらのURLにペイロードを送信するようになります。
HubSpotから送信される全てのWebhookには、貴社のアプリシークレットを使用したHMACで署名が付けられます。詳細については、[Webhookのセキュリティーに関するドキュメント](/api-reference/webhooks-webhooks-v3/guide#security)をご確認ください（このページの残りの部分は、これらのビデオ会議拡張機能Webhookには当てはまりません）。
### ミーティング作成Webhook
ミーティングが作成されると、HubSpotは`createMeetingUrl`フィールドで指定されたURLにリクエストを送信します。リクエストのペイロードは、HubSpotアカウントに関する情報、関連するHubSpotユーザー、ミーティングの詳細で構成されます。
```json theme={null}
// Example payload
{
"portalId": 123123,
"userId": 123,
"userEmail": "test.user@example.com",
"topic": "A Test Meeting",
"source": "MEETINGS",
"startTime": 1534197600000,
"endTime": 1534201200000
}
```
| フィールド | 型 | 説明 |
| ----------- | --- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `portalId` | 数値 | リクエストの送信元HubSpotアカウントのID。 |
| `userId` | 数値 | ミーティングに割り当てられているHubSpotユーザーのID。 |
| `userEmail` | 文字列 | ミーティングに割り当てられているHubSpotユーザーのEメールアドレス。 |
| `topic` | 文字列 | ミーティングのタイトル。 |
| `source` | 文字列 | ミーティングが作成された場所を示します。有効な値は次のとおりです。`MEETINGS`：ミーティングは[ミーティングスケジュール設定ページ](https://knowledge.hubspot.com/meetings-tool/create-and-edit-scheduling-pages#create-scheduling-pages)で作成されました。 `MANUAL`：ミーティングは手動でCRMレコードから作成されました。