- Product
- Use Cases
- Support
- About Us
ENGLISH
Home
Support
SMS API
Description: Query agent list.
| Parameters | Description | Required | Type |
|---|---|---|---|
current |
Current page number, 1-N |
Yes |
Integer |
size |
Number of displays per page，1-100 |
Yes |
Integer |
params |
Paging parameters |
Yes |
JSONObject |
enable |
Enable Disable 0 enables, 1 disables |
No |
Integer |
name |
Agent name, fuzzy match |
No |
String |
voiceGroupId |
Agent group (agent group query returns voiceGroupId) |
No |
Integer |
status |
Agent status: 1-offline, 2-idle, 3-busy, 4-post-talk, 5-take a break |
No |
Integer |
strTime |
Agent call statistics - the difference between the start time and the end time is 32 days |
Yes |
DateTime |
endTime |
Agent call statistics-end time |
Yes |
DateTime |
https://api.onbuka.com/v3/cc/seat/query
Request URL:
https://api.onbuka.com/v3/cc/seat/query
Request Method:
POST
Request Headers:
Content-Type: application/json;charset=UTF-8
Sign: 05d7a50893e22a5c4bb3216ae3396c7c
Timestamp: 1630468800
Api-Key: bDqJFiq9
Request Body:
{
"current":1,
"size":15,
"params":{
"enable": 0,
"name":"12",
"voiceGroupId": 12,
"strTime":"2025-01-01 00:00:00",
"endTime":"2025-02-01 12:12:12"
}
}
| Parameters | Description | Type |
|---|---|---|
status |
status code，0 is successful. For other failures, please refer to the interface response code |
String |
reason |
Failure reason description |
String |
data |
collection of objects |
JSONArray |
total |
Total number of records |
Integer |
size |
Number of displays per page |
Integer |
current |
Current page number |
Integer |
pages |
Total page number |
Integer |
records |
Data collection |
JSONArray |
keyId |
Primary key id |
Integer |
empNo |
Job number |
String |
petName |
Nick name |
String |
name |
name |
String |
appId |
Application appid |
String |
deleteFlag |
Logical deletion flag, 1 deleted, 0 not deleted |
Integer |
enable |
Enable Disable 0 enables, 1 disables |
Integer |
priority |
Priority default 1 |
Integer |
voiceGroupId |
Agent group ID |
Integer |
groupName |
Agent group name |
String |
account |
Account |
String |
password |
Password |
String |
createTime |
Creation time |
DateTime |
updateTime |
Update Time |
DateTime |
displayNum |
Display number |
String |
ccode |
Country code |
String |
status |
Agent status: 1-offline, 2-idle, 3-busy |
Integer |
num |
Total calls |
Integer |
connectNum |
Number of connections |
Integer |
connectRate |
Connection rate |
String |
validConnectNum |
Effective number of calls |
Integer |
validConnectRate |
Effective call rate |
String |
validConnectConfig |
Valid call definition |
Integer |
{
"status":"0",
"reason":"success",
"data": {
"total": 5,
"size": 20,
"current": 1,
"pages": 1,
"records": [
{
"keyId": 681,
"empNo": "003",
"petName": "12345678901234567890",
"name": "0705C999_001",
"appId": "1000009",
"deleteFlag": 0,
"createTime": "2023-09-07 11:44:37",
"updateTime": "2024-10-29 17:33:02",
"enable": 0,
"priority": 1,
"sipGroupId": 1000006,
"account": "0705C559_003",
"password": "452061e7b50b70001c1e2168632ea56d",
"displayNum": "12802112125",
"ccode": null,
"appName": null,
"groupName": "tele-basic-test",
"status": "1",
"num": 0,
"connectNum": 0,
"connectRate": "0%",
"validConnectNum": 0,
"validConnectRate": "0%",
"validConnectConfig": null
}
]
}
}
Feedback
service@onbuka.com
service@onbuka.com
LinkedIn
Facebook
Copyright: ©2007-2025 BESTSHARE INTERNET MEDIA LIMITED
Need help?
Click here and start chatting with us!
Twitter
YouTube