Skip to content

NXCC API agentStatus

aofei0721 edited this page Aug 6, 2024 · 5 revisions

查询坐席状态信息

  • URL:https://api2.nxcloud.com/saas/cc/openapi/agent/status/info
  • 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 Integer Y 144 团队ID, 从牛信页面查询到并配置
userName string Y NX10000001 用户账号(邮箱或者NX开头的账号)
startDateTime long Y 1704643200 开始时间(时间戳)
endDateTime long Y 1704729600 结束时间(时间戳)

请求示例

body(application/json):

{
  "tenantId": 144,
  "userName": "NXAgent0001",
  "startDateTime":"1704643200",
  "endDateTime":"1704729600"
}

响应参数

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

请求成功

  • data :
name type Required Description
nickName string N 坐席昵称
userName string Y 坐席账号
sipNumber string Y sip账号(唯一值,不可修改)
busyDuration Integer 示忙时长(s)
wrapupDuration Integer 话后整理时长(s)
idleDuration Integer 示闲时长(s)
callingDuration Integer 通话时长(s)
ringingDuration Integer 振铃时长(s)
meetingDuration Integer 休息-会议时长(s)
eatingDuration Integer 休息-吃饭时长(s)
wcDuration Integer 休息-厕所时长(s)
sleepDuration Integer 休息-睡觉时长(s)
otherDuration Integer 休息-其他会议时长(s)
loginTimeStamp Long 坐席登录时间(时间戳)
logoutTimeStamp Long 坐席登出时间(时间戳)

响应示例

成功示例

{
    "reqId": "a23738fb613d889026fa2c8f4e4378f1",
    "code": 0,
    "msg": "Success",
    "data": [
        {
            "sipNumber": "NXAgent000011",
            "nickName": "example1",
            "userName": "[email protected]",
            "busyDuration": 10,
            "wrapupDuration": 0,
            "idleDuration": 0,
            "callingDuration": 0,
            "ringingDuration": 0,
            "meetingDuration": 0,
            "eatingDuration": 0,
            "wcDuration": 0,
            "sleepDuration": 0,
            "otherDuration": 0,
            "loginTimeStamp": 1710491315,
            "logoutTimeStamp": 1711023817
            
        },
        {
            "sipNumber": "NXAgent000012",
            "nickName": "example2",
            "userName": "[email protected]",
            "busyDuration": 10,
            "wrapupDuration": 10,
            "idleDuration": 200,
            "callingDuration": 50,
            "ringingDuration": 10,
            "meetingDuration": 0,
            "eatingDuration": 0,
            "wcDuration": 0,
            "sleepDuration": 0,
            "otherDuration": 0,
            "loginTimeStamp": 1710491315,
            "logoutTimeStamp": 1711023817
        }
    ]
}

失败示例

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

响应码说明

code message Resolution
0 请求成功 请求成功
88 请求失败 请联系技术人员排除问题
99 系统错误 请联系技术人员排除问题
1000~100X 鉴权失败 详情查看 API 鉴权部分

简介

短信

语音

云呼叫中心(NXLink)

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

Flash Call

短链

邮件验证码

DID号码

通用

号码检测

WhatsApp

Viber

Zalo ZNS

Super Message API

隐私号(旧)

PNS

坐席(旧版)

AI Agent(对外api)

Clone this wiki locally