Dataphin:Configure Phone Message Channel

Usage instructions

• The message sending channel can be set globally (instance level) or at each tenant level. Configure it according to your organization's requirements.

• When the message channel is shut down, configured alert messages cannot be sent. To ensure successful delivery of alert messages, please enable the phone message channel.

Permission instructions

• Metadata warehouse tenant super administrators and system administrators (instance level) have the ability to edit message channels.

• At the tenant level, super administrators and system administrators can edit message channels, while other users can view them.

Configure custom voice service

1. On the Dataphin home page, select Management Center > System Settings.

2. In the left menu bar, choose System Settings > Message Channel.

3. On the Message Channel Settings page, click the Phone tab.

4. After selecting Custom in the Channel Settings, configure the following parameters in the Voice Service Configuration area.

   1. Send information configuration

      Parameter	Description
      Information Sending URL	The URL to which information is sent.
      Request Method	The system allows the selection of either POST or GET as the request method. Note For POST, you can configure request parameters for Headers, Parameters, and Body. For GET, you can configure request parameters for Headers and Parameters only.
      Request Parameter Configuration	Headers: To configure Headers parameters, click the + New button. Key: Enter a unique custom key value. Value: Custom input is supported, including constants and built-in parameters. For more details, see the referenced document. Type: Choose from String, Double, Long, or Boolean in the dropdown box. Parameter Encryption: Off by default. Enable to display the parameter value as ******. Important Parameter encryption is available for constant values in Headers and Body. Variable values cannot be encrypted. Encryption is for desensitization in Dataphin editing and storage. During interfacing with the channel, transmission is in plaintext. Use encrypted text for configuration and decrypt during channel application processing if encrypted transmission is needed. Parameters: To configure Parameters, click the + New button. Key: Enter a unique custom key value. Value: Select the value. Custom input is supported, including constants and built-in parameters. For more details, see the referenced document. Actions: Click the Actions column icon to edit Parameters parameters. Click the Actions column icon to delete Parameters parameters. Body: To configure Body parameters, click the + New button. Key: Enter a unique custom key value. Value: Custom input is supported, including constants and built-in parameters. For more details, see the referenced document. Type: Choose from String, Double, Long, Boolean, or JSON in the dropdown box. Parameter Encryption: Off by default. Enable to display the parameter value as ******. Actions: Click the Actions column icon to edit Body parameters. Click the Actions column icon to delete Body parameters. Test: Click Test, configure the test parameters in the Test Request Sending dialog box, and then click Start Test. Request text box displays the request details. Click the icon to copy the details. The request body is only displayed for POST requests. Response text box displays the response details. Click the icon to copy the details. Note Enter the configuration values for any parameters carried in Headers during testing.
      Sending Result Analysis	The system supports analysis based on HTTP Status Code and HTTP Status Code And Response Result. HTTP Status Code Interpretation: A status code in the 2xx range indicates a successful send. Based On HTTP Status Code And Response Result: Allows custom configuration of sending conditions.
      Query Result Analysis	Key: Select a key value from the dropdown box or enter a custom key value. Value: Enter a custom value. Note If the status code is 2xx and the sending success conditions are met, it is considered successful. A status code outside the 2xx range is considered a failure. If the status code is 2xx but sending failure conditions are met, it is considered a failure. Under other conditions, the send is considered in progress and will continue polling until a success or failure is determined. You can use ${response.key} to retrieve the key value from the response.

   2. Result query configuration

      Parameter	Description
      Result Query	By default, Disabled. You have the option to Enable. Disabled: When disabled, the task is considered successful upon completion of sending. Enabled: When enabled, after sending is complete, the results are polled and displayed in the alert center.
      Result Query URL	The URL address for result query.
      Request Method	The system supports POST or GET methods. Note For POST, you can configure Headers, Parameters, and Body. For GET, you can configure Headers and Parameters.
      Request Parameter Configuration	Headers: Click + New to configure Headers parameters. Key: Enter a unique custom key value. Value: Supports custom input, including constants and built-in parameters. For more details, see the referenced document. Type: Select from String, Double, Long, or Boolean. Parameter Encryption: Disabled by default. Enable to display the parameter value as ******. Parameters: Click + New to configure Parameters parameters. Key: Enter a unique custom key value. Value: Select the value. Supports custom input, including constants and built-in parameters. For more details, see the referenced document. Actions: Click the Actions column icon to edit Parameters parameters. Click the Actions column icon to delete Parameters parameters. Body: Click + New to configure Body parameters. Key: Enter a unique custom key value. Value: Supports custom input, including constants and built-in parameters. For more details, see the referenced document. Type: Select from String, Double, Long, Boolean, or JSON. Parameter Encryption: Disabled by default. Enable to display the parameter value as ******. Actions: Click the Actions column icon to edit Body parameters. Click the Actions column icon to delete Body parameters. Test: Click Test, configure test parameters in the Test Request Sending dialog box, and then click Start Test. Request text box displays request details. Click the icon to copy request details. The request body is only displayed for the POST method. Response text box shows response details. Click the icon to copy response details. Note If Headers include parameters, enter the configuration values during testing.
      Query Result Analysis	Key: Choose from a list of key values or enter a custom key. Value: Enter a custom value. Note If the status code is 2xx and the conditions for sending success are met, the send is recognized as successful. If the status code is not 2xx, the send is recognized as a failure. If the status code is 2xx but conditions for sending failure are met, the send is recognized as a failure. In other cases, the send is considered in progress and will continue to be polled until a definitive success or failure is determined. To retrieve the key value from the response, use ${response.key}.

5. To test the configuration of the Custom Voice Service, click Send Test Message. This will send a test message that serves solely for verification purposes.

   Parameter	Description
   Recipient	Choose the recipient for the test message.
   Voice Message	The default message is This Is A Test Message From Dataphin. You may customize the message, ensuring it does not exceed 128 characters.

6. To finalize the custom Voice Service message channel settings, click Save.