文档

API概览

更新时间:
本产品(机器学习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获取发送计划详情获取发送计划详情。