1.1 接口说明

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

提示：
1.此功能计费不适用于‘智呼套餐’，将扣减租户余额，请合理安排。
2.此接口不触发‘呼出-挂机短信’功能。
3.此接口将于2024年10月15日下线，如有语音通知的需要，请对接【5.3 语音通知V3.0（IVR按键）】接口

1.2 应用场景

功能概述 场景示例
通过调用API向指定号码发起呼叫，呼叫被应答后播放一段指定音频，用户根据音频引导，通过手机按键信息返回意图，语音平台通过消息回执返回按键信息给企业业务系统。 通过IVR交互自动完成意图确认，减少人力投入。 * 主叫方：尊敬的${mcUserName}您好，这里是XX品牌商家事业部，想对我们的服务做一用户次调研，如您对我们的服务满意请按1，一般请按2，不满意请按3。
*被叫方：按1。
*主叫方：挂机。

1.3 业务流程图

1.4 调用形式

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

1.5 调用形式

POST

1.6 传入参数

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

序号 名称 类型 是否必填 说明
1 command String 是 定值”play_voice”
2 dnis String 是 被叫号码（要打给谁）格式：[“177****4629”]）,被叫目的码列表,最大支持200个目的码，最大排队目的码不能超过1000个(客户提供)
3 memo String 是 外显号码（云客服->设置->呼叫中心设置->外显号设置中获取）
4 playtimes String 是 播放次数（最大3次）
5 timeout int 否 按键等待超时时长,单位毫秒。比如3000毫秒.默认3秒
6 wav_audio String 是 1、语音文件标识（云客服->设置->呼叫中心设置->语音库设置->中获取”语音文件标识”）2、自定义语音文字，字符长度300以内。3、wav_audio、bye_audio、key_audio自定义语音文字总条数不得大于10条。
7 agent_num String 否 坐席工号
8 bye_audio String 否 结束提示音(客户提供)1、录音文件名（云客服->设置->呼叫中心设置->语音库设置->中获取”语音文件标识”）2、自定义语音文字
9 key_map jsonArray 否 按键及其语音数组,元素格式为 [{“key”:”3”,”key_audio”:”文本或者语音文件”}]
*key:按键只支持1位长度,范围数字0-9
*key_audio:云客服->设置->呼叫中心设置->语音库设置->中获取”语音文件标识
10 ver int 否 ver=1时，响应参数追加：JSONObject类型字段”queue_number”: x

1.7 回应参数

序号 名称 类型 是否必填 说明
1 errcode Number 是 状态码：0成功，及其他非0错误码，详见错误码列表
2 errmsg String 是 状态说明
3 data jsonarray 是
3.1 session_id String 是 呼叫会话记录唯一标识
3.2 dnis String 是 被叫号码（要打给谁）格式：[“177****4629”]）,被叫目的码列表,最大支持200个目的码，最大排队目的码不能超过1000个
3.3 queue_number int 否 语音播报排队数，值>=0 ；该字段为可选字段，当请求接口参数异常时，不返回该字段；

1.8 使用样例

调用：

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

传参：语音文件

{
 "command": "play_ivr",
 "memo": "025****3190",
 "playtimes": "3",
 "timeout": 3000,
 "wav_audio": "欢迎你对此次服务进行评价:1.非常满意,2.一般满意,3.不满意,4.其他.", 
 "agent_num": "8000", 
 "dnis": ["177****4629","159****2045"], 
 "bye_audio": "谢谢您积极的参与本次活动,祝你全家幸福。再见",
 "key_map": [
     {
         "key": "1",
         "key_audio": "你选择了菜单1和2"
     },
     {
         "key": "2",
         "key_audio": "你选择了菜单1和2"
  },
   {
         "key": "3",
        "key_audio": "你选择了菜单3"
   },
    {
        "key": "4",
        "key_audio": "你选择了菜单4"
    }
]
}

响应：

{
"errcode": 0,
"errmsg": "success",
"data": [
    {
        "session_id": "82cade51-44f6-423f-850e-6ea7xxxxxxxx",
        "dnis": "177****4629"
    },
    {
        "session_id": "00d93755-ee71-453c-8f2d-824dxxxxxxxx",
        "dnis": "159****2045"
    }
,
    {
        "queue_number": 2
    }
]
}

其他异常响应：

{
    "errcode": 160002,
    "errmsg": "按键录音不存在",
    "data": null
}
文档更新时间: 2024-09-26 14:42   作者：admin