合規檢測
查詢檢測規則、建立與追加檢測任務,取得任務進度和素材風險明細。
接入說明
合規檢測為擴展模塊。團隊需已開通合規檢測功能後,方可使用本組開放接口。推薦流程:查詢規則 → 創建任務開檢 → 輪詢任務概覽至完成 → 拉取素材明細。
- 基礎地址:
https://open.musedam.cc/api/muse - 鑒權:請求頭攜帶
Authorization: Bearer your_api_key。 - 請求格式:以下接口均使用
POST,請求體為 JSON,攜帶Content-Type: application/json。 - 表格中的響應描述指業務結果,外層響應格式見快速開始。
合規檢測規則列表
說明: 分頁查詢團隊合規檢測規則。未傳 releaseStatus 時默認只返回已發佈規則(2)。
接口路徑:/detection-rules
請求方式:POST
請求參數:EnterpriseDetectionRuleListReq
| 字段名 | 類型 | 必填 | 描述 |
|---|---|---|---|
| page | Integer | 否 | 頁碼,默認 1 |
| pageSize | Integer | 否 | 每頁條數,默認 10 |
| keyword | String | 否 | 規則名稱關鍵字 |
| createTimeSort | Integer | 否 | 創建時間排序:1 倒序,0 正序 |
| releaseStatus | Integer | 否 | 發佈狀態:1 未發佈,2 已發佈;不傳默認 2 |
| ids | List<Long> | 否 | 按規則 id 過濾 |
響應:EnterpriseDetectionRulePageDTO
| 字段名 | 類型 | 描述 |
|---|---|---|
| total | Long | 總數 |
| rules | List<EnterpriseDetectionRuleDTO> | 規則列表 |
rules 單項字段:
| 字段名 | 類型 | 描述 |
|---|---|---|
| id | Long | 規則 id |
| ruleName | String | 規則名稱 |
| ruleType | Integer | 規則類型:1 通用檢測 |
| ruleEventIds | String | 檢測渠道:sucai / ADLAW / REGIONAL_COMPLIANCE,逗號分隔 |
| regionalGreenServiceCodes | String | 地區合規綠網 serviceCode,逗號分隔 |
| releaseStatus | Integer | 1 未發佈 / 2 已發佈 |
| createTime | Date | 創建時間 |
| needEnterpriseRule | Integer | 是否需要企業規則:0 / 1 |
請求示例:
curl --location --request POST 'https://open.musedam.cc/api/muse/detection-rules' \--header 'Authorization: Bearer your_api_key' \--header 'Content-Type: application/json' \--data-raw '{"page": 1,"pageSize": 20}'
創建合規檢測任務
說明: 創建檢測任務並自動開檢。
接口路徑:/detection-task-create
請求方式:POST
請求參數:EnterpriseDetectionTaskCreateReq
| 字段名 | 類型 | 必填 | 描述 |
|---|---|---|---|
| taskName | String | 否 | 任務名稱 |
| taskDesc | String | 否 | 任務描述 |
| ruleId | Long | 是 | 檢測規則 id(建議使用已發佈規則) |
| assetIds | List<Long> | 條件 | 素材 materialId 列表(檢索或上傳返回的素材 ID);可與 groupIds / folderId 組合,最終素材不能為空 |
| groupIds | List<Long> | 條件 | 組合素材 id 列表 |
| folderId | Long | 否 | 大於 0 時按該文件夾下全部素材建任務(最多 3000 個素材) |
響應:Long(任務 id)
請求示例:
curl --location --request POST 'https://open.musedam.cc/api/muse/detection-task-create' \--header 'Authorization: Bearer your_api_key' \--header 'Content-Type: application/json' \--data-raw '{"taskName": "廣告素材合規抽檢","ruleId": 10001,"assetIds": [20001, 20002]}'
注意事項:
- 創建成功後服務端會自動觸發檢測。
assetIds傳 materialId(檢索或上傳返回的素材 ID)。
添加素材到檢測任務
說明: 向已有任務追加素材並續檢。已在任務中的素材不可重復添加。
接口路徑:/detection-task-add-assets
請求方式:POST
請求參數:EnterpriseDetectionTaskAddAssetsReq
| 字段名 | 類型 | 必填 | 描述 |
|---|---|---|---|
| taskId | Long | 是 | 檢測任務 id |
| assetIds | List<Long> | 條件 | 素材 materialId 列表;與 groupIds 至少一個有效 |
| groupIds | List<Long> | 條件 | 組合素材 id 列表 |
響應:Long(任務 id)
請求示例:
curl --location --request POST 'https://open.musedam.cc/api/muse/detection-task-add-assets' \--header 'Authorization: Bearer your_api_key' \--header 'Content-Type: application/json' \--data-raw '{"taskId": 30001,"assetIds": [20003, 20004]}'
注意事項:
- 同創建接口:
assetIds傳 materialId。
查詢合規檢測任務概覽
說明: 按任務 id 查詢任務狀態與風險匯總。創建任務後可輪詢本接口直至 taskStatus=4。
接口路徑:/detection-task-get
請求方式:POST
請求參數:EnterpriseDetectionTaskGetReq
| 字段名 | 類型 | 必填 | 描述 |
|---|---|---|---|
| taskId | Long | 是 | 檢測任務 id |
響應:EnterpriseDetectionTaskDTO
| 字段名 | 類型 | 描述 |
|---|---|---|
| taskId | Long | 任務 id |
| taskName | String | 任務名稱 |
| taskStatus | Integer | 1 排隊中 / 2 執行中 / 3 暫停 / 4 執行完成 |
| ruleId | Long | 規則 id |
| ruleName | String | 規則名稱 |
| agentId | String | 品牌合規智能體 id(可空) |
| agentName | String | 智能體名稱(可空) |
| taskSource | Integer | 0 手動 / 1 自動 |
| createTime | Date | 創建時間 |
| assetDetectionStatus | Integer | 匯總檢測狀態:0 未檢測 / 1 檢測中 / 2 檢測完成 / 3 檢測失敗 |
| taskAssetIdAllCount | Integer | 任務素材總數 |
| taskAssetIdCheckedCount | Integer | 已檢測素材數 |
| taskAssetIdPassCount | Integer | 通過數 |
| taskAssetIdReviewCount | Integer | 可疑(建議人工審核)數 |
| taskAssetIdRiskCount | Integer | 違規(建議攔截)數 |
請求示例:
curl --location --request POST 'https://open.musedam.cc/api/muse/detection-task-get' \--header 'Authorization: Bearer your_api_key' \--header 'Content-Type: application/json' \--data-raw '{"taskId": 30001}'
查詢合規檢測任務明細
說明: 分頁查詢任務內素材檢測明細。可選按開放側 materialId 過濾。
接口路徑:/detection-task-details
請求方式:POST
請求參數:EnterpriseDetectionTaskDetailsReq
| 字段名 | 類型 | 必填 | 描述 |
|---|---|---|---|
| taskId | Long | 是 | 檢測任務 id |
| page | Integer | 否 | 頁碼,默認 1 |
| pageSize | Integer | 否 | 每頁條數,默認 20 |
| materialId | Long | 否 | 開放側素材 id;傳入時僅返回該素材明細 |
響應:EnterpriseDetectionTaskDetailsPageDTO
| 字段名 | 類型 | 描述 |
|---|---|---|
| total | Long | 總數 |
| items | List<EnterpriseDetectionTaskAssetDetailDTO> | 明細列表 |
items 單項字段:
| 字段名 | 類型 | 描述 |
|---|---|---|
| materialId | Long | 開放側素材 id |
| materialName | String | 素材名稱 |
| size | Long | 文件大小(字節) |
| width | Integer | 寬度 |
| height | Integer | 高度 |
| duration | Long | 視頻時長(毫秒) |
| extension | String | 後綴 |
| batchId | String | 批次 id |
| bizType | Integer | 1 真實素材 / 2 待入庫 |
| detectionDetails | List<EnterpriseDetectionDetailDTO> | 各渠道檢測結果 |
detectionDetails 單項字段:
| 字段名 | 類型 | 描述 |
|---|---|---|
| eventId | String | 檢測渠道 |
| assetDetectionStatus | Integer | 0 未檢測 / 1 檢測中 / 2 檢測完成 |
| message | String | 信息 |
| code | Integer | 請求 code |
| riskLevelPassCount | Integer | 通過數 |
| riskLevelReviewCount | Integer | 可疑數 |
| riskLevelRejectCount | Integer | 違規數 |
| finishTime | Date | 完成時間 |
| assetDetectionAllResult | String | 完整結果原文 |
請求示例:
curl --location --request POST 'https://open.musedam.cc/api/muse/detection-task-details' \--header 'Authorization: Bearer your_api_key' \--header 'Content-Type: application/json' \--data-raw '{"taskId": 30001,"page": 1,"pageSize": 20,"materialId": 20001}'
注意事項:
materialId須為本團隊存在的素材;不存在時返回參數錯誤。- 推薦流程:
detection-task-create→ 輪詢detection-task-get至完成 →detection-task-details拉明細。