Verifying the status of the Messaging channel

Last Updated : Aug 08, 2023 |

About this task

Use this procedure to check whether the Messaging channel is operational. A successful result ensures that the Cloud Provider can access the new Messaging APIs using your external load balancer, or using the Avaya Common Services (Common Services) Cluster FQDN directly.

Important:
  • Do not run this process from the Cluster Control Manager (CCM) console. Run it from another PC that has cURL installed and is on the customer's network.

Procedure

  1. To check the health status of the Messaging channel:
    1. Run the following command, replacing {Common Services.FQDN} with the FQDN of the customer's Common Services cluster.

      curl -X GET http://{Common Services.FQDN}:31325/messaging/v1/health-check

      Verify the following response:

      {
          "alive": true
      }
      
  2. To check the readiness of the Messaging channel:
    1. Run the following command, replacing {Common Services.FQDN} with the FQDN of the customer's Common Services cluster.

      curl -X GET http://{Common Services.FQDN}:31325/messaging/v1/ready

      Verify the following response:

      {
          "5e46bd56cb011b001076c314": {
              "Aggregator": {
                  "Name": "Smooch",
                  "State": "200"
              },
              "ContactCenter": {
                  "Name": "Oceana",
                  "State": "READY"
              }
          }
      }