Genesys Cloud - Developer Community!

 View Only

Sign Up

  • 1.  Web messaging guest API - Health status

    Posted 07-30-2025 03:46

    Hi,

    We are currently doing the integration with Web messaging guest API (https://developer.genesys.cloud/commdigital/digital/webmessaging/websocketapi) using web-messaging-sdk-java (https://mypurecloud.github.io/web-messaging-sdk-java/).

    I'm looking for an option to check the health status for this API ?

    We are already checking the health of a websocket connection. What we are looking is to check the availability status for web messaging API.

    Thanks,

    Amal


    #WebMessaging

    ------------------------------
    Amal Joshy
    ------------------------------


  • 2.  RE: Web messaging guest API - Health status

    Posted 07-31-2025 11:23

    You are looking for https://developer.genesys.cloud/commdigital/digital/webmessaging/websocketapi#check-the-health-of-a-websocket-connection

    it's available in the sdk https://mypurecloud.github.io/web-messaging-sdk-java/SendEchoRequest

    it's subject to this limit : 

    health.check.per.connection.rate.per.minute

    The maximum number of health check requests per connection per minute, see https://developer.genesys.cloud/api/digital/webmessaging/websocketapi#check-the-health-of-a-websocket-connection

    2

    false

    false

    You can use it when you didn't send nor received something on the websocket for a while, it's advised to not use it too frequently

    There is no other method to check the availability status of the API

    Regards,

    Laurent



    ------------------------------
    Laurent Rustuel
    Lead Software Engineer
    ------------------------------



  • 3.  RE: Web messaging guest API - Health status

    Posted 08-01-2025 07:54
    Edited by Amal Joshy 08-01-2025 07:56

    Hi Laurent Rustuel ,

    Thanks for the message.

    We already use https://developer.genesys.cloud/commdigital/digital/webmessaging/websocketapi#check-the-health-of-a-websocket-connection for keeping the websocket connection alive within the limit.

    What I was looking for was to check the availability status of the API.

    Thanks for the input.

    Regards,

    Amal



    ------------------------------
    Amal Joshy
    ------------------------------