本文汇总语音服务提供的open api接口列表,以及对应sdk地址等信息
https://cloud-vms.volcengineapi.com
语言 | 地址 |
---|---|
php | https://github.com/volcengine/volc-sdk-php |
python | https://github.com/volcengine/volc-sdk-python |
go | https://github.com/volcengine/volc-sdk-golang |
java | https://github.com/volcengine/volc-sdk-java |
针对不同的业务场景,在不增加SIM卡的情况下,为企业用户或员工增加隐私号码;使其在隐藏真实号码的同时,享受优质的通话和短信服务。
API | 概述 | |
---|---|---|
错误码 | 隐私号功能通用错误码 | |
QuerySubscription | 查询绑定关系 | 根据绑定关系id查询绑定关系,隐私号服务通用接口 |
QuerySubscriptionForList | 查询绑定关系列表 | 根据绑定关系id查询绑定关系,隐私号服务通用接口 |
API | 名称 | 概述 |
---|---|---|
BindAXB | AX&AXB绑定(指定X号码) | 支持新增AX、AXB绑定关系(需指定X号码) |
SelectNumberAndBindAXB | AX&AXB绑定(平台选号) | 支持新增AX、AXB绑定关系(根据限制条件选定X号码) |
UpgradeAXToAXB | AX升级AXB关系 | 支持AX关系升级为AXB关系 |
UpdateAXB | AX&AXB更新 | 支持修改AX、AXB关系的过期时间 |
UnbindAXB | AX&AXB解绑 | 支持解绑AX、AXB关系 |
API | 名称 | 概述 |
---|---|---|
BindAXN | AXN绑定(指定号码) | 支持新增AXN绑定关系(需指定X号码) |
SelectNumberAndBindAXN | AXN绑定(平台选号) | 支持新增AXN绑定关系(根据限制条件选定X号码) |
UnbindAXN | AXN关系解绑 | 支持解绑AXN绑定关系 |
UpdateAXN | AXN关系更新B号码 | 支持更新AXN关系里的B号码 |
API | 名称 | 概述 |
---|---|---|
BindAXNE | AXNE绑定 | 支持新增AXNE(分机号)绑定关系 |
UnbindAXNE | AXNE解绑 | 支持解绑AXNE(分机号)绑定关系 |
UpdateAXNE | AXNE更新 | 支持更新AXNE关系里的B号码,或者修改绑定关系的过期时间 |
BindAXBForAXNE | AXNE中AXB绑定 | 创建AXNE绑定关系的子AXB绑定关系 |
API | 名称 | 概述 |
---|---|---|
BindAXYB | AXYB绑定 | 支持新增绑定AXYB绑定关系 |
BindYBForAXYB | AXYB中YB绑定 | 支持新增AXYB中的YB绑定关系 |
UpdateAXYB | AXYB更新 | 支持更新AXYB关系中的绑定号码,Userdata或者修改绑定关系的过期时间 |
UnbindAXYB | AXYB解绑 | 支持解绑AXYB绑定关系 |
用户向指定号码发起一通呼叫,被叫应答后,播放一段指定的音频。支持通过TTS(文本转语音)播放,也支持直接播放录音文件。
API | 概述 |
---|---|
公共数据结构 | 公共返回结构、PhoneParam、ForbidTimeItem结构 |
API | 名称 | 概述 |
---|---|---|
CreateTask | 创建任务 | 支持创建语音通知任务 |
BatchAppend | 添加号码 | 支持向已创建的语音通话任务添加被叫号码 |
PauseTask | 暂停任务 | 支持暂停已创建的语音通知任务 |
ResumeTask | 恢复任务 | 支持恢复暂停中的语音通知任务 |
StopTask | 终止任务 | 支持终止语音通知任务 |
UpdateTask | 更新任务 | 支持更新语音通知任务的执行时间、重呼设置等 |
并发量 | 并发量释义和影响因素 | |
任务管理错误码 | 语音通知-任务管理相关接口错误码 |
API | 名称 | 概述 |
---|---|---|
SingleBatchAppend | 创建单次发送任务 | 支持创建单次语音通知任务 |
SingleInfo | 获取详情 | 支持查询单次语音通知任务的状态和呼叫详情 |
SingleCancel | 取消单次发送 | 支持取消单次语音通知任务 |
错误码 | 单次发送语音通知相关接口错误码 |
API | 名称 | 概述 |
---|---|---|
OpenUploadResource | 上传语音资源 | 支持上传语音资源文件 |
OpenUpdateResource | 修改语音资源 | 支持修改语音资源文件名称 |
OpenDeleteResource | 删除语音资源 | 支持删除语音资源文件 |
QueryUsableResource | 获取可用语音资源 | 支持获取可用语音资源列表和详情 |
QueryOpenGetResource | 获取语音资源列表 | 支持获取语音资源列表和详情 |
OpenCreateTts | 创建TTS模板 | 支持创建TTS模板 |
错误码 | 语音通知-语音资源管理错误码 |
主叫用户通过平台拨打被叫用户,语音服务平台呼叫主叫和被叫,使得主叫和被叫能够互相通话,快速帮助业务实现与客户的电话建联。
API | 名称 | 概述 |
---|---|---|
Click2Call | 发起双呼 | 支持发起双呼,支持指定外显号码或者根据平台根据规则选号 |
CancelClick2Call | 挂断 | 支持挂断通话 |
提供号码池查询及管理功能
API | 名称 | 概述 |
---|---|---|
CreateNumberPool | 新建号码池 | 新建号码池 |
UpdateNumberPool | 编辑号码池 | 编辑号码池的名称、服务类型 |
NumberPoolList | 查询号码池列表 | 查询号码池列表及详情 |
NumberList | 查询号码列表 | 查询号码列表及详情 |
EnableOrDisableNumber | 号码停启用 | 停、启用号码 |
SelectNumber | 按城市选择号码 | 根据城市Code和降级城市列表选择号码 |
城市Code | 城市Code |
API | 名称 | 概述 |
---|---|---|
QueryCallRecordMsg | 查询话单 | 根据通话id查询通话详情 |
QueryAudioRecordFileUrl | 查询录音 | 根据通话id查询通话录音地址 |
QueryAudioRecordToTextFileUrl | 查询转译文本 | 根据通话id查询录音转译文本 |
名称 | 概述 |
---|---|
呼叫记录 | 通话结束后向客户推送通话详情数据 |
呼叫状态 | 通话过程中向客户推送通话状态(通常包含呼叫、振铃、接通、挂断) |
呼叫录音 | 通话结束后向客户推送通话录音 |
API | 名称 | 概述 |
---|---|---|
呼叫频率控制 | 客户如有频控需求可提前联系 | |
冻结/解冻消息推送 | 客户呼叫命中风控规则时推送已冻结的号码详情 | |
CanCall | 查询号码是否可呼叫 | 查询特定号码是否已命中黑名单规则 |