MCX callback

This activity adds a callback to MCX system, which can be routed to MCX agent. The customer's name and number, along with the callback destination number, can be specified. It is required to specify the MCX media server that will handle the callback and the subroutine in MCX that will handle the callback routing.
Note:

If variables are provided in the VariableList, the PersistCallbackVariables value must be set to True in MCX for the variable values to be visible. This option enables the variables to be passed from the MCX Callback activity to MCX.

Table 1. MCX callback action - Inputs
Parameters Description

CustomerName

Name of the customer to be called.

CustomerNumber

Number of the customer.

CallRecord

JSON object with additional information about the call, such as ani and dnis.

DestinationNumber

Number to be dialed for the callback.

OtherCallbackProperties

Specify the additional properties to include in the callback request as a JSON object.

Example:
{
  "ClientAvailableFrom": "Mon, 30 Mar 2026 16:42:51 GMT",
  "CallbackTimeExpiryDuration": "01:30:00",
  "RequestTimeExpirationDuration": "30"
}
Note:
  • ClientAvailableFrom – Date and time (UTC) from when the customer would be available. For example, to set this to 2 hours from the current time, use a variable such as DateUtcAddHour(DateUtcNow(), "2") and reference it as "ClientAvailableFrom": "{{StartTime}}".

  • CallbackTimeExpiryDuration – Duration (HH:MM:SS) for which the customer remains available (e.g., 01:30:00 = 1 hour 30 minutes).

  • RequestTimeExpirationDuration – Time in minutes before retrying the request. The default value is 30 minutes.

MediaServer

MCX media server that will handle the callback.

CallbackSubroutine

Subroutine defined in MCX to process and route the callback.

VariableList

List of the names of variables defined in the workflow that will be associated with the callback request. If the variable does not exist in MCX, it will be created.

Table 2. MCX callback action - Outputs
Parameters Description

Success

Indicates whether the activity was completed successfully (value = True) or not (value = False).

Body

Returns the JSON formatted response from the activity.

StatusCode

HTTP response code for the request.