Query seat status information
- URL：
https://api-hk.nxlink.ai/saas/cc/openapi/agent/status/info
- Method：
POST
- Content-Type：
application/json
- Required：
yes
🌐 Service Access Points
NXLink has deployed multiple service regions globally. Please select the corresponding service access point based on your business location. Different regions use different website domains and API gateway domains.
| Code |
Region |
NXLink Website |
API Gateway |
| APAC |
Hong Kong |
https://app.nxlink.ai |
https://api-hk.nxlink.ai |
| AMER |
Americas |
https://chl-nxlink.nxcloud.com |
https://chl-api.nxlink.ai |
| APAC(IDN) |
Indonesia |
https://idn.nxlink.ai |
https://api-idn.nxlink.ai |
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 |
Y |
NX10000001 |
User account (email or account starting with NX) |
| startDateTime |
long |
Y |
1704643200 |
Start time (timestamp) |
| endDateTime |
long |
Y |
1704729600 |
End time (timestamp) |
Request Example
body（application/json）：
{
"tenantId": 144,
"userName": "NXAgent0001",
"startDateTime":"1704643200",
"endDateTime":"1704729600"
}
Response Parameters
| name |
type |
Description |
| code |
Integer |
Result code |
| data |
Object |
Request result |
| msg |
String |
Request description |
Successful Request
| name |
type |
Required |
Description |
| nickName |
string |
N |
Agent nickname |
| userName |
string |
Y |
Agent account |
| sipNumber |
string |
Y |
SIP account (unique value, cannot be modified) |
| busyDuration |
Integer |
|
Busy duration (s) |
| wrapupDuration |
Integer |
|
Wrap-up duration (s) |
| idleDuration |
Integer |
|
Idle duration (s) |
| callingDuration |
Integer |
|
Calling duration (s) |
| ringingDuration |
Integer |
|
Ringing duration (s) |
| meetingDuration |
Integer |
|
Rest - Meeting duration (s) |
| eatingDuration |
Integer |
|
Rest - Eating duration (s) |
| wcDuration |
Integer |
|
Rest - Bathroom duration (s) |
| sleepDuration |
Integer |
|
Rest - Sleeping duration (s) |
| otherDuration |
Integer |
|
Rest - Other meeting duration (s) |
| loginTimeStamp |
Long |
|
Agent login time (timestamp) |
| logoutTimeStamp |
Long |
|
Agent logout time (timestamp) |
Response Example
Success Example
{
"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
}
]
}
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 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 |