You need to enable JavaScript to run this app.
导航

API概览

最近更新时间2023.03.29 18:25:43

首次发布时间2021.06.17 10:45:21

本文汇总语音服务提供的open api接口列表,以及对应sdk地址等信息

1. 服务接入

1.1 Open API服务地址

https://cloud-vms.volcengineapi.com

1.2 SDK地址

语言地址
phphttps://github.com/volcengine/volc-sdk-php
pythonhttps://github.com/volcengine/volc-sdk-python
gohttps://github.com/volcengine/volc-sdk-golang
javahttps://github.com/volcengine/volc-sdk-java
2. 接口列表

2.1 隐私号相关

针对不同的业务场景,在不增加SIM卡的情况下,为企业用户或员工增加隐私号码;使其在隐藏真实号码的同时,享受优质的通话和短信服务。

2.1.1 通用

API概述
错误码隐私号功能通用错误码
QuerySubscription查询绑定关系根据绑定关系id查询绑定关系,隐私号服务通用接口
QuerySubscriptionForList查询绑定关系列表根据绑定关系id查询绑定关系,隐私号服务通用接口

2.1.2 AX/AXB

API名称概述
BindAXBAX&AXB绑定(指定X号码)支持新增AX、AXB绑定关系(需指定X号码)
SelectNumberAndBindAXBAX&AXB绑定(平台选号)支持新增AX、AXB绑定关系(根据限制条件选定X号码)
UpgradeAXToAXBAX升级AXB关系支持AX关系升级为AXB关系
UpdateAXBAX&AXB更新支持修改AX、AXB关系的过期时间
UnbindAXBAX&AXB解绑支持解绑AX、AXB关系

2.1.3 AXN

API名称概述
BindAXNAXN绑定(指定号码)支持新增AXN绑定关系(需指定X号码)
SelectNumberAndBindAXNAXN绑定(平台选号)支持新增AXN绑定关系(根据限制条件选定X号码)
UnbindAXNAXN关系解绑支持解绑AXN绑定关系
UpdateAXNAXN关系更新B号码支持更新AXN关系里的B号码

2.1.4 AXNE

API名称概述
BindAXNEAXNE绑定支持新增AXNE(分机号)绑定关系
UnbindAXNEAXNE解绑支持解绑AXNE(分机号)绑定关系
UpdateAXNEAXNE更新支持更新AXNE关系里的B号码,或者修改绑定关系的过期时间
BindAXBForAXNEAXNE中AXB绑定创建AXNE绑定关系的子AXB绑定关系

2.1.6 AXYB

API名称概述
BindAXYBAXYB绑定支持新增绑定AXYB绑定关系
BindYBForAXYBAXYB中YB绑定支持新增AXYB中的YB绑定关系
UpdateAXYBAXYB更新支持更新AXYB关系中的绑定号码,Userdata或者修改绑定关系的过期时间
UnbindAXYBAXYB解绑支持解绑AXYB绑定关系

2.2 语音通知

用户向指定号码发起一通呼叫,被叫应答后,播放一段指定的音频。支持通过TTS(文本转语音)播放,也支持直接播放录音文件。

2.2.1 通用

API概述
公共数据结构公共返回结构、PhoneParam、ForbidTimeItem结构

2.2.2 任务管理

API名称概述
CreateTask创建任务支持创建语音通知任务
BatchAppend添加号码支持向已创建的语音通话任务添加被叫号码
PauseTask暂停任务支持暂停已创建的语音通知任务
ResumeTask恢复任务支持恢复暂停中的语音通知任务
StopTask终止任务支持终止语音通知任务
UpdateTask更新任务支持更新语音通知任务的执行时间、重呼设置等
并发量并发量释义和影响因素
任务管理错误码语音通知-任务管理相关接口错误码

2.2.3 单次发送语音通知

API名称概述
SingleBatchAppend创建单次发送任务支持创建单次语音通知任务
SingleInfo获取详情支持查询单次语音通知任务的状态和呼叫详情
SingleCancel取消单次发送支持取消单次语音通知任务
错误码单次发送语音通知相关接口错误码

2.2.4 语音资源管理

API名称概述
OpenUploadResource上传语音资源支持上传语音资源文件
OpenUpdateResource修改语音资源支持修改语音资源文件名称
OpenDeleteResource删除语音资源支持删除语音资源文件
QueryUsableResource获取可用语音资源支持获取可用语音资源列表和详情
QueryOpenGetResource获取语音资源列表支持获取语音资源列表和详情
OpenCreateTts创建TTS模板支持创建TTS模板
错误码语音通知-语音资源管理错误码

2.3 标准双呼

主叫用户通过平台拨打被叫用户,语音服务平台呼叫主叫和被叫,使得主叫和被叫能够互相通话,快速帮助业务实现与客户的电话建联。

API名称概述
Click2Call发起双呼支持发起双呼,支持指定外显号码或者根据平台根据规则选号
CancelClick2Call挂断支持挂断通话

2.4 号码池相关接口

提供号码池查询及管理功能

API名称概述
CreateNumberPool新建号码池新建号码池
UpdateNumberPool编辑号码池编辑号码池的名称、服务类型
NumberPoolList查询号码池列表查询号码池列表及详情
NumberList查询号码列表查询号码列表及详情
EnableOrDisableNumber号码停启用停、启用号码
SelectNumber按城市选择号码根据城市Code和降级城市列表选择号码
城市Code城市Code

2.5 话单查询

API名称概述
QueryCallRecordMsg查询话单根据通话id查询通话详情
QueryAudioRecordFileUrl查询录音根据通话id查询通话录音地址
QueryAudioRecordToTextFileUrl查询转译文本根据通话id查询录音转译文本

2.6 消息回执

名称概述
呼叫记录通话结束后向客户推送通话详情数据
呼叫状态通话过程中向客户推送通话状态(通常包含呼叫、振铃、接通、挂断)
呼叫录音通话结束后向客户推送通话录音

2.7 风控

API名称概述
呼叫频率控制客户如有频控需求可提前联系
冻结/解冻消息推送客户呼叫命中风控规则时推送已冻结的号码详情
CanCall查询号码是否可呼叫查询特定号码是否已命中黑名单规则