Querying All Calls Placed on Hold by a Specified Agent
Prerequisites
- The inspector and specified agent have signed in.
- The specified agent is in a call and holds the call.
Description
This interface is used by an inspector who has signed in to query the calls placed on hold by a specified agent in the same VCC.
If the CC-Gateway is deployed in cluster mode, the inspector and specified agent are not on the same CC-Gateway after sign-in. In this case, the list of held calls cannot be queried.
Interface Method
The request method must be set to GET. This interface supports only the GET method.
URI
https://IP address:Port number/agentgateway/resource/calldata/{agentid}/holdlistex/{workno}
If the CC-Gateway is deployed in single-node mode, set IP address to the CC-Gateway server address and Port number to the HTTPS port number of the CC-Gateway server (the default value is 8043). If the CC-Gateway is deployed in cluster mode, set IP address to the NSLB address and Port number to the default value 8043.
For the CC-Gateway port number on the NSLB, log in to any NSLB node as the nslb user and run the ./nslbctl l command to query the port number. In the query result, the following port is opened by the CC-Gateway to third-party systems through the NSLB.

In the SaaS scenario, contact O&M personnel to obtain the values of IP address and Port number.
|
No. |
Parameter |
Value Type |
Mandatory (Yes/No) |
Description |
|---|---|---|---|---|
|
1 |
agentid |
String |
Yes |
Agent ID. The value ranges from 101 to 999999. |
|
2 |
workno |
String |
Yes |
ID of an agent to be queried. The value ranges from 101 to 999999. The agent ID must belong to the same VCC as the value of agentid. |
Method Name in Logs
queryHoldListInfoEx
Request Description
-
Table 2 Parameters in the request message header No.
Parameter
Value Type
Mandatory (Yes/No)
Description
1
Content-Type
String
Yes
Coding mode of the message body. The default value is application/json; charset=UTF-8.
2
Guid
String
Yes
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 |
Description. |
|
2 |
retcode |
String |
Error code. The options are as follows: 0: success Other values: failure |
|
3 |
result |
List |
Indicates the query result. After the query is successful, the system returns the list of call information objects in the queue. For details about the parameters of this object, see Table 4. |
|
No. |
Parameter |
Value Type |
Description |
|---|---|---|---|
|
3.1 |
callfeature |
Integer |
Call type. For details, see Call Type. |
|
3.2 |
callid |
String |
Call ID. |
|
3.3 |
caller |
Integer |
Calling number. |
|
3.4 |
called |
Integer |
Called number. |
|
3.5 |
callskill |
String |
Call skill description. |
Triggered Event
- None
Example
- Message header
Content-Type:application/json; charset=UTF-8 Guid: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
- Request parameter
- Response parameter
{ "message": "", "retcode": "0", "result": [ { "callfeature": 7, "callid": "1501127996-2", "caller": "10086", "called": "70943", "callskill": "voice" }, { "callfeature": 7, "callid": "1501127920-0", "caller": "10086", "called": "70941", "callskill": "" } ] }
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