forked from nxtele/http-api-document
-
Notifications
You must be signed in to change notification settings - Fork 1
语音回执回调
ben.zhuang edited this page Oct 14, 2022
·
1 revision
简要描述:
- 语音群呼/验证码回执(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验证码或者通知 |
| messageid | 是 | string | 语音id,对应的语音提交成功得到的id |
| basic_price | 是 | string | 未通基本费 |
| second | 是 | number | 秒钟数 |
| cycle | 是 | number | 计费周期 |
| size | 是 | string | 周期数 |
| customer_price | 是 | string | 客户单价 |
| start_time | 否 | string | 通话开始时间 |
| end_time | 否 | string | 通话结束时间 |
| result | 是 | string | 发送结果:成功接通/未接通 |
| hangup_disposition | 是 | string | 终止原因:send_cancel=主叫超时;recv_refuse=被叫拒接;recv_bye=被叫挂断;send_bye=主叫挂断;other=其他 |
| ivr_result | 是 | string | 按键反馈 |
2.语音验证/通知
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| phone | 是 | string | 手机号 |
| show_phone | 是 | string | 显示号码 |
| countryCode | 是 | string | 国码 |
| duration | 是 | string | 接通时长 |
| voice_type | 是 | string | 语音类型:0群呼 、 1验证码或者通知 |
| messageid | 是 | string | 语音id,对应的语音提交成功得到的id |
| second | 是 | number | 秒钟数 |
| cycle | 是 | number | 计费周期 |
| size | 是 | string | 周期数 |
| customer_price | 是 | string | 客户单价 |
| record_url | 否 | string | 语音记录url,对应的语音验证时返回 |
| start_time | 否 | string | 通话开始时间 |
| end_time | 否 | string | 通话结束时间 |
| result | 是 | string | 发送结果:成功接通/未接通 |
推送示例
http://106.15.34.94:8080/sms/testVoiceDr?phone=8615088888888&show_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&result=成功接通&hangup_disposition=send_bye&ivr_result=
用户返回值 成功返回字符串:success 失败返回字符串:error
备注 说明:DR只推送一次,如果需要重复推送,请向客服联系
Introduction
- Send Message
- Mark Incoming Message as Read
- Upload Media File
- Get Media File
- Delete Media File
- Webhook
- Query Number Information
- Query Message Template
- Create Message Template
- Edit Message Template
- Delete Message Template
- Upload Template Example File
- Embedded Page Login
- Create Client Application
- List of Phone Numbers for Client Application
- Get Verification Code
- Verify Verification Code
- Create Local Client
Short message
Voice
Call Center(NXLink)
- Web Iframe
- Manual Dial Record
- Manual Dial Record Query By orderId
- List Agent Information
- List Agent Status
- List Queue
- List Agents In Queue
- List Agent Efficiency
- Update Queue Agents
- Create AutoDial Task
- Webhook - Manual Dial
AI Agent(NXLink)
- AI Agent Task List
- Query Call Records
- Append Contacts to an Existing Task
- Delete Contacts
- Call Record Callback
Call Center(Callbot)
- Callbot API Summary
- Callbot API Authorization
- Callbot API Ping
- Create Auto Dial Task
- Add Contact List To Task
- Create Task And Add Contact
- Start Or Pause Task
- Update Task Parameters
- Get List Task
- List Call
- List Task Orders
- Stop Order
- Get Call Detail By Order
- Webhook - By Call
- Webhook - By Order
- Webhook - Task Status
Flash Call
Short links
邮件验证码
DID号码
通用
号码检测