GET

Returns a reference URL for a single callback contact.

When you send a poll request, the "estimatedWaitTime" is returned only if the contact state is "Queued".

URL:

https://<ServerIP>:<Port>/ccp/rest/callback/contact/<ContactID>

HTTPS method:

GET

Parameters:

See Callback API parameters.

A reference URL to the contact is returned in the location field in the header:

https://<ServerIP>:<Port>/ccp/rest/callback/ contact/6EEF968810000132000015F60A568DFB

Note

The URL returned in the GET call is available until the request is cancelled or until there has been no polling for at least five minutes.

Response codes:

200 OK

404 Not Found

For more information about the response codes, see HTTPS Responses.

Note

The customer callback application developer is responsible for the messages that their customer callback interface provides to the customer. The <status> and <statusReason> fields can be used to understand the state of the contact.

The following table lists the contact transition states during callback flow.

Contact state State reason code Notes

Queued

EXTERNALLY_HANDLED

The callback request was successfully submitted to the contact center for routing.

Handled

EXTERNALLY_HANDLED

The callback request was successfully routed to a contact center agent.

Discarded

StatusReason for failure

NOTIFICATION_INVALID_ NEW_ TASK_MESSAGE

Unified CCE routing error: Invalid message in route request.

NOTIFICATION_MEDIA_ ROUTING_ DISABLED

Unified CCE routing error: Routing is disabled.

NOTIFICATION_NO_SCRIPT

Unified CCE routing error: No available script to run.

Misconfiguration of Unified CCE. No script is available to run.

NOTIFICATION_INVALID_ MRD_ID

Unified CCE routing error: Invalid media routing domain.

Misconfiguration of Unified CCE. Invalid Unified CCE Media Routing Domain.

Ensure that the Media Routing Domain configured in the Customer Collaboration Platform notification exists in the Unified CCE configuration.

NOTIFICATION_INVALID_ SCRIPT_ SELECTOR

Unified CCE routing error: Invalid dialed number or script selector.

Misconfiguration of Unified CCE. Invalid Unified CCE Dialed Number/Script Selector.

Ensure that the Dialed Number/Script Selector configured in the Customer Collaboration Platform notification exists in the Unified CCE configuration.

NOTIFICATION_ROUTER_ RELEASED_ TASK

Unified CCE routing error: Unified CCE released the call or task.

The Unified CCE script indicated that the callback request should be dropped. Possible script misconfiguration.

NOTIFICATION_UNKNOWN_ ROUTING_PROBLEM

Unified CCE routing error: Unknown problem.

NOTIFICATION_CCE_ CONNECTION_LOST

The connection to Unified CCE was lost or was not established.

NOTIFICATION_CCE_ SOCIALMINER_SYSTEM_ FAILURE

Customer Collaboration Platform failed (or restarted) while the callback was queued.

NOTIFICATION_INVALID_ VARIABLE

Customer Collaboration Platform could not submit the task to Unified CCE because it contained invalid media address, call variable, or ECC variable values. The maximum field lengths for these fields are

  • media address: 39 bytes

  • call variable: 40 bytes

  • ECC variable name: 32 bytes

  • ECC variable value: 210 bytes.

NOTIFICATION_RATE_LIMITED

The incoming rate of callback contacts has exceeded 40 contacts per minute.