播放语音

最近更新时间:2019-05-24 16:50:23

接口描述

播放语音,播放文件时,voicestr 为文件名,播放 TTS 时,voicestr 为待转换语音。
getkey 来判断是否需要获取用户的按键信息。
当 getkey 为 0 时参数 maxRevCnt,key2End,spaceTime,totalTime 不生效。

请求

请求地址

/ipcc/call/play

请求方式

Post 请求

请求包体

属性 类型 必选 说明
appId String 应用 ID
callId String 呼叫号 ID
getkey int 默认不获取按键
为 1 时获取按键
dtmf 标志位
playFlag int 放音标签
0:TTS
1:VOICE
voiceStr String Playflag 为 0 时,为转换的TTS文本(800字节以内)
Playflag 为 1 时,为播放的语音文件
playTime int 默认一次,播放次数
maxRevCnt int 最多收码个数。为 0 时 ,最大收码 30 个,key2End 不能为空字符(即 >= 0)
getkey 为 1 时有效
key2End String 收到指定 dtmf 码后结束收号,不可与 maxRevCnt 同时无效
可为:0~9*#、空字符
getkey 为 1 时有效
spaceTime int 最长按键间隔,为 0 时代表默认值:30s
getkey 为 1 时有效
totalTime int 最长等待时间,为 0 时 代表默认值:60s
getkey 为 1 时有效
keyStop int 默认为 0,播放的语音不可打断
1:播放语音时,按键可打断播放的语音
data String 用户透传数据

响应

响应包体

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

实际示例

JSON 请求示例

{
    "appId": "247e35ff320a4142a105024055c367cf", 
    "callId": "88-2018031000182918181271218-108bc381ca0f42d8-out", 
    "playFlag": 0, 
    "getkey": 0, 
    "voiceStr": "您的短信剩余15条", 
    "playTime": 3, 
    "maxRevCnt": 1, 
    "key2End": "0", 
    "spaceTime": 5, 
    "totalTime": 30, 
    "data": "userdata"
}

JSON 响应示例

{
    "code ": "000000", 
    "appId": "247e35ff320a4142a105024055c367cf", 
    "callId": "20170818081309834567-out"
}