本產品（
音視頻通信/2018-01-11）的OpenAPI采用RPC簽名風格，簽名細節參見簽名機制說明。我們已經為開發者封裝了常見編程語言的SDK，開發者可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由于自簽名細節非常復雜，需花費 5個工作日左右。因此建議加入我們的服務釘釘群（78410016550），在專家指導下進行簽名對接。在使用API前，您需要準備好身份賬號及訪問密鑰（AccessKey），才能有效通過客戶端工具（SDK、CLI等）訪問API。細節請參見獲取AccessKey。
應用管理
| API | 標題 | API概述 |
|---|---|---|
| ModifyApp | 修改指定應用名稱 | 調用ModifyApp修改指定應用的名稱。 |
| DescribeApps | 查詢應用列表 | 調用DescribeApps查詢應用列表。 |
| DescribeAppKey | 查詢指定應用AppKey | 調用DescribeAppKey查詢指定應用的AppKey。 |
布局
| API | 標題 | API概述 |
|---|---|---|
| CreateAppLayout | 新增自定義布局 | 新增app自定義布局 |
| ModifyAppLayout | 修改自定義布局 | 修改app自定義布局 |
| DeleteAppLayout | 刪除自定義布局 | 刪除app自定義布局 |
| DescribeAppLayouts | 查詢自定義布局列表 | 查詢app自定義布局 |
| DescribeSystemLayoutList | 查詢系統內置布局列表 | 系統內置布局 |
回調管理
| API | 標題 | API概述 |
|---|---|---|
| DescribeAppCallStatus | 查詢應用回調狀態 | 查看app回調開關 |
| ModifyAppCallbackStatus | 修改應用回調狀態 | 更新app回調事件開關 |
| DescribeAllCallback | 系統回調支持的所有事件 | 列出系統支持的事件回調 |
| DescribeCallbacks | 查詢應用回調列表 | app事件回調列表 |
| DescribeAppCallbackSecretKey | 查詢回調密鑰 | 獲取app回調密鑰 |
| ModifyCallbackMeta | 修改應用回調 | 更新app回調 |
| StartCategoryCallback | 開啟某個事件回調 | 開啟某個事件回調 |
| StopCategoryCallback | 關閉某個事件回調 | 關閉某個事件回調 |
頻道管理
| API | 標題 | API概述 |
|---|---|---|
| DescribeChannels | 查詢在線頻道列表 | 本接口用于查詢單AppId下的全部進行中的頻道列表。 |
| StopChannel | 關閉頻道 | 本接口用于服務端主動關閉頻道。 |
| DescribeChannelAllUsers | 查詢頻道內在線用戶 | 本接口用于查詢頻道內的用戶列表。 |
| DescribeChannelUser | 查詢用戶在頻道內的信息 | 本接口用于查詢用戶在頻道內的信息。 |
| DescribeChannel | 查詢在線頻道信息 | 本接口用于查詢在線頻道信息。 |
| RemoveUsers | 踢出用戶 | 本接口用于踢出頻道內的用戶。 |
云端錄制
| API | 標題 | API概述 |
|---|---|---|
| 錄制模版管理 | 錄制模版管理 | |
| DescribeAppRecordStatus | 查詢錄制功能狀態 | 查詢應用錄制開關 |
| ModifyAppRecordStatus | 修改錄制功能狀態 | 修改應用錄制開關 |
| CreateAppRecordTemplate | 新增錄制模版 | 增加應用錄制模版 |
| ModifyAppRecordTemplate | 修改錄制模版 | 修改應用錄制模版 |
| DeleteAppRecordTemplate | 刪除錄制模版 | 刪除應用錄制模版 |
| DescribeAppRecordTemplates | 查詢錄制模版列表 | 應用錄制模版列表 |
| 云端錄制接口 | 云端錄制接口 | |
| DescribeAppRecordingFiles | 錄制文件列表 | 查詢錄制列表 |
| StartCloudRecord | 開始云端錄制任務 | 本接口用于開始云端錄制任務。 |
| UpdateCloudRecord | 更新云端錄制任務 | 更新云端錄制任務 |
| StopCloudRecord | 停止云端錄制任務 | 本接口用于停止云端錄制任務。 |
旁路轉推
| API | 標題 | API概述 |
|---|---|---|
| 推流模板管理 | 推流模板管理 | |
| DescribeAppLiveStreamStatus | 查詢旁路推流功能狀態 | 查看應用旁路開關 |
| ModifyAppLiveStreamStatus | 修改旁路推流功能狀態 | 修改應用旁路開關 |
| CreateAppStreamingOutTemplate | 創建推流模板 | 創建 RTC 3.0 應用推流模板。 |
| ModifyAppStreamingOutTemplate | 修改推流模板 | 修改 RTC 3.0 應用推流模板。 |
| DeleteAppStreamingOutTemplate | 刪除推流模板 | 刪除 RTC 3.0 應用推流模板。 |
| DescribeAppStreamingOutTemplates | 查詢推流模板列表 | 查詢 RTC 3.0 應用下的推流模板列表。 |
| 旁路推流接口 | 旁路推流接口 | |
| DescribeStreamingOutStatus | 查詢旁路推流狀態 | 查詢旁路推流狀態 |
| StartStreamingOut | 開始旁路推流任務 | 本接口用于開始旁路推流任務。 |
| UpdateStreamingOut | 更新旁路推流任務 | 更新旁路推流任務 |
| StopStreamingOut | 停止旁路推流任務 | 本接口用于停止旁路推流任務。 |
紀要
| API | 標題 | API概述 |
|---|---|---|
| StartCloudNote | 開始紀要任務 | 開啟智能紀要 |
| StartCloudNote | 開始紀要任務 | 開啟智能紀要 |
| StopCloudNote | 停止紀要任務 | 停止智能紀要 |
| DescribeCloudNotes | 紀要文件列表 | 紀要列表 |
數據服務
| API | 標題 | API概述 |
|---|---|---|
| 通信監測 | 通信監測 | |
| DescribeCallList | 分頁查詢時間范圍內通信信息 | 調用DescribeCallList分頁查詢時間范圍內創建的通信信息。 |
| DescribeCall | 查詢單次通信詳情 | 本接口用于查詢單次通信詳情。例如：您可以查詢通訊狀態、用戶詳情等信息。 |
| DescribePubUserListBySubUser | 訂閱端獲取通信中發布端用戶列表 | 本接口用于根據訂閱端獲取通信中發布端用戶列表。 |
| DescribeEndPointEventList | 獲取端對端用戶事件列表 | 本接口用于獲取端對端用戶事件列表。 |
| DescribeEndPointMetricData | 獲取端對端指標數據 | 本接口用于獲取端對端指標數據。 |
| DescribeQoeMetricData | 單次通信中下行體驗質量指標 | 本接口用于獲取單次通信中用戶的下行體驗質量指標。 |
| 頻道數據 | 頻道數據 | |
| DescribeChannelOverallData | 查詢頻道概覽數據 | 本接口用于查詢頻道概覽數據。 |
| DescribeChannelDistributionStatData | 獲取頻道分布統計數據 | 本接口用于獲取頻道分布統計數據。 |
| DescribeChannelAreaDistributionStatData | 獲取頻道地區分布統計數據 | 本接口用于獲取頻道地區分布統計數據。 |
| DescribeChannelTopPubUserList | 獲取頻道內發布端的用戶列表 | 本接口用于獲取頻道內發布端的用戶列表（按用戶在線時長降序）。 |
| DescribeChannelUserMetrics | 查詢頻道概覽中的用戶數據 | 本接口用于查詢頻道概覽中的用戶數據。 |
| 用量統計 | 用量統計 | |
| DescribeUsageOverallData | 獲取用量統計的概覽數據 | 本接口用于獲取用量統計的概覽數據。 |
| DescribeUsageDistributionStatData | 獲取用量統計的分布數據 | 本接口用于獲取用量統計的分布數據。 |
| DescribeUsageAreaDistributionStatData | 獲取用量統計的地域分布數據 | 本接口用于獲取用量統計的地域分布數據。 |
| DescribeUsageOsSdkVersionDistributionStatData | 用量操作系統及SDK版本分布 | 本接口用于獲取用量統計中各操作系統及SDK版本的分布數據。 |
| 質量統計 | 質量統計 | |
| DescribeQualityOverallData | 獲取質量統計的概覽數據 | 本接口用于獲取質量統計的概覽數據。 |
| DescribeQualityDistributionStatData | 獲取質量統計的分布數據 | 本接口用于獲取質量統計的分布數據。 |
| DescribeQualityAreaDistributionStatData | 獲取質量統計的地域分布數據 | 本接口用于獲取質量統計的地域分布數據。 |
| DescribeQualityOsSdkVersionDistributionStatData | 質量各操作系統及SDK版本分布 | 本接口用于獲取質量統計中各操作系統及SDK版本的分布數據。 |
| 異常診斷 | 異常診斷 | |
| DescribeFaultDiagnosisOverallData | 獲取異常診斷的概覽數據 | 調用DescribeFaultDiagnosisOverallData獲取異常診斷的概覽數據。 |
| DescribeFaultDiagnosisFactorDistributionStat | 獲取異常診斷的影響因素分布 | 調用DescribeFaultDiagnosisFactorDistributionStat獲取異常診斷的影響因素分布。 |
| DescribeFaultDiagnosisUserList | 獲取異常診斷的用戶明細列表 | 調用DescribeFaultDiagnosisUserList獲取異常診斷的用戶明細列表。 |
| DescribeFaultDiagnosisUserDetail | 獲取異常診斷的用戶詳情 | 調用DescribeFaultDiagnosisUserDetail獲取異常診斷的用戶詳情。 |