服务端
服务端API文档

放音收号

更新时间: 2022/08/19 09:12:13

DTMF放音收号

URL

  • 请求方法:POST
  • URL:http://voip-host/api/v1/voip/cti/app/ivr/dtmf

请求参数

参数名称 类型 是否必选 示例 描述
appId String 必填 eca23f68c66d4acfceee77c200200359 应用ID。
callId String 必填 eca23f68c66d4acfceee77c200200444 会话ID。
text string 必填 12 放音文本内容,文本长度不能大于500。
type int 选填 1 类型。0:文本;1:文件名,默认 0 。
minKey int 选填 1 最小收码个数,默认为1个,minKey取值范围1-30。
maxKey int 选填 1 最大收码个数,默认为1个,maxKey取值范围1-30。
repeat int 选填 1 重复次数,默认 1 次,参数repeat的取值范围为1-10。
timeOut int 选填 我是透传数据 "超时时间,默认超时为30秒,timeOut取值范围1-60。
endKey string 选填 1 结束符,结束键和禁止键不可相同。
invalidKey string 选填 1 不可用按键,结束键和禁止键不可相同。
data string 选填 1 我是透传数据。

返回参数

参数名称 类型 示例 描述
code int 0 状态码。
message string OK 请求成功或者失败描述信息。

示例

请求示例

{
  "appId": "eca23f68c66d4acfceee77c200200359",
  "callId": "eca23f68c66d4acfceee77c200200444",
  "data": "我就是要放音的句子",
  "endKey": "#",
  "invalidKey": ")",
  "maxKey": 1,
  "minKey": 1,
  "repeat": 1,
  "text": "我要放音",
  "timeOut": 1,
  "type": 0
}

正常返回示例

{
  "code": 0,
  "message": "OK"
}

错误码

  • body 中的错误码(code)

    该接口在 HTTP Body 中返回错误码(code),错误码列表请参考业务错误码

此文档是否对你有帮助?
有帮助
去反馈
  • DTMF放音收号
  • URL
  • 请求参数
  • 返回参数
  • 示例
  • 请求示例
  • 正常返回示例
  • 错误码