Incoming Webhook ( 会議履歴 )
Developer サイト内の URL 表記についてMiiTel のドメイン変更に伴い、Developer サイト内の一部ページに旧ドメインの URL が記載されている可能性があります。
現在、該当箇所の確認および修正を順次進めております。
Incoming Webhook ( 会議履歴 ) を使用すると、MiiTel Meetings で利用可能な会議履歴を管理、収集、分析することができます。
この機能を使用するには？
Incoming Webhook ( 会議履歴 ) を使用する前に
まず、Incoming Webhook を設定するために使用する URL を作成する必要があります。
- https://account.miitel.jp/v1/signin にアクセスし、管理者権限があるユーザーで MiiTel Analytics にログインします。
- ページの左上にある ⋮⋮⋮ アイコンをクリックします。
- Admin をクリックして MiiTel Admin に移動します。
- MiiTel Admin で、外部連携 > Incoming Webhook をクリックします。
- 会議履歴 タブをクリックします。
- URL を作成 をクリックします。
- 設定画面に URL が表示されます。
注意事項
- 1 つの企業 ID につき、1 つの URL を作成することができます。
- URL を再作成したい場合は、
> 削除 をクリックして URL を削除し、その後で URL を作成 を再度クリックしてください
次に、Incoming Webhook ( 会議履歴 ) を使用するユーザーを許可し、ユーザー ID を取得します。
- ユーザー > ユーザーリスト をクリックします。
- Incoming Webhook ( 会議履歴 ) を使用するユーザーをクリックし、
- Incoming Webhook ( 会議履歴 ) を使用する を 有効にする にチェックを入れます。
- 保存 をクリックします。
- Incoming Webhook ( 会議履歴 ) を使用する許可を受けたユーザーの
- ID をコピー をクリックします。
Incoming Webhook ( 会議履歴 ) の設定
1. Incoming Webhook ( 会議履歴 ) URL にリクエストを送信
以下 URL より、Open API をご確認いただけます。
<https://developers.miitel.com/reference/video__webhook_video_reception>
Open API もしくは、本ページ下部に記載している JSON Schema やリクエストサンプルを参考にして、 会議履歴生成をリクエストしてください。
video_data のオプションフィールド：
| フィールド | 型 | 説明 |
|---|---|---|
video_data.external_id | string | 会議履歴の外部 ID（任意） |
video_data.number_of_participants | integer | 参加者数（participants の件数がデフォルト） |
video_data.channel_type | string | オーディオチャンネル（MONO または STEREO） |
video_data.tags | array | 会議履歴に付与するタグのリスト（value フィールドを持つオブジェクト） |
video_data.participants | array | 参加者オブジェクトのリスト |
video_data.metadata | object | カスタムメタデータを格納する任意の JSON オブジェクト（例：{"recording_device": "iPhone"}） |
レスポンス
| ステータス | 説明 |
|---|---|
| 201 | 会議履歴の作成に成功しました |
| 4xx | リクエストのバリデーションエラー（無効なフィールド、必須フィールドの欠落など） |
リクエストが成功すると、upload_data オブジェクトが返されます。これらの値はすべて保存してください — ステップ 2 および 3 で必要になります。
| フィールド | 型 | 説明 |
|---|---|---|
upload_data.url | string | 動画・音声ファイルをアップロードするための事前署名付き URL（ステップ 2） |
upload_data.video_id | string (UUID) | 作成された会議履歴の ID |
upload_data.video_detail_id | string (UUID) | 会議履歴詳細レコードの ID |
upload_data.tmp_file_id | string (UUID) | 一時ファイル識別子 |
upload_data.external_id | string | リクエスト時に指定した external_id |
2. ファイルをアップロード
リクエストを正常に送信すると、upload_data.url（ファイルをアップロードするための事前署名付き URL）が返されます。以下のファイル形式をアップロードできます。
- オーディオチャンネル：ステレオ、モノラル
- ファイル形式 ：API リファレンスに記載されている video_data.file_type を参照してください。
重要オーディオチャンネルがモノラルの場合、ファイルのアップロード後に話者が判定されます。そのため、一部の会話で話者が誤って検出される可能性があります。
上記の URL に PUT メソッドでファイルを送信します。
リクエスト
| 説明 | |
|---|---|
| endpoint | ステップ 1 のレスポンスで返された upload_data.url |
| method | PUT |
| data | ファイル |
レスポンス
| ステータス | 説明 |
|---|---|
| 200 | アップロード完了 |
| 403 | URL が間違っている、またはリクエスト送信から 3 時間以上経過しセッションが期限切れになった |
3. アップロードを完了する
ファイルのアップロードが完了したら、/complete エンドポイントにリクエストを送信します。これにより MiiTel にファイルのアップロード完了を通知し、解析が開始されます。Open API は以下の URL よりご確認いただけます。
<https://developers.miitel.com/reference/video__webhook_video_upload_completion>
ステップ 1 のレスポンスで返された upload_data の値を使用してリクエストボディを構築してください。
リクエスト
| 説明 | |
|---|---|
| endpoint | /api/video/v2/incoming_webhooks/{id}/complete（ステップ 1 と同じ {id} を使用） |
| method | POST |
リクエストボディ：
| フィールド | 型 | 説明 |
|---|---|---|
upload_data.tmp_file_id | string (UUID) | ステップ 1 のレスポンスの upload_data に含まれる tmp_file_id |
upload_data.video_id | string (UUID) | ステップ 1 のレスポンスの upload_data に含まれる video_id |
upload_data.video_detail_id | string (UUID) | ステップ 1 のレスポンスの upload_data に含まれる video_detail_id |
レスポンス
| ステータス | 説明 |
|---|---|
| 201 | アップロード完了通知を受け付けました。まもなく解析が開始されます。 |
上記の設定が完了したら、MiiTel Meeting の 会議履歴 が正常に作成されているか、エラーがないかを確認してください。エラーについては、以下の例を確認してください。
- 録画が表示されない場合、2. ファイルをアップロード または 3. アップロードを完了する の設定が完了していない、またはアップロードが失敗している可能性があります。
- エラーバナーが表示される場合は、システム管理者にお問い合わせください。
追加情報: リクエストのデータ形式
リクエストスキーマ
会議履歴生成リクエストの JSON スキーマは以下のとおりです。
{
"$schema": "http://json-schema.org/draft-06/schema#",
"$ref": "#/definitions/Schema",
"definitions": {
"Schema": {
"type": "object",
"additionalProperties": false,
"properties": {
"video_data": {
"$ref": "#/definitions/VideoData"
}
},
"required": ["video_data"],
"title": "Schema"
},
"VideoData": {
"type": "object",
"additionalProperties": false,
"properties": {
"title": {
"type": "string"
},
"file_type": {
"type": "string"
},
"host": {
"type": "string",
"format": "uuid"
},
"starts_at": {
"type": "string",
"format": "date-time"
},
"ends_at": {
"type": "string",
"format": "date-time"
},
"external_id": {
"type": "string"
},
"number_of_participants": {
"type": "integer"
},
"channel_type": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/definitions/Tag"
}
},
"participants": {
"type": "array",
"items": {
"$ref": "#/definitions/Participant"
}
},
"metadata": {
"type": "object"
}
},
"required": [
"channel_type",
"ends_at",
"external_id",
"file_type",
"host",
"number_of_participants",
"participants",
"starts_at",
"tags",
"title"
],
"title": "VideoData"
},
"Participant": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"miitel_user_id": {
"type": "string",
"format": "uuid"
},
"stereo_lr": {
"type": "string"
}
},
"required": ["miitel_user_id", "name", "stereo_lr"],
"title": "Participant"
},
"Tag": {
"type": "object",
"additionalProperties": false,
"properties": {
"value": {
"type": "string"
}
},
"required": ["value"],
"title": "Tag"
}
}
}サンプルリクエスト
{
"video_data": {
"title": "Sample Video Title",
"file_type": "mp3",
"host": "123e4567-e89b-12d3-a456-426614174000",
"starts_at": "2025-03-10T10:00:00Z",
"ends_at": "2025-03-10T11:00:00Z",
"external_id": "external-id-123",
"number_of_participants": 2,
"channel_type": "STEREO",
"tags": [
{
"value": "tag1"
},
{
"value": "tag2"
}
],
"participants": [
{
"name": "Participant 1",
"miitel_user_id": "123e4567-e89b-12d3-a456-426614174001",
"stereo_lr": "left"
},
{
"name": "Participant 2",
"miitel_user_id": "123e4567-e89b-12d3-a456-426614174002",
"stereo_lr": "right"
}
],
"metadata": {
"recording_device": "iPhone"
}
}
}Updated 8 days ago