NXCC API agentInfo

Query seat list

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

Authentication Mechanism

For authentication rules, please refer to: API Interface Call Agreement

Request Parameters

header：

Parameter Name	Type	Required	Example Value	Description
accessKey	String	Y	fme2na3kdi3ki	User identity identifier
ts	String	Y	1655710885431	Timestamp of the current request (in milliseconds). The NX server allows a maximum time error of 60 seconds for client requests.
bizType	String	Y	8	Business type, fixed value “8”
action	String	Y	cc	Business operation, fixed value “cc”
sign	String	Y	6e9506557d1f289501d333ee2c365826	API parameter signature, Signature Algorithm

body ：

Parameter Name	Type	Required	Example Value	Description
tenantId	Integer	Y	144	Team ID, obtained and configured from the Nx page
userName	String	N		User account (email or account starting with NX)
size	Integer	Y	200	Page Size (maximum 200)
page	Integer	Y	1	Page Number (starting from 1)

Response Parameters

body（application/json）：

{
  "userName": "xxx@nxcloud.com",
  "tenantId": 144,
  "size": 100,
  "page": 1
}

Response Parameters

Parameter Name	Type	Description
code	Integer	Result code
data	Object	Request result
msg	String	Request description
total	Integer	Total

Successful Request

• data parameters:

Parameter Name	Type	Description
allowCountry	list	Allowed countries iso_2, can have multiple allowed countries
endPointName	string	Access point name
gmtCreate	string	none
gmtModified	string	none
queueName	list	Agent group name, agents can belong to multiple agent groups
nickName	string	Agent nickname
recording	boolean	Whether recording: 0 off, 1 on
recordingStorageDays	integer	Recording retention days
sipNumber	string	SIP extension number (unique value, cannot be modified)
status	integer	Agent status: 0 off, 1 on
userName	string	Agent account

Response Example

Success Example

{
    "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@nxcloud.com"
        },
        {
            "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@nxcloud.com"
        }
    ],
    "total": 2
}

Failure Example

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

Response Code Description

code	message	Resolution
0	Request successful
88	Request failed	Please contact technical support to resolve the issue
99	System error	Please contact technical support to resolve the issue
1000~100X	Authentication failed	See the API Authentication section for details