Create Generic MCX Chat Integration

To create Generic MCX Chat Integration in Workflow Studio, perform the following steps:

  1. Log into Workflow Studio.
  2. Under Library, click Integrations.
  3. In the Integrations Hub, click on the See details button on the Generic MCX Chat Integration integration tile.

  4. Click Connect to start the integration steps.

  5. In the Integration Step 1 screen, read through the Getting Started information and click Next.

  6. In the Integration Step 2 screen, click Add new to add a new connection using Basic authentication or API Key.

    The Generic MCX Chat Integration - Add connection screen is displayed with Basic Authentication or API Key options.

  7. To add the connection using the Basic authentication option, perform the following steps:

    1. In the Add connection screen, click Add next to Basic authentication option, and click OK.

    2. Click Complete Setup.

      The Configure this connection - Basic authentication screen is displayed.

  8. To add the connection using the API Key option, perform the following steps:

    1. In the Add connection screen, click Add next to API Key option, and click OK.

    2. Click Complete Setup.

      The Configure this connection - API Key screen is displayed.

  9. Provide the required details in the Configure this connection screen. For more information on fields, refer to the field description table.
    Note: Mandatory fields are marked with an asterisk (*).
    Table 1. Configure this connection - Field Description
    Fields Description

    Name

    Enter the name for the integration connection.

    Username

    Enter the user name defined in MCX.

    This field is displayed only if the Basic Authentication option is selected.

    Password

    Enter the password defined in MCX.

    This field is displayed only if the Basic Authentication option is selected.

    Sent in

    This field is displayed only if the API Key option is selected.

    API Key name

    This field is displayed only if the API Key option is selected.

    API Key value or Bearer + token value

    This field is displayed only if the API Key option is selected.

    Chat To Number

    Enter the number to which the chat message will be sent. If multiple numbers are used, an integration should be created for each chat number. This number is typically configured on the third-party chat provider.

    Chat Provider

    Select the chat provider from the list.

    The options are:

    • InfoBip

    • InfoBip WhatsApp

    • Other provider
    Note: If the Chat Provider is selected as InfoBip or InfoBip WhatsApp, the required fields are automatically populated.

    Message URL

    If Other provider is selected, enter the URL that is invoked when a message is sent out to the chat provider through HTTP POST request.

    Message Body

    If Other provider is selected, enter the format of the chat message body in JSON format.

    A template is provided as shown below:
    {
  "from": "{{From}}",
  "to": "{{To}}",
  "message": "{{Message}}"
}
    Note:

    The variables {{From}}, {{To}} and {{Message}} should be populated with From number, To number, and chat message to be sent out, respectively.

    Attachment URL

    If Other provider is selected, enter the URL that is invoked when an attachment is sent out to the chat provider through HTTP POST request.

    Upload Media URL
    If Other provider is selected, enter the format of the attachment body in JSON format. A template is provided as shown below:
    {
  "from": "{{From}}",
  "to": "{{To}}",
  "attachments": [
    {
      "name": "{{DisplayName}}",
      "contentType": "{{ContentType}}",
      "contentUrl": "{{MediaUrl}}"
    }
  ]
}
    Note:

    The variable {{From}}, {{To}}, {{DisplayName}}, {{ContentType}} and {{MediaUrl}} should be populated by the workflow with the corresponding information.

    Upload Media URL

    If Other provider is selected, enter the URL used to upload the media.

    This field is required only if the chat provider requires media content to be uploaded before sending a chat message with an attachment. When a chat message with an attachment is sent, this URL is invoked first, followed by the Attachment URL.

    Media Response attribute

    If Upload Media URL is defined for the third-party chat provider, the upload response typically includes an attribute that must be provided when sending the chat message with the attachment.

    Enter the name of that response attribute.

    Upload Media Body
    If Upload Media URL is defined for the third-party chat provider, enter the request body format in JSON format.
    Note:

    The following variables can be used and are automatically populated by the workflow: {{AttachmentFileName}}, {{AttachmentFileType}}, {{AttachmentFileExtension}}, and {{AttachmentContent}}.

    If the chat provider requires additional information, contact Mitel Technical Support to have the required values added.

  10. Click Create once the required fields have been populated.

    The Connection Complete screen is displayed to confirm the success of the third-party integration.

  11. Click Continue.

    The newly created connection is displayed in the list.

Parent topic: Generic MCX Chat Integration (Essential)
↑