ビデオ会議APIエンドポイントは、HubSpot内のミーティング作成フローに接続して、ビデオ会議に関する情報を追加するために使用します。
hapikey
クエリーパラメーターに格納して、リクエストURLの末尾に追加します。開発者アカウントで開発者APIキーを確認できます。
PUT
リクエストを/crm/v3/extensions/videoconferencing/settings/{appId}?hapikey=YOUR_HUBSPOT_DEVELOPER_API_KEY
に送信します。
リクエスト本文にcreateMeetingUrl
フィールドを含め、このフィールドに、HubSpotがミーティング作成Webhookのペイロードの送信先とするURLを設定する必要があります。必要に応じて、他のWebhook URLも追加できます。これらの値は、同じリクエストURLを使用して後で更新できます。
フィールド | 型 | 説明 |
---|---|---|
createMeetingUrl | 文字列 | 新しいミーティングが作成されたときにHubSpotが通知するURL。このフィールドに、ミーティングの詳細を含むJSONペイロードが格納されます。URLでは、https プロトコルを使用する必要があります。 |
updateMeetingUrl | 文字列 | 既存のミーティングが更新されたときにHubSpotが通知するURL。このフィールドに、更新されたミーティングの詳細を含むJSONペイロードが格納されます。URLでは、https プロトコルを使用する必要があります。 |
deleteMeetingUrl | 文字列 | 既存のミーティングが削除されたときにHubSpotが通知するURL。このフィールドに、削除されたミーティングのconferenceId が格納されます。URLでは、https プロトコルを使用する必要があります。 |
userVerifyUrl | 文字列 | HubSpotが外部ビデオ会議システム内に当該ユーザーが存在することを確認するために使用するURL。 |
GET
リクエストを/crm/v3/extensions/videoconferencing/settings/{appId}
に送信します。
返されるレスポンスに、現在構成されているWebhook URLが含まれます。
createMeetingUrl
フィールドで指定されたURLにリクエストを送信します。リクエストのペイロードは、HubSpotアカウントに関する情報、関連するHubSpotユーザー、ミーティングの詳細で構成されます。
フィールド | 型 | 説明 |
---|---|---|
portalId | 数値 | リクエストの送信元HubSpotアカウントのID。 |
userId | 数値 | ミーティングに割り当てられているHubSpotユーザーのID。 |
userEmail | 文字列 | ミーティングに割り当てられているHubSpotユーザーのEメールアドレス。 |
topic | 文字列 | ミーティングのタイトル。 |
source | 文字列 | ミーティングが作成された場所を示します。有効な値は次のとおりです。
|
startTime | 数値 | ミーティングの開始時刻(エポックミリ秒)。 |
endTime | 数値 | ミーティングの終了時刻(エポックミリ秒)。 |
conferenceId
:このイベントで会議に関連付けられた固有のID。
このIDはシステム全体で重複しない値にする必要があります。HubSpotはこのIDを
更新Webhookで返します。conferenceUrl:
ユーザーが会議に参加するために使用するURL。conferenceDetails
:招待に関するプレーンテキストの情報。ここで、
イベントの出席者がこのビデオ会議にアクセスする方法が
説明されます。このテキスト内では改行が維持されますが、改行以外の書式はサポートされません。updateMeetingUrl
を指定した場合、HubSpotはミーティング関連の詳細が変更されるたびに、このURIにリクエストを送信します。ビデオ会議のトピックまたは開催時間を最新の状態に維持する必要がある場合は、この通知が欠かせません。リクエストのペイロードは、HubSpotアカウントに関する情報、関連するHubSpotユーザー、ミーティングの詳細で構成されます。
フィールド | 型 | 説明 |
---|---|---|
conferenceId | 文字列 | ミーティング作成Webhookへのレスポンスとして、貴社の連携によって提供される会議の固有ID。 |
userId | 数値 | ミーティングに割り当てられているHubSpotユーザーのID。値は常に、ミーティング作成ペイロードに含まれるユーザーの値と同じです。 |
userEmail | 文字列 | ミーティングに割り当てられているHubSpotユーザーのEメールアドレス。値は常に、ミーティング作成ペイロードに含まれるユーザーの値と同じです。 |
portalId | 数値 | リクエストの送信元HubSpotアカウントのID。 |
topic | 文字列 | ミーティングのタイトル。 |
startTime | 数値 | ミーティングの開始時刻(エポックミリ秒)。 |
endTime | 数値 | ミーティングの終了時刻(エポックミリ秒)。 |
200
または204
レスポンスコードのみです。
deleteMeetingUrl
フィールドで指定されたURLにリクエストが送信されます。ペイロードには、削除されたミーティングのconferenceId
が含まれます。
200
または204
レスポンスコードのみです。
userVerifyUrl
フィールドを確認します。このフィールドにURLが設定されている場合、HubSpotはネイティブユーザーIDを取得するために、そのURLを呼び出します。取得したIDは、以降のリクエストでユーザーのEメールアドレスとして送信されます。ユーザー確認用のURLが設定されていない場合、HubSpotは常に、ユーザーのIDは確認済みであると見なします。
この設定は任意であり、必要であるかどうかは自由に判断できます。システム内でユーザーマッピングを維持する必要があれば、呼び出しごとにHubSpotユーザーのIDまたはEメールアドレスを内部ユーザーIDにマッピングすることも可能です。
このWebhookのペイロードには、HubSpotアカウントIDとユーザーのEメールアドレスが含まれます。
200
レスポンスまたは任意のエラーコード(404
が適切です)を返すことができます。200
を返す場合は、Eメールアドレスとして使用できる新しいIDを格納したペイロードを返してください。