API标准及多语言预置SDK
本产品（PaiPlugin/2022-01-12）的OpenAPI采用ROA签名风格。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
自定义签名场景
若您的业务场景有特殊需求，需通过自签名方式对接 API，建议优先咨询我们的技术支持团队（服务钉钉群：147535001692），获取专业指导以确保高效接入。
账号与安全准备
阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露，所有相关资源都将面临未经授权访问的风险。为确保安全，建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey，同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下，才使用阿里云账号。
基本信息
|
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概述 |
| 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 | 获取发送计划详情 | 获取发送计划详细信息，包括计划时间、内容、状态等。 |
该文章对您有帮助吗？