Requesting a Specified Call
Prerequisites
- The agent has signed in.
- This interface cannot be invoked when an agent has no call but is performing self-recording.
- This interface cannot be invoked in the call holding scenario.
Description
An agent can invoke this interface to apply for a new call. After the application is successful, the call that meets the application conditions is allocated to the agent.
Interface Method
The request method must be set to POST. This interface supports only the POST method.
URI
https://ip:port/agentgateway/resource/voicecall/{agentid}/requestcall/{callid}/{skilltype}?skillId={skillId}
In the URL, ip indicates the IP address of the agent gateway server, and port indicates the HTTPS port number of the agent gateway server.
No. |
Parameter |
Data Type |
Mandatory (Yes/No) |
Description |
---|---|---|---|---|
1 |
agentid |
string |
Yes |
Agent ID. The value ranges from 101 to 59999. |
2 |
callid |
string |
Yes |
ID of a queuing call. |
3 |
skilltype |
int |
Yes |
Skill queue type. Only the value 0 (public queue) is supported. |
4 |
skillId |
int |
Yes |
Skill queue ID. This parameter is valid only for public queues. |
Method Name in Logs
requestAppointedCall
Request Description
- Request 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 |
Reserved field. |
Triggered Event
- AgentOther_PhoneAlerting
- AgentOther_PhoneOffhook
- AgentEvent_Talking
Error Code
- 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