Skip to main content

通用api - 获取通话记录接口

通话记录回调参数接口说明

话单回调需要给对应的账号配置上回调地址即可。 话单的回调地址配置:由客户提供一个可以接收json数据主动拉取通话记录列表的接口地址,由我们配置或客户自行在后台配置都可以

请求方式

POST,form-data格式

请求参数

参数名类型是否必须说明
servicestringApp.Sip_Cdr.GetBill
tokenstring过授权接口获取的token
starttimestring(拔打)起始时间,格式:yyyy-mm-dd hh:mm:ss
endtimestring(拔打)结束时间,格式:yyyy-mm-dd hh:mm:ss
syncflagint获取记录回调类型:1、获取未查询过的记录(默认);2、获取已查询过的记录;3、获取全部记录。
directionint呼叫方向:1、呼入; 2、呼出;3、全部(默认)。
callmethodint呼叫方法:0、不限;1、分机互拨;2、分机直拨(手拨);3、API呼叫(默认);4、API双呼;5、预测式外呼;6、IVR/群呼。
currentpageint页数,默认:1
itemsperpageint每页数量,默认:10,最小:1;最大:1000
extnumberstring分机号,多个分机号用英文逗号隔开,传空值时为全部
destnumberstring呼叫的目标号码,传空值时为全部
useridstring自定义数据格式json(员工ID),可为空值
memberidstring自定义数据(会员ID),可为空值
extstring自定义数据(扩展参数)
customuuidstring自定义数据(客户ID)

接口请求示例(PHP)

<?php
    $apiUrl = 'http://127.0.0.1:8080';
    $postFields = [
        'service'   => 'App.Sip_Cdr.GetBill',
        'token'     => 'ABCDEFG',
        'starttime'  => '2019-01-12 00:00:00',
        'endtime'    => '2020-12-12 00:00:00',
        'direction'  => 3
        'syncflag'   => 3,
        'callmethod' => 0,
        'currentpage'  => 1,
        'itemsperpage'  => 10,
    ];
    $curl = curl_init();
    curl_setopt($curl, CURLOPT_URL, $apiUrl);
    curl_setopt($curl, CURLOPT_POST, 1);
    curl_setopt($curl, CURLOPT_POSTFIELDS, $postFields);
    curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
    $response = curl_exec($curl);
    $curlError = curl_error($curl);
    curl_close($curl);
    var_dump($response);
?>

返回数据结构示例

{
    "ret": 200,
    "data": {
        "status": 0,
        "desc": "获取成功",
        "result": {
            "totalitems": 8151,
            "currentpage": 1,
            "itemsperpage": 10,
            "bills": [
                {
                    "id": 263056202,
                    "companycode": "9513923",
                    "direction": "callout",
                    "type": "callout",
                    "callmethod": 6,
                    "starttime": "2025-10-16 17:31:13",
                    "answertime": "",
                    "endtime": "2025-10-16 17:31:21",
                    "duration": 8,
                    "billsec": 0,
                    "userid": "0",
                    "memberid": "0",
                    "chengshudu": "0",
                    "ext": "0",
                    "disnumber": "219513923001",
                    "destnumber": "81351111451",
                    "extnumber": "",
                    "recordfilename": "",
                    "downloadip": "",
                    "hangupdirection": 10040,
                    "hangupcause": 10020,
                    "uuid": "db4a44cc-aa72-11f0-ad78-1d7ff0749d07",
                    "userkey": "",
                    "customuuid": "76c33d997640d36b033d43b1d2d3964e",
                    "taskid": "",
                    "round": 0,
                    "recordurl": ""
                }
            ]
        },
        "reqtime": 1581502410,
        "rsptime": 1581502410
    },
    "msg": ""
}

通话记录参数说明

参数名 类型 说明
callmethodresultobjest返回的结果集
—totalitems int 呼叫方法:0、不限;1、分机互拨;2、分机直拨(手拨);3、API呼叫(默认);4、API双呼;5、预测式外呼;6、IVR/群呼。记录总数
—currentpageint当前页码
—itemsperpageint每页数量
—billsarray记录数组
——idint记录id
——extnumberstring分机号
——destnumberstring目标号码
——disnumberstring显示号码
——starttime string 呼叫时间
——answertime string 应答时间
——endtime string 通话结束时间
——duration int 呼叫等待时长
——billsec int 通话时长
——directionstring呼叫方向
——callmethodint呼叫方式
——userid string 员工工号自定义参数(用户id)
——memberidstring自定义参数(会员id)
——chengshudustring自定义参数(成熟度)
——ext string 自定义参数-(扩展参数)
chengshudu——customuuid string 自定义参数-值和ext一致(客户id)
hangupdirection——recordfilename intstring 挂机方向通话记录文件名
hangupcauseint挂机原因代码
memberidstring自定义参数-会员id
disnumberstring主叫号码
destnumberstring被叫号码
——downloadip string 录音下载ip
recordfilename——hangupdirection stringint 录音文件名挂断方向
companycode——hangupcause stringint 公司id挂断原因
typestring呼叫类型
extnumberstring分机号
uuidstring通话uuid
——userkey string 用户按键
——customuuid string 自定义参数-客户id
——taskid string 任务id
——round string 呼叫任务轮次
——recordurl string 录音下载地址

Postman请求示例

c65b2c52d15ac1a4f5775e9b19f9cfe5.jpg