Querying Softphone Information of All Agents, Excluding Business Accounts (querySysInfo)
Scenario
Query system information such as the agent sign-in service address.
Method
GET
URI
https://Domain name/apiaccess/CC-Management/v1/querySysInfo. For example, the domain name is service.besclouds.com.
Request Description
No. |
Name |
Type |
Mandatory or Not |
Description |
---|---|---|---|---|
1 |
X-APP-Key |
String |
No |
App key. |
2 |
Authorization |
String |
Yes |
Authentication field. The format is Bearer {Value of AccessToken returned by the tokenByAkSk interface}. (A space is required after Bearer.) |
Response Description
- Status code: 200
No. |
Name |
Type |
Mandatory or Not |
Description |
---|---|---|---|---|
1.1 |
serviceIp |
String |
No |
Agent sign-in service instance address, which is the address of the Nginx or SLB. Length limit: string (50) |
1.2 |
sipServicePort |
String |
No |
Softphone registration port. The value ranges from 1 to 65535. Length limit: string (5) |
1.3 |
sipServiceIp |
String |
No |
Softphone registration address. Length limit: string (50) |
1.4 |
servicePort |
String |
No |
Agent sign-in service port. Length limit: string (5) |
1.5 |
agents |
Array [Object] |
No |
Agent set. |
1.5.1 |
workNo |
Integer |
Yes |
Agent ID, ranging from 101 to 59999. |
1.5.2 |
sipAccount |
String |
No |
SIP softphone number. Length limit: string (24) |
1.5.3 |
sipPwd |
String |
No |
SIP softphone password before encryption. Length limit: string (24) |
1.5.4 |
password |
String |
No |
Password for an agent to sign in to the platform before encryption. Length limit: string (8) |
- Status code: 400
No. |
Name |
Type |
Mandatory or Not |
Description |
---|---|---|---|---|
1 |
schema |
String |
Yes |
Incorrect request. Check the request path and parameters. |
- Status code: 401
No. |
Name |
Type |
Mandatory or Not |
Description |
---|---|---|---|---|
1 |
schema |
String |
Yes |
Unauthorized operation. 1. Check whether you have purchased related services. 2. Contact customer service to check the status of your account. |
- Status code: 404
No. |
Name |
Type |
Mandatory or Not |
Description |
---|---|---|---|---|
1 |
schema |
String |
Yes |
The requested content is not found. Check the request path. |
- Status code: 500
No. |
Name |
Type |
Mandatory or Not |
Description |
---|---|---|---|---|
1 |
schema |
String |
Yes |
Business failure. Check the values of parameters in the request. |
Error Codes
None
Example
{ "x-app-key": "f******************************f", "Authorization": "Bearer 0******************************8" }
Response parameters:
{ "servicePort": 448, "serviceIp": "127.0.0.0", "sipServiceIp": "127.0.0.0", "sipServicePort": 5060, "agents": [{ "workNo": 1522, "password": "7****tt", "sipAccount": "88881619", "sipPwd": "1****tt" }, { "workNo": 1523, "password": "f*****xL", "sipAccount": "88881620", "sipPwd": "1*****xL" }] }
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot