文档

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发起智能语音机器人外呼任务发起智能语音机器人外呼任务。
DeleteRobotTask删除智能语音任务删除智能语音任务。
StartRobotTask启动任务或定时启动任务启动智能语音任务或者定时启动智能语音任务。
StopRobotTask暂停智能语音任务暂停开始执行后的智能语音任务。
QueryRobotv2AllList获取全部机器人话术模板列表获取全部机器人话术模板列表。
QueryRobotTaskList获取所有任务ID获取所有语音任务信息。
QueryCallDetailByTaskId查看指定机器人外呼任务的话单详情查看指定机器人外呼任务的话单详情。
QueryRobotTaskDetail获取智能语音任务详情获取指定智能语音任务详情。
QueryRobotTaskCallList查询任务内执行条目列表查询指定任务内执行条目列表。
QueryRobotInfoList查看机器人列表查看机器人列表。
QueryRobotTaskCallDetail获取执行条目明细获取任务内单个执行条目(单个被叫号码)的明细。
UploadRobotTaskCalledFile上传智能语音的被叫号码上传智能语音任务的被叫号码。
CancelOrderRobotTask取消智能语音任务取消还未启动的定时智能语音任务。
CancelRobotTask终止智能语音任务终止智能语音任务。
BatchRobotSmartCall发起机器人外呼任务发起机器人外呼任务。

400开头的号码转呼

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

获取认证Token

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

5G新通话

API标题API概述
PlayVideoFile播放视频调用接口进行视频播放的操作。
PauseVideoFile暂停视频调用接口进行视频暂停的操作。
ResumeVideoFile恢复视频调用接口进行视频恢复的操作。
SingleCallByVideo视频通知调用接口发送视频通知。
QueryVideoPlayProgress查询视频进度调用接口查询视频进度。
UpgradeVideoFile视频升级调用接口进行视频升级的操作。
DegradeVideoFile视频降级从支持语音和视频的多媒体通信降级为只支持语音的语音电话通信。
SkipVideoFile视频跳转调用接口进行视频跳转的操作。
GetCallMediaType获取呼叫媒体类型调用接口获取呼叫媒体类型。
GetTemporaryFileUrl获取文件临时URL调用接口获取文件临时URL。
  • 本页导读 (1)