语音回执回调 - nxtele/http-api-document GitHub Wiki
简要描述:
- 语音群呼/验证码回执(DR)推送
请求URL:
- DR推送的Http接口地址(由用户提供)
- 例如:
http://106.15.34.94:8989/voice/testVoiceDr
请求方式:
- POST 参数不要传body,用form表单方式提交
参数: 1. 语音群呼
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| phone | 是 | string | 手机号 |
| countryCode | 是 | string | 国码 |
| duration | 是 | string | 接通时长 |
| voice_type | 是 | string | 语音类型:0群呼 、 1验证码 2通知 |
| messageid | 是 | string | 语音id,对应的语音提交成功得到的id |
| second | 是 | number | 计费秒钟数 |
| cycle | 是 | number | 计费周期 |
| size | 是 | string | 周期数 |
| basic_price | 是 | string | 未通基本费(CNY) |
| customer_price | 是 | string | 客户单价(CNY) |
| currency | 是 | string | 客户币种 |
| basicOriginalPrice | 是 | string | 未通基本费(客户币种) |
| customerOriginalPrice | 是 | string | 客户单价(客户币种) |
| start_time | 否 | string | 通话开始时间 |
| end_time | 否 | string | 通话结束时间 |
| message | 是 | string | 发送结果:connect/disconnect |
| hangup_cause | 是 | string | 呼叫挂断原因 |
| hangup_disposition | 是 | string | 终止原因:send_cancel=主叫超时;recv_refuse=被叫拒接;recv_bye=被叫挂断;send_bye=主叫挂断;other=其他 |
| ivr_result | 是 | string | 按键反馈 |
| status | 是 | number | 提交状态:1-提交成功;2-提交失败 |
| error | 否 | string | 失败原因 |
2.语音验证/通知
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| phone | 是 | string | 手机号 |
| countryCode | 是 | string | 国码 |
| duration | 是 | string | 接通时长 |
| voice_type | 是 | string | 语音类型:0群呼 、 1验证码 2通知 |
| messageid | 是 | string | 语音id,对应的语音提交成功得到的id |
| second | 是 | number | 计费秒钟数 |
| cycle | 是 | number | 计费周期 |
| size | 是 | string | 周期数 |
| customer_price | 是 | string | 客户单价(CNY) |
| currency | 是 | string | 客户币种 |
| customerOriginalPrice | 是 | string | 客户单价(客户币种) |
| start_time | 否 | string | 通话开始时间 |
| end_time | 否 | string | 通话结束时间 |
| message | 是 | string | 发送结果:connect/disconnect |
| hangup_cause | 是 | string | 呼叫挂断原因 |
| hangup_disposition | 是 | string | 终止原因:send_cancel=主叫超时;recv_refuse=被叫拒接;recv_bye=被叫挂断;send_bye=主叫挂断;other=其他 |
| ext | 否 | string | api调用时客户自定义的扩展字段 |
| status | 是 | number | 提交状态:1-提交成功;2-提交失败 |
| error | 否 | string | 失败原因 |
推送示例
http://106.15.34.94:8080/sms/testVoiceDr?phone=8615088888888&countryCode=86&duration=10&voice_type=0&messageid=74078a0090f17e011505297261994&basic_price=0.005&second=10&cycle=60&size=1&customer_price=0.036&start_time=2020-12-01 00:00:00&end_time=2020-12-01 00:00:10&message=connect&hangup_cause=NORMAL_CLEARING&hangup_disposition=send_bye&ivr_result=&status=1
用户返回值 成功返回字符串:success 失败返回字符串:error
备注 说明:DR只推送一次,如果需要重复推送,请向客服联系