Skip to main content

获取呼叫状态报告

功能说明:#

状态呼叫报告数据,保存时间为三个月。 您可以通过此接口获取呼叫的状态报告。

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

请求参数#

参数名类型是否必传描述示例
callIdstring呼叫ID,websocket 呼叫的时候需要保存呼叫ID session?._request?.call_id12345

响应参数#

名称类型描述
successboolean是否请求成功 false 为接口请求失败,请求失败 data 中无数据
errorCodestring错误码 200 代表成功
errorMessagestring错误提示
dataobject[]报告数据,是一个数组;格式参考下面

data 响应参数#

名称类型是否必传描述
callIdstring呼叫ID
causestring挂断原因
causeQ850string挂断原因 q850
billsecint通话时长
startStampstring开始呼叫时间
answerStampstring应答时间
endStampstring结束时间
userNamestring呼叫用户
statusstring状态 200 成功 4407 失败
billingDurationint计费时长
recordingstring录音文件 00-无 01-有
重要说明#

请按照如下顺序使用参数

  1. status 为 200 代表呼叫接通
  2. recording 为 01 代表有录音文件,可以调用获取录音接口
  3. 请妥善保存状态信息;
  4. 如果您的系统接收推送信息失败,请及时联系我们。
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"    }}