获取呼叫状态报告
功能说明:#
状态呼叫报告数据,保存时间为三个月。 您可以通过此接口获取呼叫的状态报告。
HTTP头信息(具体参考调用说明):#
Accept:application/json;charset=utf-8; Content-Type:application/json;charset=utf-8; X-SIGNATURE: $signature; X-APIKEY: $APIKEY; X-TIMESTAMP: $timestamp; X-NONCE: $nonce;请求#
URL:https://gateway.yihuitong.top/coll-openapi/call/record/callReport 访问方式:GET请求参数#
| 参数名 | 类型 | 是否必传 | 描述 | 示例 |
|---|---|---|---|---|
| callId | string | 是 | 呼叫ID,websocket 呼叫的时候需要保存呼叫ID session?._request?.call_id | 12345 |
响应参数#
| 名称 | 类型 | 描述 |
|---|---|---|
| success | boolean | 是否请求成功 false 为接口请求失败,请求失败 data 中无数据 |
| errorCode | string | 错误码 200 代表成功 |
| errorMessage | string | 错误提示 |
| data | object[] | 报告数据,是一个数组;格式参考下面 |
data 响应参数#
| 名称 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
| callId | string | 是 | 呼叫ID |
| cause | string | 是 | 挂断原因 |
| causeQ850 | string | 否 | 挂断原因 q850 |
| billsec | int | 是 | 通话时长 |
| startStamp | string | 是 | 开始呼叫时间 |
| answerStamp | string | 否 | 应答时间 |
| endStamp | string | 是 | 结束时间 |
| userName | string | 是 | 呼叫用户 |
| status | string | 是 | 状态 200 成功 4407 失败 |
| billingDuration | int | 否 | 计费时长 |
| recording | string | 否 | 录音文件 00-无 01-有 |
重要说明#
请按照如下顺序使用参数
- status 为 200 代表呼叫接通
- recording 为 01 代表有录音文件,可以调用获取录音接口
- 请妥善保存状态信息;
- 如果您的系统接收推送信息失败,请及时联系我们。
Json响应示例#
{ "success": true, "errorCode": "200", "errorMessage": "成功", "data": { "callId": "123", "cause": "NORMAL_CLEARING", "causeQ850": "16", "billsec": 10, "startStamp": "2024-08-02 12:52:49", "answerStamp": "2024-08-02 12:52:59", "endStamp": "2024-08-02 12:53:09", "userName": "test", "status": "200", "billingDuration": 60, "recording": "01" }}