Help Center/ Cognitive Engagement Center/ User Guide/ Tenant Administrator Guide/ Configuring Multimedia Channels/ FAQ/ How Do I Enable Message Push?
Updated on 2024-10-12 GMT+08:00
View PDF
Share

How Do I Enable Message Push?

Prerequisites

To use the message push function, you need to prepare a message push API. For details about the API specifications, see Message Push Interface Specifications. After the API is developed, you need to submit an application to the system administrator to add the message push address ({baseUrl}/webhooks/v1/messages) to the address trustlist.

If {baseUrl} is an HTTPS URL, you also need to prepare an authentication certificate. Only a JKS, DER, or PEM certificate is supported.

HTTP has security risks. You are advised to use the secure HTTPS protocol.

If two-way authentication is enabled for the message push address, you also need to prepare the identity certificate of the current system.

Context

  • Only the web and WhatsApp channels support message push.

    For the WhatsApp channel, the system automatically pushes messages. No manual configuration is required.

  • If the message push key provided by the message pusher is changed, you need to modify the key in the AICC by referring to the following procedure. Enter the new message push key.

Procedure

  1. (Optional) If {baseUrl} is an HTTPS URL, upload the push address trust certificate and system identity certificate.

    1. Choose Configuration Center > System Management > Certificate.
    2. Click New and set the certificate name and password as prompted.
    3. Select the type of the certificate to be uploaded.
    4. Click , select the trust certificate and identity certificate from the local PC, and click Open.
    5. Click Save.

  2. Go to the web channel configuration page.
  3. Click to enable Message Push.
  4. Enter the prepared message push address, which is {baseUrl}.
  5. Upload the certificates. Perform this step when the push address is an HTTPS address.

    1. (Optional) Click Trust certificate and select the certificate uploaded in 1.
    2. (Optional) Click Identity certificate and select the certificate uploaded in 1.

  6. Select an authentication mode. The options are Signature Authentication and OAuth Authentication.

    • If Signature Authentication is selected, messages are directly pushed to customers. In this case, you need to set the following parameter:

      Key: The value is a string of 43 characters and can contain only letters and digits.

    • If OAuth Authentication is selected, messages are pushed to the API Fabric, and then the API Fabric pushes the messages to customers. In this case, you need to set the following parameters:

      App ID: Contact the system administrator to obtain the app key of the app that has subscribed to the pushMsg API and bound to the tenant space for which the web channel needs to be configured on the Online Studio > API Management > APP Service > APP Management page, and enter the app key here.

      App Secret: Contact the system administrator to obtain the app secret of the app that has subscribed to the pushMsg API and bound to the tenant space for which the web channel needs to be configured on the Online Studio > API Management > APP Service > APP Management page, and enter the app secret here.

  7. Click The next step to complete the configuration.