DELETE
Cancels a callback request. You can cancel a callback request only when the contact state is "Unread" or "Queued".
After the DELETE request is successfully processed (response code 200 is received by the application), the application cannot use GET to poll for the status of the contact. You can use the Social Contact GET API to poll the status of the social contact. See GET.
Note | The customer will receive an error if the cancellation request is sent after an agent is already selected. |
|
URL: |
https://<ServerIP>:<Port>/ccp/rest/callback/contact/<Id> |
|
HTTPS method: |
DELETE |
|
Example request XML payload: |
None |
|
Response codes: |
200 OK 400 Bad Request 404 Not Found See HTTPS Responses for more information about the response codes. |
The following table shows the statusReason codes that can be triggered by the cancellation requests for callback contacts in different states.
|
Social contact state |
StatusReason for cancel request |
Meaning |
|---|---|---|
|
QUEUED |
NOTIFICATION_CCE_ CALLBACK_CANCEL_REQUESTED |
Cancel callback request was initiated. |
|
DISCARDED |
NOTIFICATION_CCE_CALLBACK_ CANCEL_SUCCEEDED |
Unified CCE cancelled the callback successfully. |
|
HANDLED |
EXTERNALLY_ HANDLED |
The cancellation request failed because the task was routed to an agent before the callback could be cancelled. |