Skip to content

NXCC API agentStatusPage

敖飞 edited this page May 22, 2025 · 1 revision

查询坐席状态信息

  • URL:https://api2.nxcloud.com/saas/cc/openapi/agent/status/page
  • Method:POST
  • Content-Type:application/json
  • Required:yes

鉴权机制

鉴权规则请参考地址:API 接口调用约定

请求参数

header:

参数名 类型 必选 示例值 说明
accessKey String Y fme2na3kdi3ki 用户身份标识
ts String Y 1655710885431 当前请求的时间戳(单位是毫秒),牛信服务端允许用户端请求最大时间误差为 60 秒
bizType String Y 8 业务类型,取固定值“8”
action String Y cc 业务操作,取固定值“cc”
sign String Y 6e9506557d1f289501d333ee2c365826 API 入参参数签名,签名算法

body :

参数名 类型 必选 示例值 说明
tenantId long Y 144 团队ID, 从牛信页面查询到并配置
userGroupName string N test分组 成员组名称(精确匹配)
groupCode string N NxXXXXXG001 坐席组编号(唯一值)
agentName string N [email protected] 坐席邮箱(精确匹配)
statusEnum Integer N 1 坐席状态,0: 离线 1: 空闲 2: 通话中 3: 示忙 4: 话后整理 5: 振铃中 6: 系统示忙 7: 网络中断 8: 休息-会议 9: 休息-吃饭 10: 休息-厕所 11: 休息-睡觉 12: 休息-其它 13: 登录 14: 登出 15: 监听中
startTimestamp long Y 1742140800 开始时间(时间戳)
endTimestamp long Y 1742400000 结束时间(时间戳)
current long N 1 分页参数,当前页。默认1
size long N 10 分页参数,每页条数。默认10

请求示例

body(application/json):

{
    "userGroupName":"hqq分组",
    "groupCode":"NX1036000G001",
    "agentName":"[email protected]",
    "statusEnum":1,
    "startTimestamp":"1742140800",
    "endTimestamp":"1742400000"
}

响应参数

name type Description
code Integer 结果编码
data Object 请求结果
msg String 请求结果说明

请求成功

  • data :
name type Required Description
nickName string N 坐席昵称
userName string Y 坐席账号
loginStatus Integer 登录状态。1,在线;2,离线;3,网络中断
workStatus Integer 坐席状态,0: 离线 1: 空闲 2: 通话中 3: 示忙 4: 话后整理 5: 振铃中 6: 系统示忙 7: 网络中断 8: 休息-会议 9: 休息-吃饭 10: 休息-厕所 11: 休息-睡觉 12: 休息-其它 13: 迁入 14: 迁出 15: 监听中
startTimeStamp long 状态开始时间戳
endTimeStamp long 状态结束时间戳
duration Integer 时长(s)
userGroupNames string 成员组
groupCode string 坐席组
statusEnum Integer 坐席状态,0: 离线 1: 空闲 2: 通话中 3: 示忙 4: 话后整理 5: 振铃中 6: 系统示忙 7: 网络中断 8: 休息-会议 9: 休息-吃饭 10: 休息-厕所 11: 休息-睡觉 12: 休息-其它 13: 迁入 14: 迁出 15: 监听中

响应示例

成功示例

{
    "reqId": "D897694F631E47E093D430CED9143E14",
    "code": 0,
    "msg": "请求成功",
    "data": {
        "records": [
            {
                "userName": "[email protected]",
                "nickName": null,
                "loginStatus": 2,
                "workStatus": 0,
                "startTimeStamp": 1743555692,
                "endTimeStamp": 1743555927,
                "duration": 235,
                "userGroupNames": "默认分组",
                "groupCode": "Sandy路由",
                "statusEnum": 0
            },
            {
                "userName": "[email protected]",
                "nickName": null,
                "loginStatus": 1,
                "workStatus": 3,
                "startTimeStamp": 1743555631,
                "endTimeStamp": 1743555692,
                "duration": 61,
                "userGroupNames": "默认分组",
                "groupCode": "Sandy路由",
                "statusEnum": 3
            }
        ],
        "total": 10,
        "size": 10,
        "current": 1,
        "orders": [],
        "optimizeCountSql": true,
        "searchCount": true,
        "countId": null,
        "maxLimit": null,
        "pages": 1
    }
}

失败示例

{
  "reqId": "FFDD1791E22F4D9DBA967C245C58E544",
  "code": 1001,
  "msg": "Authorization Failed",
  "data": {}
}

响应码说明

code message Resolution
0 请求成功 请求成功
88 请求失败 请联系技术人员排除问题
99 系统错误 请联系技术人员排除问题
1000~100X 鉴权失败 详情查看 API 鉴权部分
41000 参数错误或为空 请核对请求参数
42166 仅支持查询六个月内数据 请重新调整查询起止时间
42167 开始时间不能大于结束时间 请重新调整查询起止时间
42168 单次查询时间跨度不能超过3天 请重新调整查询起止时间

简介

短信

语音

云呼叫中心(NXLink)

云呼叫中心(AI自动外呼)

Flash Call

短链

邮件验证码

DID号码

通用

号码检测

WhatsApp

Viber

Zalo ZNS

Super Message API

隐私号(旧)

PNS

坐席(旧版)

AI Agent

Clone this wiki locally