1.1 接口说明

在优音云客服系统中，可通过设置–>开发者中心,查看租户ID:tenant_id。
可通过座席工号来查询座席信息,获取agent_num。
此通话记录为呼叫片段记录。

1.2 调用形式

https://ykf.uincall.com/openapi/call?tenant_id=acf528a2-d0e2-4a7b-8513-74cb399xxxxx&access_token=670253572927b24acffc41078ddxxxxx

1.3 调用方式

POST

1.4 传入参数

非必填参数，调用接口时请传递参数名，参数值可为空

序号 名称 类型 是否必填 说明
1 kind Int 是 0:通话列表,1:待处理
2 page Int 是 页码参数（int类型的正整数）
3 size Int 是 每页条数（int类型的正整数，最大50）
4 all Boolean 是 false:呼入或呼出,true:全部 ,当kind为1时,all会被置为true
5 direction String 否 call in为呼入查询,call out为呼出查询,当all为false时,该值必填
6 agent_num String 否 不传或为空:为管理员权限,传工号则是该工号的权限查询
7 keyword String 否 手机号查询
8 ani String 否 主叫手机号查询
9 dnis String 否 被叫手机号查询
10 agent_num_conditions String 否 接听座席查询（坐席工号）
11 start_time String 否 呼叫开始日期查询 ,两个时间不填写时,默认为查询近一周内的数据
12 end_time String 否 呼叫结束日期查询 呼叫开始时间与结束时间最多相差60天,当超出60天时,查询开始时间向后60天内的数据

1.5 回应参数

序号 名称 类型 是否必填 说明
1 errcode Number 是 状态码：0成功，及其他非0错误码，详见错误码列表
2 errmsg String 是 状态说明
3 data Object数组 是 结果集（有数据时返回最新10条数据）
3.1 total Number 是 总条数
3.2 size Number 是 每页条数（最大每页50条）
3.3 current Number 是 当前页码
3.4 pages Number 是 总页码
3.5 records Object数组 是 数据集（有数据时返回最新10条~50条数据）
3.5.1 id String 是 call服务唯一标识
3.5.2 ani String 是 主叫号码
3.5.3 dnis String 是 被叫号码
3.5.4 customer_id String 是 客户id，无值为null
3.5.5 ani_place String 是 主叫号码归属地
3.5.6 dnis_place String 是 被叫号码归属地
3.5.7 bussiness_num String 是 服务号码
3.5.8 call_direction String 是 呼叫方向：呼入 call in / 1 呼出 call out
3.5.9 is_transfer Boolean 是 是否转接： false / true
3.5.10 hangup_reason Number 是 挂机原因：
1 有座席已接听来电(不代表转接的座席也接听来电)；
-1 振铃未接听来电；
-2 黑名单导致来电挂断；
2 排队放弃；
3 已留言；
4 IVR；
5 外呼失败
3.5.11 alterting_time String 否 振铃时间
3.5.12 service_time String 是 通话时长（秒）
3.5.13 service_start_time String 是 服务开始时间
3.5.14 service_stop_time String 是 服务结束时间
3.5.15 truename String 是 客户名称，场景1、customer_id为空， 当multi_match=true时， 为“多个匹配客户”，否则“未知客户”；
场景2、customer_id不为空，关联的客户姓名为空则为“未知客户”，不为空则为客户名称
3.5.16 assigned String Boolean 分配状态：未分配 false / 已分配 true
3.5.17 agent_call Object对象 是 座席呼叫信息
3.5.17.1 ringing_time Number 是 呼叫片段振铃时长，单位毫秒
3.5.17.2 stoptime String 是 当前座席呼叫(通话)结束的时间点
3.5.17.3 starttime String 是 开始呼叫当前座席的时间点
3.5.17.4 call_duration String 是 通话时长，单位毫秒
3.5.17.5 answertime String 是 座席接听的时间点.有该字段,stoptime就不存在,互斥关系
3.5.17.6 callresult Number 是 座席通话记录结果：
-1 振铃未接听（外呼时呼叫到目的码并且目的码先结束呼叫）
1 坐席通话过(来单和外呼场景)
5 外呼失败, 比如未呼叫到目的码就结束，呼叫到目的码并且坐席先结束呼叫
3.5.17.7 agentnum_to String 是 呼叫片段中座席工号
3.5.18 agent_name String 是 座席名称
3.5.19 agent_num String 是 座席工号
3.5.20 app_type String 是 应用类型
loginout：机呼入签入签出业务
callmemory：外呼来电记忆业务
app：IVR业务
queue：技能组业务
agent：座席业务
3.5.21 service_type String 是 服务类型
“agent” 标识通话坐席来电业务;
“dialout”标识坐席外呼业务
3.5.22 multi_match String 否 是否匹配多个客户： 否 false / 是 true
3.5.23 created_at String 是 创建时间

1.6 使用样例

调用：

url：https://ykf.uincall.com/openapi/call?tenant_id=acf528a2-d0e2-4a7b-8513-74cb399xxxxx&access_token=670253572927b24acffc41078ddxxxxx

    POST数据：
{
      "kind": 0,
      "page": 1,
      "size": 1,
      "all": true,
      "direction":"",
      "agent_num": "",
      "keyword":"",
      "ani":"",
      "dnis":"",
      "agent_num_conditions":"",
      "start_time":"",
      "end_time":""
}

响应：

{
    "errcode": 0,
    "errmsg": "success",
    "data": {
        "total": 72,
        "size": 1,
        "current": 1,
        "pages": 72,
        "records": [
            {
                "id": "87xxxx55-9cxx-49xx-c9xx-ddxxxxxxxx84",
                "ani": "028121345678",
                "dnis": "13012345678",
                "customer_id": null,
                "ani_place": "四川眉山",
                "dnis_place": "陕西西安",
                "bussiness_num": "028121345678",
                "call_direction": "call out",
                "is_transfer": false,
                "hangup_reason": 5,
                "alterting_time": "2023-03-06 17:26:53",
                "service_time": "2",
                "service_start_time": "2023-03-06 17:26:53",
                "service_stop_time": "2023-03-06 17:26:55",
                "truename": "多个匹配客户",
                "assigned": false,
                "agent_call": {
                    "sip_network_port": "12345",
                    "ringing_time": 2000,
                    "callresult": 5,
                    "agentnum_to": "8001",
                    "sip_network_ip": "127.0.0.1",
                    "stoptime": "2023-03-06 17:26:55",
                    "starttime": "2023-03-06 17:26:53",
                    "call_duration": 0
                },
                "agent_name": "张三（8001）",
                "agent_num": "8001",
                "app_type": "agent",
                "service_type": "dialout",
                "recently_at": null,
                "multi_match": true,
                "created_at": "2023-03-06 17:26:54"
            },
{
… …
}
        ]
    }
}
文档更新时间: 2024-09-24 14:36   作者：admin