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
简要描述:
- 语音群呼/通知/验证记录查询
请求URL:
http://api.nxcloud.com/api/voiceSms/getVoiceCdr
请求方式:
- POST 参数不要传body,用form表单方式提交
参数:
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appkey | 是 | string | 语音应用appkey |
| secretkey | 是 | string | 语音应用secretkey |
| voiceType | 是 | string | 语音业务类型 0群呼, 1验证码/通知 |
| messageid | 是 | string | messageid |
| start_time | 是 | string | 开始时间 格式:yyyy-MM-dd HH:mm:ss |
| end_time | 是 | string | 结束时间 格式:yyyy-MM-dd HH:mm:ss 时间跨度不能超过24小时,最多查询21天内的记录 |
| page_size | 是 | string | 每页数据 |
| page | 是 | string | 当前页,从1开始 |
返回示例 1.语音群呼
{
"code": "1",
"info": {
"total": 1,
"page": 1,
"pageSize": 5,
"rows": [
{
"id": 11112,
"result": "成功接通",
"cycle": 20,
"time": "2019-09-09 09:00:00",
"start_time": "2019-09-09 09:00:01",
"end_time": "2019-09-09 09:00:20",
"phone": "810022458",
"basic_price": 0.005,
"second": 19,
"countryCode": "91",
"messageid": 784522,
"customer_price": 0.05,
"show_phone": "085944247",
"size": 1,
"ivr_result":1
}
]
}
}
2.语音验证/通知
{
"code": "1",
"info": {
"total": 1,
"page": 1,
"pageSize": 5,
"rows": [
{
"id": 1821556,
"result": "成功接通",
"cycle": 1,
"time": "2019-08-09 00:01:00",
"start_time": "2019-09-09 09:00:01",
"end_time": "2019-09-09 09:00:04",
"phone": "85987053821",
"second": 3,
"voice_type": 2,
"countryCode": "55",
"messageid": 35618,
"customer_price": 0.012,
"show_phone": "1547822456",
"size": 3
}
]
}
}
返回参数说明 1.语音群呼
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | string | 接口返回值 0:失败 1:成功 |
| phone | string | 被叫号码 |
| show_phone | string | 显示号码 |
| countryCode | string | 国码 |
| messageid | string | messageid |
| basic_price | string | 未通基本费 |
| second | number | 秒钟数 |
| cycle | number | 计费周期 |
| size | string | 周期数 |
| customer_price | string | 客户单价 |
| time | string | 接通时间 |
| start_time | string | 通话开始时间 |
| end_time | string | 通话结束时间 |
| result | string | 发送结果 |
| ivr_result | string | 按键反馈 |
2.语音验证/通知
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | string | 接口返回值 0:失败 1:成功 |
| phone | string | 被叫号码 |
| show_phone | string | 显示号码 |
| countryCode | string | 国码 |
| messageid | string | messageid |
| second | number | 秒钟数 |
| cycle | number | 计费周期 |
| size | string | 周期数 |
| customer_price | string | 客户单价 |
| voice_type | string | 语音业务类型:1验证码,2通知 |
| time | string | 接通时间 |
| start_time | string | 通话开始时间 |
| end_time | string | 通话结束时间 |
| result | string | 发送结果 |
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号码
通用
号码检测