NXCC API queueAgents

Querying the Binding Relationship between Agent Groups and Agents

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

Authentication Mechanism

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

Request Parameters

header Parameters：

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 Niuxin page
queueNo	string	Y	NX10000001	Agent group number (unique value)

Request Example

body（application/json）：

{
    "tenantId": 144,
    "queueNo": "NXQueue0001"
}

Response Parameters

Parameter Name	Type	Description
code	Integer	Result code
data	Object	Response data
msg	String	Result message

Successful Response

• data ：

Parameter Name	Type	Required	Description
nickName	String	No	Agent nickname
userName	String	Yes	Agent username
sipNumber	String	Yes	SIP extension number (unique value, cannot be modified)

Response Example

Success Example

{
    "reqId": "a23738fb613d889026fa2c8f4e4378f1",
    "code": 0,
    "msg": "Success",
    "data": [
        {
            "sipNumber": "NXAgent000011",
      	    "nickName": "example1",
     	    "userName": "example@nxcloud.com"
        },
        {
            "sipNumber": "NXAgent1000013",
      	    "nickName": "example2",
     	    "userName": "NXAgent1000013"
        }
    ]
}

Failure Example

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

Response Code Description

Code	Message	Resolution
0	Request successful
88	Request failed	Please contact technical support to troubleshoot
99	System error	Please contact technical support to troubleshoot
1000~100X	Authentication failed	See the API authentication section for details