通话记录查询

可查询外呼或呼入的通话记录

请求地址

https://{baseURL}/api/v1/aicall/cdr/query?appkey=[appkey]&nonce=[nonce]&timestamp=[timestamp]&signature=[signature]

请求方式:

POST

请求参数:

属性 类型 约束 描述 举例说明
page_no integer 选填 查询的页数 0
page_size integer 选填 每页查询的条数 10
call_type string 必填 呼叫类型,呼入传值:call_in,外呼传值:call_out
task_id string call_type为call_out时必填,begin_at和end_at非必填 外呼任务ID
call_id string call_type为call_in时必填 呼入通话ID
begin_at string 选填 任务创建的起始时间,格式为yyyyMMddHHmmss,通过begin_at和end_at查询时,task_id,call_id非必填,begin_at和end_at查询,时间跨度不超过一个月 如20240416142030
end_at string 选填 任务创建的结束时间,格式为yyyyMMddHHmmss,通过begin_at和end_at查询时,task_id,call_id非必填,begin_at和end_at查询,时间跨度不超过一个月 如20240416182030

请求示例

{baseURL}/api/v1/aicall/cdr/query?appkey=[appkey]&nonce=[nonce]&timestamp=[timestamp]&signature=[signature]
Accept:application/json;
Content-Type: application/json;charset=utf-8;
{
    "page_no": 0,
    "page_size": 10,
    "call_type":"call_out",
    "task_id": "15260201958387204985"
}

响应参数:

属性 类型 约束 描述 举例说明
code integer 请求状态码,此时为0
msg string 请求状态码描述,此时为空
data object 结果集
data.task_id string 外呼任务ID
data.task_name string 外呼任务名称
data.robot_id string 使用的机器人ID
data.robot_name String 使用的机器人名称
data.tag_array String 意向标签组
data.call_id String 呼叫id
data.call_status integer 呼叫状态 1.成功接通 2.无法接通 3.用户拒接 4.正在通话 5.用户正忙 6.关机 7.停机 8.空号 9.网络忙 10.无人接听 11.呼叫转移 12.呼出限制 13.其他
data.call_duration integer 通话时长
data.talk_round integer 对话轮次
data.manual bool 是否转人工
data.caller_number string 主叫号码
data.called_number string 被叫号码
data.call_time integer 呼叫时间
data.hangup_side integer 挂断方 1用户端 2机器人端
data.hangup_node string 挂断节点
data.call_count integer 呼叫次数
data.answer_count integer 接通次数
data.record_addr string 录音地址,无录音则返回为空
data.vars object 使用外呼任务添加号码接口时,会将传递的vars字段中的对应值回传

响应示例

HTTP/1.1 200 OK
{
    "code": 0,
    "msg": "success",
    "data": {
        "total_count": 1,
        "total_page": 1,
        "cur_page": 1,
        "page_size": 10,
        "list": [
                  {
                     "app_type": "callbot",
                    "task_id": "202409110000xxx",
                     "task_name": "测试并发任务02",
                     "robot_id": "BOT0lzkz8fj92yctm8w",
                     "robot_name": "售后未成交商机外呼",
                     "tag_array": ["A级 (有明确意向)"],
                     "call_id": "7fb7d8dd-68be-4049-8f0a-29db558f8ca0",
                     "call_status": 1,
                     "call_duration": 31,
                     "talk_round": 3,
                     "manual": false,
                     "caller_number": "02566823186",
                     "called_number": "17310530740",
                     "call_time": 1709280706,
                     "hangup_side": 2,
                     "hangup_node": "F9",
                     "call_count": 1,
                     "answer_count": 1,
                     "record_addr": "",
                    "vars":{}

            }
        ]
    }
}
文档更新时间: 2024-11-01 17:31   作者:admin