API标准及多语言预置SDK
本产品（云通信语音服务/2017-05-25）的 OpenAPI 采用 RPC 签名机制，具体签名方式请参见签名机制说明。我们已为开发者封装了主流编程语言的 SDK，您可通过 下载 SDK 快速调用 API，无需关注签名等底层实现细节，显著降低开发门槛与集成复杂度。自定义签名场景
若您的业务场景有特殊需求，需通过自签名方式对接 API，建议优先咨询我们的技术支持团队（服务钉钉群：147535001692），获取专业指导以确保高效接入。
账号与安全准备
阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露，所有相关资源都将面临未经授权访问的风险。为确保安全，建议创建一个仅具备 API 访问权限的 RAM 用户并配置其 AccessKey，同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下，才使用阿里云账号。
发送语音通知
| API | 标题 | API概述 |
|---|---|---|
| SingleCallByVoice | 发送语音通知文件类型的语音通知 | 调用接口给单个被叫号码发送语音通知文件类型的语音通知。 |
发送语音验证码
| API | 标题 | API概述 |
|---|---|---|
| SingleCallByTts | 发送语音验证码或文本转语音类型的语音通知 | 调用接口给单个被叫号码发送语音验证码或文本转语音类型的语音通知。 |
语音通话任务
| API | 标题 | API概述 |
|---|---|---|
| CreateCallTask | 创建语音通话任务 | 使用服务实例给多个被叫号码创建文本转语音任务、语音通知任务和语音验证码任务。 |
| ListCallTask | 获取通话任务状态列表 | 创建语音通话任务后，可以查看通话任务状态，包括：任务ID、任务当前状态、任务所选的模板信息等。 |
| ExecuteCallTask | 执行语音通话任务 | 执行通话任务。 |
| ListCallTaskDetail | 获取通话任务详情列表 | 执行完通话任务后根据任务ID，查看指定任务详情。 |
服务实例
| API | 标题 | API概述 |
|---|---|---|
| AddVirtualNumberRelation | 批量添加服务实例与真实号码绑定关系 | 批量添加服务实例与真实号码绑定关系。 |
| QueryVirtualNumberRelation | 查询服务实例与真实号码绑定关系列表 | 查询服务实例与真实号码绑定后的数据列表，包括绑定真实号的时间，号码创建时间，某个服务实例下绑定真实号的数量等。 |
| ListServiceInstanceForPage | 分页查询服务实例列表 |
查询语音文件审核状态
| API | 标题 | API概述 |
|---|---|---|
| QueryVoiceFileAuditInfo | 查询语音文件审核状态 | 查询语音文件审核状态。 |
查询呼叫详情
| API | 标题 | API概述 |
|---|---|---|
| QueryCallDetailByCallId | 查询指定通话的呼叫详情 | 根据指定通话任务返回的CallID查询呼叫详情，包括通话开始时间、通话时长、通话状态、通话结束时间、被叫号码等详情。 |
交互式语音通话
| API | 标题 | API概述 |
|---|---|---|
| IvrCall | 向指定号码发起交互式语音通话 | 向指定号码发起交互式语音通话。 |
智能语音交互通话
| API | 标题 | API概述 |
|---|---|---|
| SmartCall | 发起智能语音交互通话 | 智能语音交互服务，是一种人机交互技术，它允许用户通过语音与机器进行自然的对话和沟通。 |
| SmartCallOperate | 发起智能语音指定动作 | 在智能外呼通话中发起指定动作，仅用于并行转人工、人工坐席可旁听人机对话等场景。 |
智能语音机器人
| API | 标题 | API概述 |
|---|---|---|
| CreateRobotTask | 发起智能语音机器人外呼任务 | 发起智能语音机器人外呼任务。 |
| BatchRobotSmartCall | 批量发起智能语音机器人外呼任务 | 批量发起智能语音机器人外呼任务，一次任务支持设置1~100个号码。 |
| StartRobotTask | 启动任务或定时启动任务 | 启动智能语音任务或者定时启动智能语音任务。 |
| StopRobotTask | 暂停智能语音任务 | 暂停开始执行后的智能语音任务。 |
| CancelOrderRobotTask | 取消智能语音任务 | 取消还未启动的定时智能语音任务。 |
| CancelRobotTask | 终止智能语音任务 | 终止智能语音任务。 |
| DeleteRobotTask | 删除智能语音任务 | 删除智能语音任务。 |
| QueryRobotv2AllList | 获取全部机器人话术模板列表 | 获取全部机器人话术模板列表。 |
| QueryRobotTaskList | 获取所有任务ID | 获取所有语音任务信息。 |
| QueryCallDetailByTaskId | 查看指定机器人外呼任务的话单详情 | 查看指定机器人外呼任务的话单详情。 |
| QueryRobotTaskDetail | 获取智能语音任务详情 | 获取指定智能语音任务详情。 |
| QueryRobotTaskCallList | 查询任务内执行条目列表 | 查询指定任务内执行条目列表。 |
| QueryRobotInfoList | 查询智能语音机器人列表 | 查看智能语音机器人列表，获取机器人详细信息。 |
| QueryRobotTaskCallDetail | 查询智能机器人任务执行详情 | 获取单个执行条目即单个被叫号码的任务明细。 |
| UploadRobotTaskCalledFile | 上传智能语音的被叫号码 | 上传智能语音任务的被叫号码。 |
400号码
| API | 标题 | API概述 |
|---|---|---|
| GetHotlineQualificationByOrder | 获取400号码资质ID | 通过资质申请工单号获取400号码的资质ID。 |
| ListHotlineTransferRegisterFile | 获取号码备案信息 | 通过SubmitHotlineTransferRegister接口提交备案信息后，通过此接口获取号码备案信息。 |
| SubmitHotlineTransferRegister | 提交号码备案 | 您在设置400号码转呼号码前，需要对转呼的号码提交号码备案。 |
| SetTransferCalleePoolConfig | 设置400号码呼转 | 为400号码设置转呼号码。 |
| QueryCallInPoolTransferConfig | 查询400号码呼转配置详情 | 设置400号码转呼后，通过此接口查询400号码呼转配置详情。 |
| QueryCallInTransferRecord | 查询400号码呼转记录 | 查询呼转记录。 |
| SendVerification | 发送短信验证码 | 发送短信验证码。 |
5G视频通话（邀约制）
| API | 标题 | API概述 |
|---|---|---|
| SingleCallByVideo | 发送视频通知 | 调用接口给单个被叫号码发送语音文件通知或视频文件通知。 |
| PlayVideoFile | 插播视频 | 在语音通话中插播视频文件。 |
| PauseVideoFile | 暂停视频 | 在语音通话中插播视频文件时，暂停视频播放。 |
| ResumeVideoFile | 恢复视频 | 在语音通话中暂停视频播放后，恢复视频播放。 |
| QueryVideoPlayProgress | 查询视频进度 | 在语音通话中插播视频文件后，查询视频播放进度。 |
| UpgradeVideoFile | 视频升级 | 从语音通话升级到视频通话。 |
| DegradeVideoFile | 视频降级 | 从视频通话降级到语音通话。 |
| SkipVideoFile | 快进或后退视频 | 在播放视频时，可以调用此接口快进视频或后退视频。 |
| GetCallMediaType | 获取通话类型 | 在通话时获取通话类型。 |
| GetTemporaryFileUrl | 获取文件临时URL | 获取视频或语音文件临时URL，方便您立即查看视频或语音文件。 |
获取认证Token
| API | 标题 | API概述 |
|---|---|---|
| GetToken | 获取认证的Token | 获取认证的Token。 |
其他
| API | 标题 | API概述 |
|---|---|---|
| CancelCall | 取消语音双呼 | 调用CancelCall接口取消ClickToDial发起的语音双呼。 |
| QueryVmsVirtualNumberRelationByPage | 查询虚拟号码与真实号码绑定关系列表 | |
| QueryVmsRealNumberCallConnectionRateInfo | 查询真实号接通率 |