Skip to content

NXCC API agentInfo

aofei edited this page Mar 22, 2024 · 2 revisions

查询坐席列表

  • URL:https://api2.nxcloud.com/saas/cc/openapi/agent/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 Integer Y 144 团队ID, 从牛信页面查询到并配置
userName String N 用户账号(邮箱或者NX开头的账号)
size Integer Y 200 Page Size (最大200)
page Integer Y 1 Page Number (从 1开始)

请求示例

body(application/json):

{
  "userName": "[email protected]",
  "tenantId": 144,
  "size": 100,
  "page": 1
}

响应参数

参数名 类型 说明
code Integer 结果编码
data Object 请求结果
msg String 请求结果说明
total Integer 总条数

请求成功

  • data 参数:
参数名 类型 说明
allowCountry list 允许的国家 iso_2,可以有多个允许的国家
endPointName string 接入点名称
gmtCreate string(date-time) none
gmtModified string(date-time) none
queueName list 坐席组名称,坐席可以属于多个坐席组
nickName string 坐席昵称
recording boolean 是否录音: 0 关闭, 1 开启.
recordingStorageDays integer(int32) 录音保留天数
sipNumber string SIP 分机号(唯一值,不能被修改)
status integer(int32) 坐席状态:0 关闭,1 开启
userName string 坐席账号

响应示例

成功示例

{
    "reqId": "a23738fb613d889026fa2c8f4e4378f1",
    "code": 0,
    "msg": "Success",
    "data": [
        {
        	"allowCountry": ["US, SG"],
            "endPointName": "HONGKONG",
        	"enableStatusLog": false,
        	"gmtCreate": "2019-08-24 14:15:22",
        	"gmtModified": "2019-08-24 14:15:22",
        	"queueName": ["groupName"],
        	"nickName": "string",
        	"recording": false,
       	 	"recordingStorageDays": 0,
        	"sipNumber": "NX00001",
        	"status": 0,
        	"userName": "[email protected]"
        },
        {
            "allowCountry": ["US, SG"],
            "endPointName": "HONGKONG",
        	"enableStatusLog": false,
        	"gmtCreate": "2019-08-24 14:15:22",
        	"gmtModified": "2019-08-24 14:15:22",
        	"queueName": ["groupName1", "groupName2"],
        	"nickName": "string",
        	"recording": false,
       	 	"recordingStorageDays": 0,
        	"sipNumber": "NX00002",
        	"status": 0,
        	"userName": "[email protected]"
        }
    ],
    "total": 2
}

失败示例

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

响应码说明

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