文档

API概览

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

发送语音通知

API标题API概述
SingleCallByVoice发送语音通知文件类型的语音通知调用接口给单个被叫号码发送语音通知文件类型的语音通知。

发送语音验证码

API标题API概述
SingleCallByTts发送语音验证码或文本转语音类型的语音通知调用接口给单个被叫号码发送语音验证码、文本转语音类型的语音通知、语音通知文件中带变量参数的语音通知。

语音通话任务

API标题API概述
CreateCallTask创建语音通话任务使用虚拟号码给多个被叫号码创建文本转语音任务、语音通知任务和语音验证码任务。
ListCallTask获取通话任务状态列表创建语音通话任务后,可以查看通话任务状态,包括:任务ID、任务当前状态、任务所选的模板信息等。
ExecuteCallTask执行语音通话任务执行通话任务。
ListCallTaskDetail获取通话任务详情列表执行完通话任务后根据任务ID,查看指定任务详情。

虚拟号码

API标题API概述
AddVirtualNumberRelation批量添加虚拟号码与真实号码绑定关系批量添加虚拟号码与真实号码绑定关系。
QueryVirtualNumber查询虚拟号码列表查询虚拟号码列表。
QueryVirtualNumberRelation查询虚拟号码与真实号码绑定关系列表查询虚拟号码与真实号码绑定后的数据列表,包括绑定真实号的时间,号码创建时间,一个虚拟号下绑定真实号的数量等。

查询语音文件审核状态

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号码呼转记录查询呼转记录。
ListHotlineTransferNumber获取400号码呼转列表获取备案的呼转号码列表。
SendVerification发送短信验证码发送短信验证码。

5G视频通话(邀约制)

API标题API概述
SingleCallByVideo发送视频通知调用接口给单个被叫号码发送语音文件通知或视频文件通知。
PlayVideoFile插播视频在语音通话中插播视频文件。
PauseVideoFile暂停视频在语音通话中插播视频文件时,暂停视频播放。
ResumeVideoFile恢复视频在语音通话中暂停视频播放后,恢复视频播放。
QueryVideoPlayProgress查询视频进度在语音通话中插播视频文件后,查询视频播放进度。
UpgradeVideoFile视频升级从语音通话升级到视频通话。
DegradeVideoFile视频降级从视频通话降级到语音通话。
SkipVideoFile快进或后退视频在播放视频时,可以调用此接口快进视频或后退视频。
GetCallMediaType获取通话类型在通话时获取通话类型。
GetTemporaryFileUrl获取文件临时URL获取视频或语音文件临时URL,方便您立即查看视频或语音文件。

获取认证Token

API标题API概述
GetToken获取认证的Token获取认证的Token。