本產品（
機器學習PAI-用戶增長/2022-01-12）的OpenAPI采用ROA簽名風格，簽名細節參見簽名機制說明。我們已經為開發者封裝了常見編程語言的SDK，開發者可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由于自簽名細節非常復雜，需花費 5個工作日左右。因此建議加入我們的服務釘釘群（11370001915），在專家指導下進行簽名對接。在使用API前，您需要準備好身份賬號及訪問密鑰（AccessKey），才能有效通過客戶端工具（SDK、CLI等）訪問API。細節請參見獲取AccessKey。
基本信息
| API | 標題 | API概述 |
|---|---|---|
| GetUser | 獲取基本信息 | 獲取用戶產品狀態等基本信息。 |
| GetMessageConfig | 獲取短信配置 | 獲取用戶短信配置，如回執接口，上行短信接口等。 |
短信簽名
| API | 標題 | API概述 |
|---|---|---|
| CreateSignature | 注冊簽名 | 發起注冊簽名請求，可通過控制臺或GetSignature查看簽名審核狀態。 |
| DeleteSignature | 刪除簽名 | 刪除簽名。 |
| ListSignatures | 獲取簽名列表 | 獲取簽名注冊記錄列表。 |
| GetSignature | 獲取簽名詳情 | 獲取簽名的詳細信息。 |
短信模板
| API | 標題 | API概述 |
|---|---|---|
| CreateTemplate | 注冊模板 | 調用CreateTemplate來創建模板。 |
| DeleteTemplate | 刪除模板 | 刪除短信模板。 |
| ListTemplates | 獲取模板列表 | 獲取模板注冊記錄列表。 |
| GetTemplate | 獲取模板詳情 | 獲取模板詳細內容。 |
發送短信
| API | 標題 | API概述 |
|---|---|---|
| SendMessage | 發送短信 | 發送短信，使用前須注冊簽名和模板。 |
| ListMessages | 獲取短信列表 | 按指定過濾條件獲取指定日期的短信發送狀態。 |
| ListMessageMetrics | 獲取短信發送統計 | 獲取短信發送統計數據，可按指定條件獲取分類別詳細數據。 |
短信回執
| API | 標題 | API概述 |
|---|---|---|
| SmsReport | 回執接口定義 | 短信發送狀態報告接口定義。 |
| SmsUp | 上行接口定義 | 上行短信消息接口定義。 |
| UpdateReportUrl | 更新回執地址 | 更新短信發送狀態回執接收服務地址。 |
| UpdateUploadUrl | 更新上行地址 | 更新上行信息接收服務地址。 |
運營活動
| API | 標題 | API概述 |
|---|---|---|
| CreateCampaign | 創建運營活動 | 創建運營活動。 |
| DeleteCampaign | 刪除運營活動 | 刪除運營活動。 |
| ListCampaigns | 獲取運營活動列表 | 獲取運營活動列表。 |
| GetCampaign | 獲取運營活動詳情 | 獲取運營活動詳細內容。 |
| UpdateCampaign | 更新運營活動 | 更新運營活動名稱和備注。 |
算法任務
| API | 標題 | API概述 |
|---|---|---|
| ListAlgorithms | 獲取算法列表 | 獲取當前可用算法列表。 |
| GetAlgorithm | 獲取算法詳情 | 獲取算法詳細參數信息。 |
| CreateTrainingJob | 創建訓練任務 | 創建訓練任務。 |
| DeleteTrainingJob | 刪除訓練任務 | 刪除訓練任務。 |
| ListTrainingJobs | 獲取訓練任務列表 | 獲取訓練任務列表。 |
| GetTrainingJob | 獲取訓練任務詳情 | 獲取訓練任務詳情。 |
| CreateInferenceJob | 創建預測任務 | 創建預測任務。 |
| DeleteInferenceJob | 刪除預測任務 | 刪除預測任務。 |
| ListInferenceJobs | 獲取預測任務列表 | 獲取預測任務列表。 |
| GetInferenceJob | 獲取預測任務詳情 | 獲取預測任務詳情。 |
人群管理
| API | 標題 | API概述 |
|---|---|---|
| CreateGroup | 創建人群 | 創建人群。 |
| DeleteGroup | 刪除人群 | 刪除人群。 |
| ListGroups | 獲取人群列表 | 獲取人群列表。 |
| GetGroup | 獲取人群詳情 | 獲取人群詳情。 |
發送計劃
| API | 標題 | API概述 |
|---|---|---|
| CreateSchedule | 創建觸達計劃 | 創建觸達計劃。 |
| DeleteSchedule | 刪除發送計劃 | 刪除發送計劃。 |
| ListSchedules | 獲取發送計劃列表 | 獲取發送計劃列表。 |
| GetSchedule | 獲取發送計劃詳情 | 獲取發送計劃詳情。 |