Hanging up a Call
Use the ‘/call/hangup’ resource to request VCC Live to hang up a call. Calls can only be hung up when the call is taking place, ie. the agent is “in call” status. In any other status, the system shows an error message:”Information – Only in call state“.
In other words, hanging up a call does not work in the following statuses: Unavailable, Available, Available for Call, Aux, Prework
Request | |
---|---|
Method | GET |
Resource | http://localhost:[port]/call/hangup |
Options | dispositionid |
Body | N/A |
Response | |
Body | N/A |
Example: http://localhost:37589/call/hangup
Click to Call API requests do not provide a response object, so it is not applicable in this case.
Optional Parameters
You can use the ‘dispositionid’ parameter to allocate a disposition. If a callback disposition is allocated, the callback date is set based on the disposition’s default setting.
Resource: http://localhost:[port]/call/hangup?dispostionid=[id]
Example: http://localhost:37589/call/hangup?dispositionid=1
A few things to keep in mind when using the ‘dispositionid’ parameter:
- Using the ‘dispositionid’ while the agent is not in call does not work, and results in the following error message: “Information: Disposition set failed!“.
- Pay attention to use the ‘dispositionid’ expressions in lowercase. It does not work in camelcase.
Comments
Can’t find what you need? Use the comment section below to connect with others, get answers from our experts, or share your ideas with us.
There are no comments yet.