Querying the List of Held Calls
Prerequisites
- The agent has signed in and the answering mode is non-automatic answering.
- The agent is in a call and holds the call.
Description
This interface is used by an agent that has signed in to query the list of held calls.
Interface Method
The request method must be set to GET. This interface supports only the GET method.
URI
https://ip:port/agentgateway/resource/calldata/{agentid}/holdlist
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 |
Yes |
Agent ID. The value ranges from 101 to 59999. |
Method Name in Logs
queryHoldListInfo
Request Description
- Message header
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 |
object |
List of held calls returned after a successful query. For details about the parameters of this object, see Table 4. |
No. |
Parameter |
Value Type |
Description |
---|---|---|---|
3.1 |
callfeature |
int |
Call type. For details, see Table 1. |
3.2 |
callid |
string |
Call ID. |
3.3 |
caller |
int |
Calling number. |
3.4 |
called |
int |
Called number. |
3.5 |
callskill |
string |
Call skill description. |
3.6 |
callskillid |
int |
It is not used. |
3.7 |
orgicallednum |
string |
It is not used. |
3.8 |
calldata |
string |
It is not used. |
3.9 |
begintime |
long |
It is not used. |
3.10 |
endtime |
long |
It is not used. |
Triggered Event
- None
Error Code
- 100-006
- 300-001
- 400-003
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", "callskillid": 0, "orgicallednum": "", "calldata": null, "begintime": null, "endtime": null }, { "callfeature": 7, "callid": "1501127920-0", "caller": "10086", "called": "70941", "callskill": "", "callskillid": 0, "orgicallednum": "", "calldata": null, "begintime": null, "endtime": null } ] }
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