1.1 接口说明

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

1.2 调用形式

https://ykf.uincall.com/openapi/call/v2?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为呼出查询,当kind=0 且all为false时,该值必填;
当kind=1,该参数不生效,默认为call in
6 agent_num String 不传或为空:为管理员权限,传工号则是该工号的权限查询;direction为call out 或 call in,且 all为false时,需带agent_num参数,如:8001
7 keyword String 手机号查询
8 ani String 主叫手机号查询
9 dnis String 被叫手机号查询
10 answer_agent_num String 接听座席查询(座席工号)
11 start_time String 呼叫开始日期查询 ,两个时间不填写时,默认为查询近一周内的数据;
1、对应WEB端“全部”页签,对all为true 有效;
2、对“呼入”/“呼出”页签: all为false, direction为call out 或 call in,参数无效
12 end_time String 呼叫结束日期查询 呼叫开始时间与结束时间最多相差60天,当超出60天时,查询开始时间向后60天内的数据;
1、对应WEB端“全部”页签,对all为true 有效;
2、对“呼入”/“呼出”页签: all为false, direction为call out 或 call in,参数无效
13 call_type Int call_type=5对应云客服中语音通话高级搜索中呼叫类型为“API语音通知”筛选条件

1.5 回应参数

序号 名称 类型 是否必填 说明
1 errcode Number 状态码:0成功,及其他非0错误码,详见错误码列表
2 errmsg String 状态说明
3 data Object数组 Object数组
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 呼叫会话记录唯一标识(session_id)
3.5.2 ani String
3.5.3 dnis String
3.5.4 customer_id String 无关联的客户时为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 hangup_reason Number 挂机原因:
1 有座席已接听来电(不代表转接的座席也接听来电);
-1 振铃未接听来电;-2 黑名单导致来电挂断;
2 排队放弃;
3 已留言;
4 IVR;
5 外呼失败
当接听状态为空号时,hangup_reason为以下值:
点击查看详情
430:空号
431:关机
432:停机
433:正在通话
434:无人接听
435:号码有误
436:号码过期
437:用户忙
438:暂停服务
439:呼叫等待
440:来电提醒
441:不方便接听
442:免打扰
443:本地号码
444:外地号码
445:呼转不成功/多次呼转
446:线路忙
447:欠费
448:网络忙
449:稍后再拨
450:线路故障
451:呼入限制
452:黑名单
453:呼叫超频
454:不在服务区
455:呼叫受限
457:振铃未接听
500:数据配置有误
501:通信异常
502:坐席未接听
503:频次限制
504:防骚扰拦截
505:业务号码状态异常
3.5.10 alterting_time String 振铃时间
3.5.11 stop_time String 当前座席呼叫(通话)结束的时间点
3.5.12 call_duration Int 通话时长(单位:秒),默认0,有通话时长为具体数字值
3.5.13 truename String 客户名称,场景1、customer_id为空, 当multi_match=true时, 为“多个匹配客户”,否则“未知客户”;
场景2、customer_id不为空,关联的客户姓名为空则为“未知客户”,不为空则为客户名称
3.5.14 agent_name String 座席名称
3.5.15 agent_num String 座席工号
3.5.16 multi_match String 是否匹配多个客户: 否 false / 是 true
3.5.17 summary String 备注
3.5.18 answer_time String 应答时间
3.5.19 remark String remark

1.6 使用样例

调用

统一请求url demo:

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

1、语音通话>呼入列表

请求
post数据

{
    "kind": 0,
    "page": 1,
    "size": 50,
    "all": false,
    "direction":"call in",
    "agent_num": "1001"
}

响应

{
    "errcode": 0,
    "errmsg": "success",
    "data": {
        "total": 79,
        "size": 50,
        "current": 1,
        "pages": 2,
        "records": [
            {
                "id": "6ca5f94a-xxxx-xxxx-xxxx-351axxxxxxxx",
                "ani": "13012345678",
                "dnis": "02811111111",
                "customer_id": "42e01d0b09a0b0xxxxxxxxxxxxxxxxx6a",
                "ani_place": "北京",
                "dnis_place": "四川成都",
                "bussiness_num": "028xxxxxxxx",
                "call_direction": "call in",
                "hangup_reason": -1,
                "alterting_time": "2023-01-31 18:17:17",
                "stop_time": "2023-01-31 18:17:20",
                "truename": "王小二",
                "agent_name": "张三(1001)",
                "agent_num": "1001",
                "multi_match": false,
                "summary": "",
                "answer_time": null"call_duration": 0
            },
            ... ...
        ]
    }
}

2、语音通话>呼出列表

请求
post数据

{
    "kind": 0,
    "page": 1,
    "size": 50,
    "all": false,
    "direction":"call out",
    "agent_num": "1001"
}

响应:

{
    "errcode": 0,
    "errmsg": "success",
    "data": {
        "total": 304,
        "size": 50,
        "current": 1,
        "pages": 7,
        "records": [
            {
                "id": "82c8da4e-xxxx-xxxx-xxxx-xxxxxxxx18df",
                "ani": "02811111111",
                "dnis": "13012345678",
                "customer_id": "37350bad94efxxxxxxxxxxxxxxxx2648",
                "ani_place": "四川成都",
                "dnis_place": "北京",
                "bussiness_num": "0281111111",
                "call_direction": "call out",
                "hangup_reason": 1,
                "alterting_time": "2023-03-09 10:40:46",
                "stop_time": "2023-03-09 10:41:05",
                "truename": "王二小",
                "agent_name": "张三(1001)",
                "agent_num": "1001",
                "multi_match": false,
                "summary": "",
                "answer_time": "2023-03-09 10:40:52""call_duration": 0
            },
            ... ...
        ]
    }
}

3、语音通话>“全部”列表

请求
post数据

{
    "kind": 0,
    "page": 1,
    "size": 50,
    "all": true,
    "keyword": "13000000000",
    "agent_num": "1001",
    "start_time":"2023-03-07 00:00:00",
    "end_time":"2023-03-07 23:59:59",
    "call_type": 5
}

响应

{
    "errcode": 0,
    "errmsg": "success",
    "data": {
        "total": 42,
        "size": 50,
        "current": 1,
        "pages": 42,
        "records": [
            {
                "id": "e54232f9-xxxx-xxxx-xxxx-xxxxxxxx33f8",
                "ani": "02811111111",
                "dnis": "13000000000",
                "customer_id": "37350baxxxxxxxxxxxxxxxxxxxx2648",
                "ani_place": "四川成都",
                "dnis_place": "北京",
                "bussiness_num": "02811111111",
                "call_direction": "call out",
                "hangup_reason": 1,
                "alterting_time": "2023-03-07 19:14:26",
                "stop_time": "2023-03-07 19:15:08",
                "truename": "王小二",
                "agent_name": "张三(1001)",
                "agent_num": "1001",
                "multi_match": false,
                "summary": "",
                "answer_time": "2023-03-07 19:14:33""call_duration": 35
            }
,
            ... ...
        ]
    }
}

4、语音通话>“待领取”列表

请求
post数据

{
    "kind": 1,
    "page": 1,
    "size": 50,
    "all": true,
    "agent_num": "1001",
    "keyword":"13000000000",
    "start_time":"2023-01-01 00:00:00",
    "end_time":"2023-03-08 00:00:00"
}

响应

{
    "errcode": 0,
    "errmsg": "success",
    "data": {
        "total": 1,
        "size": 50,
        "current": 1,
        "pages": 1,
        "records": [
            {
                "id": "2a203e16-xxxx-xxxx-xxxx-xxxxxxxx6288",
                "ani": "13000000000",
                "dnis": "02811111111",
                "customer_id": null,
                "ani_place": "北京",
                "dnis_place": "四川成都",
                "bussiness_num": "02811111111",
                "call_direction": "call in",
                "hangup_reason": -1,
                "alterting_time": "2023-03-02 12:03:33",
                "stop_time": "2023-03-02 12:03:46",
                "truename": "未知客户",
                "agent_name": "张三(1001)",
                "agent_num": "1001",
                "multi_match": false,
                "summary": "",
                "answer_time": null"call_duration": 0
            }
        ]
    }
}
文档更新时间: 2024-09-24 14:36   作者:admin