本产品(
云通信语音服务/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概述 |
---|---|---|
AddVirtualNumberRelation | 批量添加虚拟号码与真实号码绑定关系 | 批量添加虚拟号码与真实号码绑定关系。 |
QueryVirtualNumber | 查询虚拟号码列表 | 查询虚拟号码列表。 |
QueryVirtualNumberRelation | 查询虚拟号码与真实号码绑定关系列表 | 查询虚拟号码与真实号码绑定关系列表。 |
任务
API | 标题 | API概述 |
---|---|---|
CreateCallTask | 创建通话任务 | 创建发送任务。 |
ListCallTask | 获取通话任务 | 获取任务信息。 |
ListCallTaskDetail | 获取通话任务细节列表 | 根据任务ID获取指定任务信息。 |
ExecuteCallTask | 执行通话任务 | 执行通话任务。 |
语音IVR
API | 标题 | API概述 |
---|---|---|
IvrCall | 向指定号码发起交互式语音通话 | 向指定号码发起交互式语音通话。 |
智能语音交互
API | 标题 | API概述 |
---|---|---|
SmartCall | 发起智能语音交互通话 | 发起智能语音交互通话。 |
SmartCallOperate | 发起智能语音指定动作 | 在智能外呼通话中发起指定动作,仅用于并行转人工、人工坐席可旁听人机对话等场景。 |
呼叫记录查询
API | 标题 | API概述 |
---|---|---|
QueryCallDetailByCallId | 查询指定通话的呼叫详情 | 查询指定通话的呼叫详情。 |
智能语音机器人
API | 标题 | API概述 |
---|---|---|
CreateRobotTask | 发起智能语音机器人外呼任务 | 发起智能语音机器人外呼任务。 |
DeleteRobotTask | 删除智能语音任务 | 删除智能语音任务。 |
StartRobotTask | 启动任务或定时启动任务 | 启动智能语音任务或者定时启动智能语音任务。 |
StopRobotTask | 暂停智能语音任务 | 暂停开始执行后的智能语音任务。 |
QueryRobotv2AllList | 获取全部机器人话术模板列表 | 获取全部机器人话术模板列表。 |
QueryRobotTaskList | 获取所有任务ID | 获取所有语音任务信息。 |
QueryCallDetailByTaskId | 查看指定机器人外呼任务的话单详情 | 查看指定机器人外呼任务的话单详情。 |
QueryRobotTaskDetail | 获取智能语音任务详情 | 获取指定智能语音任务详情。 |
QueryRobotTaskCallList | 查询任务内执行条目列表 | 查询指定任务内执行条目列表。 |
QueryRobotInfoList | 查看机器人列表 | 查看机器人列表。 |
QueryRobotTaskCallDetail | 获取执行条目明细 | 获取任务内单个执行条目(单个被叫号码)的明细。 |
UploadRobotTaskCalledFile | 上传智能语音的被叫号码 | 上传智能语音任务的被叫号码。 |
CancelOrderRobotTask | 取消智能语音任务 | 取消还未启动的定时智能语音任务。 |
CancelRobotTask | 终止智能语音任务 | 终止智能语音任务。 |
BatchRobotSmartCall | 发起机器人外呼任务 | 发起机器人外呼任务。 |
400号码备案
API | 标题 | API概述 |
---|---|---|
SetTransferCalleePoolConfig | 设置呼转号码 | 设置呼转号码。 |
ListHotlineTransferRegisterFile | 获取400号码备案信息 | 获取400号码备案信息。 |
GetHotlineQualificationByOrder | 通过资质申请工单号获取资质ID | 通过资质申请工单号获取资质ID。 |
ListHotlineTransferNumber | 获取备案的呼转号码列表 | 获取备案的呼转号码列表。 |
QueryCallInPoolTransferConfig | 查询呼转号码配置 | 查询呼转号码配置。 |
QueryCallInTransferRecord | 查询呼转记录 | 查询呼转记录。 |
SendVerification | 发送短信验证码 | 发送短信验证码。 |
SubmitHotlineTransferRegister | 提交400号码备案 | 提交400号码备案。 |
获取认证Token
API | 标题 | API概述 |
---|---|---|
GetToken | 获取认证的Token | 获取认证的Token。 |
审核状态查询
API | 标题 | API概述 |
---|---|---|
QueryVoiceFileAuditInfo | 查询语音文件审核状态 | 查询语音文件审核状态。 |