API标准及多语言预置SDK
本产品(OutboundBot/2025-11-11)的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(147535001692),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey。
自定义签名场景
若您的业务场景有特殊需求,需通过自签名方式对接 API,建议优先咨询我们的技术支持团队(服务钉钉群:147535001692),获取专业指导以确保高效接入。
账号与安全准备
阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露,所有相关资源都将面临未经授权访问的风险。为确保安全,建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey,同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下,才使用阿里云账号。
场景管理
|
API |
标题 |
API概述 |
| UpdateScriptVersion | 更新场景版本 | 更新场景配置。 |
| UpdateScript | 更新场景 | 更新实例。 |
| PublishScript | 场景发布 | 更新实例。 |
| ListScriptsByFlow | 获取流程绑定的场景列表 | 根据流程ID获取场景列表。 |
| ListScripts | 获取场景列表 | 获取实例详情。 |
| ListScriptProfileTemplates | 获取场景模版列表 | 获取场景配置模板列表。 |
| GetScriptProfileTemplate | 获取场景模版 | 获取prompt场景模版。 |
| DeleteScript | 删除场景 | 删除场景。 |
| CreateScriptVersion | 创建场景版本 | 创建场景配置。 |
| CreateScript | 创建场景 | 创建实例。 |
声音克隆
|
API |
标题 |
API概述 |
| UpdateCloneVoice | 更新克隆音 | 更新实例。 |
| ListCloneVoices | 获取克隆音列表 | 获取克隆音色列表。 |
| ListCloneVoiceModels | 获取克隆音模型列表 | 获取克隆音色可用模型列表。 |
| DeleteCloneVoice | 删除克隆音 | 删除场景。 |
| CreateCloneVoice | 创建克隆音 | 创建实例。 |
系统配置
|
API |
标题 |
API概述 |
| UpdateSystemConfigs | 更新系统配置 | 更新系统配置。 |
| ListSystemConfigs | 获取系统配置列表 | 获取系统配置列表。 |
第三方语音配置
|
API |
标题 |
API概述 |
| UpdateVoiceAccessProfile | 更新三方语音配置 | 更新实例。 |
| ListVoiceAccessProfiles | 获取三方语音配置列表 | 获取语音接入配置列表。 |
| DeleteVoiceAccessProfile | 删除三方语音配置 | 删除三方语音配置。 |
| CreateVoiceAccessProfile | 创建三方语音配置 | 创建实例。 |
事件推送
|
API |
标题 |
API概述 |
| UpdateSubscription | 更新事件推送配置 | 创建或更新MQ配置。 |
| GetSubscription | 获取事件推送配置 | 获取MQ配置。 |
| DisableSubscription | 关闭事件推送 | 禁用消息订阅 |
闪信
|
API |
标题 |
API概述 |
| UpdateFlashSmsAccessProfile | 更新闪信配置 | 更新闪信配置。 |
| ListFlashSmsTemplates | 获取闪信模版 | 获取闪信模版。 |
| ListFlashSmsProviders | 获取闪信供应商列表 | 获取闪信厂商列表。 |
| ListFlashSmsAccessProfiles | 获取闪信列表 | 获取闪信配置列表。 |
| DeleteFlashSmsAccessProfile | 删除闪信配置 | 删除闪信配置。 |
| CreateFlashSmsAccessProfile | 创建闪信配置 | 创建闪信配置。 |
外呼黑白名单
|
API |
标题 |
API概述 |
| ListOutboundCallRestrictions | 获取外呼黑白名单列表 | 获取黑白名单列表。 |
| DeleteOutboundCallRestriction | 删除外呼黑白名单 | 删除黑白名单。 |
| CreateOutboundCallRestriction | 创建外呼黑白名单 | 创建实例。 |
实例管理
|
API |
标题 |
API概述 |
| CreateInstance | 创建实例 | 创建实例。 |
| DeleteInstance | 删除实例 | 获取实例详情。 |
| UpdateInstance | 更新实例 | 更新实例。 |
| ListInstances | 获取实例列表 | 获取实例详情。 |
| GetInstance | 获取实例详情 | 获取实例详情。 |
报表
|
API |
标题 |
API概述 |
| ListCases | 获取案件列表 | 获取案件列表 |
| GetCaseDetail | 获取案件详情 | 获取案件详情 |
| GetCallDetailRecord | 获取通话详情 | 获取通话详情 |
任务
|
API |
标题 |
API概述 |
| CreateCampaign | 创建外呼任务 | 创建外呼活动。 |
| SubmitCampaign | 提交任务 | 提交外呼活动。 |
| PauseCampaign | 暂停任务 | 暂停外呼活动。 |
| ResumeCampaign | 恢复任务 | 恢复外呼活动。 |
| AbortCampaign | 取消外呼任务 | 终止外呼活动。 |
| AppendCases | 追加联系人 | 追加外呼案件 |
| AbortCases | 取消联系人呼叫 | 终止外呼案件 |
| ListCampaigns | 外呼任务列表 | 获取外呼活动列表。 |
| GetCampaign | 获取任务信息 | 获取外呼活动详情。 |
该文章对您有帮助吗?