文档中心 API 中心 云呼叫中心 相关接口 语音播报(语音验证码)

语音播报(语音验证码)

最近更新时间:2019-04-16 17:44:17

接口描述

使用指定的号码,向用户发起一路呼叫,用户接听后,给用户播放一段语音,可以获取按键。给用户播放完语音/获取到用户按键后,挂断电话。

对应的通知为:语音播报结果通知,该接口不会上报呼叫状态通知事件。

请求

请求地址

/ipcc/call/callNotify

请求方式

Post 请求。

请求包体

属性 类型 约束 说明
appId String 必选 应用 ID
caller String 必选 主叫号码-显示号码
called String 必选 被叫号码
Timeout Int 可选 超时未接听则挂断,20-60之间
voice String 必选 flag:1,
需要播放的语音文件
flag:0,
需要转换为语音的字符串,不得超过800字节,超过则会截断处理
flag Int 必选 0:播放TTS
1:播放语音文件
getKey Int 可选 0:不需要获取用户按键
1:需要获取用户按键
只能够获取一个用户按键
playTime Int 必选 播放语音的次数

响应

响应包体

属性 类型 约束 说明
code String 必选 响应码
000000 表示成功
108100 解析失败-入参错误
108101 应用 ID 不存在
108102 消息队列已满
108103 呼叫资源不足
108104 其他错误
appId String 必选 应用 ID
callId String 必选 呼叫号 ID

实际示例

JSON 请求示例

{
  "appId":"247e35ff320a4142a1050240cccccccc",
  "caller":"02160554150",
  "called":"18898739887",
  "voice":"语音通知测试,请按键",
  "flag":0,
  "getKey":1,
  "playTime":1
}

JSON 响应示例

{
  "code ": "000000",
  "appId":"247e35ff320a4142a105024055c367cf",
  "callId":"88-2018031000182918181271218-108bc381ca0f42d8-out"
}