5.1语音通知（已下线）

1.1 接口说明

语音通知是以电话的方式通知用户，由平台致电用户，自动播报语音消息。可广泛应用于会议通知、物流通知、事件通知等通知类业务场景，通知方式安全保密，及时有效，节约人力成本。

提示：

1.此功能计费不适用于‘智呼套餐’，将扣减租户余额，请合理安排。
2.此接口为‘呼出通话’，请根据业务场景关注是否开启‘呼出-挂机短信’功能。
3.此接口于2024年10月15日下线，如有语音通知的需要，请对接【5.3 语音通知V3.0（按键）】接口

1.2 应用场景

功能概述	场景示例
通过调用API向指定号码发起一通呼叫，呼叫被应答后，播放一段指定的音频，支持播放文本转语音的音频，也支持直接播放录音文件。语音通知作为短信通知的有效补充，提供多样化的通知手段，及时通知用户，帮您解决通知不及时的问题。	尊敬的用户您好，您的账号余额不足，请尽快续费以免停机。

1.3 调用形式

https://ykf.uincall.com/openapi/uincall/playwav?tenant_id=acf528a2-d0e2-4a7b-8513-74cb39xxxxxx&access_token=500b0c34de27bb2eb0212886edxxxxxx

1.4 调用方式

POST

1.5 传入参数

非必填参数，调用接口时请传递参数名，参数值可为空

序号	名称	类型	是否必填	说明
1	command	String	是	定值”play_voice”
2	dnis	String	是	被叫号码（要打给谁）
3	memo	String	是	外显号码（云客服->设置->呼叫中心设置->外显号设置中获取）
4	playtimes	String	是	播放次数（最大3次）
5	wav_audio	String	是	1、语音文件标识（云客服->设置->呼叫中心设置->语音库设置->中获取”语音文件标识”） 2、自定义语音文字，字符长度300以内。
6	remark	String	否	自定义扩展业务参数，JSON格式字符串

1.6 回应参数

序号	名称	类型	是否必填	说明
1	errcode	Number	是	状态码：0成功，及其他非0错误码，详见错误码列表
2	errmsg	String	是	状态说明
3	data	jsonarray	是
3.1	session_id	String	是	呼叫会话记录唯一标识

1.6 使用样例

调用：

url：https://ykf.uincall.com/openapi/uincall/playwav?tenant_id=acf528a2-d0e2-4a7b-8513-74cb39xxxxxx&access_token=500b0c34de27bb2eb0212886edxxxxxx

传参：语音文件

{
    "command":"play_voice",
    "dnis":"1357246XXXX",
    "memo":"0286320XXXX",
    "playtimes":"3",
    "wav_audio":"6fd7b7118ca54cb6a19e298a311c4745.wav"
}

传参：自定义语音文字

{
    "playtimes": "2",
    "memo": "01086391555",
    "wav_audio": "这里是测试语音",
    "dnis": "188xxxxxxxx",
    "command": "play_voice"
}

响应：

{
    "errcode": 0,
    "errmsg": "success",
     "data": {
    "session_id": "9b9dcd97-7d7a-4794-c7f6-a2f7ca01563a"
    }
}

其他异常响应：

{
"errcode": 100012,
"errmsg": "请求参数不完整"

}

文档更新时间: 2024-11-01 11:23 作者：admin

5.1语音通知 （已下线）