Querying Customized Status by an Agent
Prerequisites
The agent has signed in.
Description
This interface is used by an agent to query customized status.
Interface Method
The request method must be set to GET. This interface supports only the GET method.
URI
https://ip:port/agentgateway/resource/onlineagent/{agentid}/querycustomstate
In the URL, ip indicates the IP address of the CC-Gateway server, and port indicates the HTTPS port number of the CC-Gateway server.
No. |
Parameter |
Data Type |
Mandatory (Yes/No) |
Description |
---|---|---|---|---|
1 |
agentid |
string |
True |
Agent ID. The value ranges from 101 to 59999. |
Method Name in Logs
queryCustomState
Request Description
- Message header
Table 2 Parameters in the request message header No.
Parameter
Value Type
Mandatory (Yes/No)
Description
1
Content-Type
string
True
Coding mode of the message body. The default value is application/json; charset=UTF-8.
2
Guid
string
True
GUID returned by the sign-in interface during static authentication (AUTHMODE is set to 1) or GUID returned by the polling event query interface during dynamic authentication (AUTHMODE is set to 2).
Response Description
No. |
Parameter |
Value Type |
Description |
---|---|---|---|
1 |
message |
string |
Customized agent status. |
2 |
retcode |
string |
Error code. The options are as follows: 0: success Other values: failure |
3 |
result |
object |
Result returned after a successful query. |
Triggered Event
None
Error Code
- 000-003
- 100-006
- 100-007
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