Skip to main content

外呼监控

零、注意事项：

0.1 格式说明

所有API，若未特殊注明，Content-Type 全部使用 application/json。

0.2 出参约定格式

如无特殊说明，出参固定为以下格式：

参数类型说明
codeint状态码，0 - 成功， 其余为失败
messagestring提示信息
datamixed数据

data 具体格式见每个接口具体说明

0.3 域名

如果无特殊说明，以下 API 中，所有域名均为: https://autocall.icsoc.net

一、项目监控列表

1.1 路由

GET /api/v3/monitor/lists

1.2 入参

参数类型说明必填默认值
project_idint项目id否
typeint项目类型 1-预测式外呼，3-自动外呼，4-机器人外呼是
current_pageint当前页否1
per_pageint每页数量否15

1.3 出参

参数类型说明
current_pageinteger当前页
total_pageinteger总页数
per_pageinteger每页数量
totalinteger总数据量
emptybool数据量是否为空（即 results 是否为空）
resultsMonitor[]结果 （project_type 不同即结果不同）

1.3.1 预测式监控 Monitor 格式为

参数类型说明
project_idinteger项目ID
project_namestring项目名称
started_atstring首次外呼开始时间
remain_numstring剩余数量/剩余重呼
called_numinteger外呼通话量
called_rateinteger近5分钟外呼速度
called_totalinteger外呼数据量（不包括重呼的）
called_missinteger呼损量
free_agent_numinteger空闲坐席数
online_agent_numinteger在线坐席数
client_answer_ratestring客户接通率
agent_answer_ratestring坐席接通率
answer_ratestring呼叫接通率
called_miss_ratestring呼损率
time_aveinteger平均处理时长
time_freeinteger当日平均闲置时长

1.3.2 自动外呼监控 Monitor 格式为

参数类型说明
project_idinteger项目ID
project_namestring项目名称
started_atstring首次外呼开始时间
remain_numstring剩余数量/剩余重呼/未到重呼时间/呼叫中
called_numinteger外呼通话量
called_rateinteger近5分钟外呼速度
called_totalinteger外呼数据量（不包括重呼的）
answer_ratestring呼叫接通率

1.3.3 机器人监控 Monitor 格式为

参数类型说明
project_idinteger项目ID
project_namestring项目名称
remain_numinteger剩余数据量
remain_call_numinteger未呼叫量
remain_recall_numinteger待重呼量
today_call_numinteger今日已呼叫量
duration_unbusyinteger平均等待时长
num_answeredinteger接通量
num_answered / today_call_num/接通率(%)，接口未返回，需自行计算
trans_agent_numinteger转人工量
trans_agent_num / num_answered/转人工率(%)，接口未返回，需自行计算
agent_answered_numinteger坐席接通量
agent_answered_num / trans_agent_num/座席接通率(%)，接口未返回，需自行计算
trans_agent_num - agent_answered_numinteger呼损量，接口未返回，需自行计算
(trans_agent_num - agent_answered_num) / trans_agent_num/呼损率(%)，接口未返回，需自行计算
intercept_risk_controlinteger外呼拦截量-频次风控
intercept_blacklistinteger外呼拦截量-企业黑名单
intercept_blacklist_risk_controlinteger外呼拦截量-外部黑名单
intercept_webhook_rejectinteger外呼拦截量-WebHook拦截
minute_trans_agent_numinteger最近一分钟-转人工量
minute_ans_numinteger最近一分钟-接通量
minute_trans_agent_num / minute_ans_num/最近一分钟-转人工率(%)，接口未返回，需自行计算
minute_agent_answered_numinteger最近一分钟-坐席接通量
minute_agent_answered_num / minute_trans_agent_num/最近一分钟-座席接通率(%)，接口未返回，需自行计算
minute_trans_agent_num - minute_agent_answered_num/最近一分钟-呼损量，接口未返回，需自行计算
(minute_trans_agent_num - minute_agent_answered_num) / minute_trans_agent_num/最近一分钟-呼损率(%)，接口未返回，需自行计算
avg_call_durationinteger平均通话时长
avg_interactinteger平均交互轮次
free_agent_numinteger空闲坐席数

1.4 举例

1.4.1 入参

{
  "project_id": 11259
}

1.4.2 出参

{
    "code":0,
    "message":"success",
    "request_id":"995bc1ff138c5d2c144ac82065b3f06c",
    "data":{
        "current_page":1,
        "total_page":1,
        "per_page":20,
        "total":11,
        "empty":false,
        "results":[
            {
                "project_id":10760,
                "project_name":"zcq测试机器人",
                "remain_num":0,
                "remain_call_num":0,
                "remain_recall_num":0,
                "60s_ans_num":0,
                "duration_unbusy":0,
                "today_call_num":0,
                "trans_agent_num":0,
                "num_answered":0,
                "agent_answered_num":0,
                "intercept_blacklist":0,
                "intercept_risk_control":0,
                "minute_trans_agent_num":0,
                "minute_agent_answered_num":0,
                "avg_call_duration":0,
                "free_agent_num":0,
                "charge_minutes":0,
                "avg_interact":0
            }
        ]
    }
}

二、当天监控图

2.1 路由

GET /api/v3/monitor/today

2.2 入参

参数类型说明必填
project_idint项目id是

2.3 出参

2.3.1 预测式外呼 出参

不支持此接口

2.3.2 自动外呼 出参

不支持此接口

2.3.3 机器人外呼 出参

参数类型说明
timestring时间
answer_numint接通量
answer_rateint接通率
called_totalint外呼量
recall_numint重呼量
agent_answered_numint坐席接通量
agent_answered_rateint坐席接通率
agent_unanswered_numint坐席未接通量（呼损量）
agent_unanswered_rateint坐席未接通率（呼损率）
trans_agent_numint转人工量
trans_agent_rateint转人工率

2.4 举例

2.4.1 入参

{
  "project_id": 1
}

2.4.2 出参

{
    "code":0,
    "message":"success",
    "request_id":"22b0fe3e76d09e96b864730d0c54d5d2",
    "data":[
        {
            "answer_num":0,
            "answer_rate":0,
            "called_total":0,
            "recall_num":0,
            "time":"2023-09-22 00:01:00",
            "agent_answered_num":0,
            "agent_answered_rate":0,
            "agent_unanswered_num":0,
            "agent_unanswered_rate":0,
            "trans_agent_num":0,
            "trans_agent_rate":0
        },
        {
            "answer_num":0,
            "answer_rate":0,
            "called_total":0,
            "recall_num":0,
            "time":"2023-09-22 00:02:00",
            "agent_answered_num":0,
            "agent_answered_rate":0,
            "agent_unanswered_num":0,
            "agent_unanswered_rate":0,
            "trans_agent_num":0,
            "trans_agent_rate":0
        }
    ]
}

三、坐席监控

3.1 路由

GET/POST /api/v3/monitor/users

3.2 入参

参数类型说明必填
project_idint项目id是

3.3 出参

3.3.1 预测式外呼 出参

参数类型说明
ag_sta_timestring坐席状态时间
ag_numstring坐席工号
ag_namestring坐席姓名
ag_sta_strstring坐席当前状态
status_timesint当前状态持续时间

3.4 举例

3.4.1 入参

{
  "project_id": 1
}

3.4.2 出参

{
    "code": 0,
    "message": "success",
    "request_id": "7a9992c2e3ba99b01d06bbf06a4bb394",
    "data": [
        {
            "status_times": 2207,
            "ag_sta_str": "置闲",
            "ag_sta_time": "1711689689",
            "ag_name": "张三",
            "ag_num": "5646"
        }
    ]
}