API概览

本产品(云通信语音服务/2017-05-25)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

语音通知

API标题API概述
SingleCallByVoice向指定号码发送语音通知文件类型的语音通知调用SingleCallByVoice接口向指定号码发送语音通知文件类型的语音通知。

语音验证码

API标题API概述
SingleCallByTts向指定号码发送语音验证码或文本转语音类型的语音通知调用SingleCallByTts接口向指定号码发送语音验证码或带变量的语音通知。

虚拟号码

API标题API概述
AddVirtualNumberRelation批量添加虚拟号码与真实号码绑定关系调用AddVirtualNumberRelation接口批量添加虚拟号码与真实号码绑定关系。
QueryVirtualNumber查询虚拟号码列表调用QueryVirtualNumber接口查询虚拟号码列表。
QueryVirtualNumberRelation查询虚拟号码与真实号码绑定关系列表调用QueryVirtualNumberRelation接口查询虚拟号码与真实号码绑定关系列表。

任务

API标题API概述
CreateCallTask创建通话任务调用CreateCallTask接口创建发送任务。
ListCallTask获取通话任务调用ListCallTask接口获取任务信息。
ListCallTaskDetail获取通话任务细节列表调用ListCallTaskDetail接口根据任务ID获取指定任务信息。
ExecuteCallTask执行通话任务调用ExecuteCallTask接口启动任务。

语音IVR

API标题API概述
IvrCall向指定号码发起交互式语音通话向指定号码发起交互式语音通话。

智能语音交互呼出

API标题API概述
SmartCall发起智能语音交互通话调用SmartCall接口发起智能语音交互通话。
SmartCallOperate发起智能语音指定动作调用SmartCallOperate接口在智能外呼通话中发起指定动作,仅用于并行转人工、人工坐席可旁听人机对话等场景。

呼叫记录查询

API标题API概述
QueryCallDetailByCallId查询指定通话的呼叫详情调用接口QueryCallDetailByCallId查询指定通话的呼叫详情。此接口为通用查询接口,可查询语音通知、语音验证码、语音IVR、语音双呼、智能语音交互呼入、智能语音交互呼出、智能外呼机器人呼叫记录。

智能语音机器人

API标题API概述
CreateRobotTask发起智能语音机器人外呼任务调用CreateRobotTask接口发起智能语音机器人外呼任务。本接口用于直接使用控制台预设的机器人话术发起机器人外呼任务。
DeleteRobotTask删除智能语音任务调用DeleteRobotTask接口删除智能语音任务。
StartRobotTask启动任务或定时启动任务调用StartRobotTask接口启动智能语音任务或者定时启动智能语音任务。
StopRobotTask暂停智能语音任务调用StopRobotTask接口暂停开始执行后的智能语音任务。
QueryRobotv2AllList获取全部机器人话术模板列表调用QueryRobotv2AllList接口获取全部机器人话术模板列表。
QueryRobotTaskList获取所有任务ID调用QueryRobotTaskList获取所有语音任务信息。
QueryCallDetailByTaskId查看指定机器人外呼任务的话单详情调用QueryCallDetailByTaskId接口查看指定机器人外呼任务的话单详情。
QueryRobotTaskDetail获取智能语音任务详情调用QueryRobotTaskDetail接口获取指定智能语音任务详情。
QueryRobotTaskCallList查询任务内执行条目列表调用QueryRobotTaskCallList接口查询指定任务内执行条目列表。
QueryRobotInfoList查看机器人列表调用QueryRobotInfoList接口查看机器人列表。
QueryRobotTaskCallDetail获取执行条目明细调用QueryRobotTaskCallDetail接口获取任务内单个执行条目(单个被叫号码)的明细。
UploadRobotTaskCalledFile上传智能语音的被叫号码调用UploadRobotTaskCalledFile接口上传智能语音任务的被叫号码。
CancelOrderRobotTask取消智能语音任务调用CancelOrderRobotTask接口取消还未启动的定时智能语音任务。
CancelRobotTask终止智能语音任务调用CancelRobotTask接口终止智能语音任务。
BatchRobotSmartCall发起机器人外呼任务调用BatchRobotSmartCall接口发起机器人外呼任务。此接口用于直接使用控制台预设的机器人话术,发起机器人外呼任务。

400号码备案

API标题API概述
SetTransferCalleePoolConfig设置呼转号码调用SetTransferCalleePoolConfig接口设置呼转号码。
ListHotlineTransferRegisterFile获取400号码备案信息调用ListHotlineTransferRegisterFile接口获取400号码备案信息。
GetHotlineQualificationByOrder通过资质申请工单号获取资质ID调用GetHotlineQualificationByOrder通过资质申请工单号获取资质ID。
ListHotlineTransferNumber获取备案的呼转号码列表调用ListHotlineTransferNumber接口获取备案的呼转号码列表。
QueryCallInPoolTransferConfig查询呼转号码配置调用QueryCallInPoolTransferConfig查询呼转号码配置。
QueryCallInTransferRecord查询呼转记录查询呼转记录。
SendVerification发送短信验证码调用SendVerification发送短信验证码。
SubmitHotlineTransferRegister提交400号码备案调用SubmitHotlineTransferRegister接口提交400号码备案。

获取认证Token

API标题API概述
GetToken获取认证的Token调用GetToken接口获取认证的Token。

审核状态查询

API标题API概述
QueryVoiceFileAuditInfo查询语音文件审核状态调用QueryVoiceFileAuditInfo接口根据语音文件ID查询语音文件审核状态。

融合通信

API标题API概述
AddRtcAccount创建RTC账号调用AddRtcAccount创建融合通信账号。
GetRtcToken获取RTC Token调用GetRtcToken接口获取融合通信RTC Token。
GetCallInfo获取融合通信通话信息调用GetCallInfo接口获取融合通信通话信息。
GetMqttToken获取MQTT Token获取MQTT(消息队列遥测传输协议)Token。
RefreshMqttToken刷新MQTT Token调用RefreshMqttToken接口刷新MQTT Token。

400号码呼转设置

API标题API概述
RecoverCallInConfig400呼转号码恢复呼入调用RecoverCallInConfig恢复指定400呼转号码呼入。
StopCallInConfig400呼转号码停止呼入调用StopCallInConfig接口停止指定400呼转号码呼入。
阿里云首页 语音服务 相关技术圈