myContactCenterManual

callbackHub — interface reference

RegisterAsync, callback time and server events of the SignalR WebCallback hub, also searchable as webCallbackHub.

Endpoint: /callbackHub.

Register a callback

Invocation name: RegisterAsync. Pass every argument in this order:

Argument Type Meaning
customerNumber string telephone number to call
customerName string customer name
skill string exact skill name
language string exact language name
recordingPermitted boolean whether recording is permitted for this callback
callbackTime string or null requested callback time; null uses the current server time

The method returns a boolean. true confirms execution of the hub method, not persistent creation of the callback or successful telephone contact. Check processing in the callback queue. Another invocation may create another request; the interface provides no deduplication key.

The server interprets the callback time using DateTime.TryParse. Send a valid ISO time with a time zone offset, or null. An empty string is not the same as null. The hub does not check the date parsing result; it does not return an invalid date as a validation error. Validate the date and telephone number before sending. A requested time is not a guaranteed appointment; subsequent distribution depends on the Contact Center.

Server events

Name for connection.on Arguments
OnStateChangedAsync oldState, newState
OnPositionChangedAsync position

The names include Async. State values use the same ConversationState enumeration as chatHub.

These events are defined in the client interface. After handover, however, the callback is processed as a virtual callback request. The connection does not reliably show progress of the later telephone call. There is no hub method to query or cancel a callback that has already been created.

    ↑ ↓ select · Enter open · Esc close