Genesys Cloud - Developer Community!

Hi Orestis,

From my understanding, closing a custom widget (or WebSocket) doesn't terminate the conversation, as web messaging is designed to be persistent.

When the user clicks your "End Chat" button, you'd need to trigger a clear/disconnect action behind the scenes to properly end the conversation.

If needed, this could also be handled via the Platform API (e.g., PATCH /api/v2/conversations/messages/{conversationId} to set the state to disconnected), but typically this logic should sit behind that button in your custom widget.

Hope this helps and someone might add more to this.

Hello Phaneendra,

Thank you for the prompt response.

That can be a problem. Ideally, we would like to do that without using the Platform API. We were hoping that Web Message Guest API offers such a capability. Reviewing the relevant documentation and considering your update as well, it seems that this is not something we can accomplish.

Hi Orestis,

From my understanding, closing a custom widget (or WebSocket) doesn't terminate the conversation, as web messaging is designed to be persistent.

When the user clicks your "End Chat" button, you'd need to trigger a clear/disconnect action behind the scenes to properly end the conversation.

If needed, this could also be handled via the Platform API (e.g., PATCH /api/v2/conversations/messages/{conversationId} to set the state to disconnected), but typically this logic should sit behind that button in your custom widget.

Hope this helps and someone might add more to this.

Hi Orestis,

From my understanding, closing a custom widget (or WebSocket) doesn't terminate the conversation, as web messaging is designed to be persistent.

When the user clicks your "End Chat" button, you'd need to trigger a clear/disconnect action behind the scenes to properly end the conversation.

You might find these helpful:

• Official doc (describes the end-user clear conversation event via Web Messaging API):
  https://developer.genesys.cloud/commdigital/digital/webmessaging/websocketapi#end-user-clear-conversation-event
• Community post (explains how the clear conversation behaviour disconnects the interaction):
  https://community.genesys.com/discussion/web-messaging-end-user-can-clear-the-conversation

These don't cover custom widget implementation directly, but they do explain the behaviour you'll need to replicate.

Hope someone from community has done this or might have a different approach to this.

Hello Phaneendra,

Thank you for the prompt response.

That can be a problem. Ideally, we would like to do that without using the Platform API. We were hoping that Web Message Guest API offers such a capability. Reviewing the relevant documentation and considering your update as well, it seems that this is not something we can accomplish.

Hi Orestis,

From my understanding, closing a custom widget (or WebSocket) doesn't terminate the conversation, as web messaging is designed to be persistent.

When the user clicks your "End Chat" button, you'd need to trigger a clear/disconnect action behind the scenes to properly end the conversation.

If needed, this could also be handled via the Platform API (e.g., PATCH /api/v2/conversations/messages/{conversationId} to set the state to disconnected), but typically this logic should sit behind that button in your custom widget.

Hope this helps and someone might add more to this.

I believe this can be interesting. As far as i understand, the custom widget should send something like this in order to terminate the conversation? Can someone verify that? If that is so, we do not need to invoke Platform API.

{
  "action": "onMessage",
  "message": {
    "type": "Event",
    "events": [
      {
        "eventType": "Presence",
        "presence": {
          "type": "Clear"
        }
      }
    ]
  },
  "tracingId": "11111111-1111-1111-1111-111111111111",
  "token": "0000000-0000-0000-0000-0000000000"
}

Hi Orestis,

From my understanding, closing a custom widget (or WebSocket) doesn't terminate the conversation, as web messaging is designed to be persistent.

When the user clicks your "End Chat" button, you'd need to trigger a clear/disconnect action behind the scenes to properly end the conversation.

You might find these helpful:

• Official doc (describes the end-user clear conversation event via Web Messaging API):
  https://developer.genesys.cloud/commdigital/digital/webmessaging/websocketapi#end-user-clear-conversation-event
• Community post (explains how the clear conversation behaviour disconnects the interaction):
  https://community.genesys.com/discussion/web-messaging-end-user-can-clear-the-conversation

These don't cover custom widget implementation directly, but they do explain the behaviour you'll need to replicate.

Hope someone from community has done this or might have a different approach to this.

Hello Phaneendra,

Thank you for the prompt response.

That can be a problem. Ideally, we would like to do that without using the Platform API. We were hoping that Web Message Guest API offers such a capability. Reviewing the relevant documentation and considering your update as well, it seems that this is not something we can accomplish.

Hi Orestis,

From my understanding, closing a custom widget (or WebSocket) doesn't terminate the conversation, as web messaging is designed to be persistent.

When the user clicks your "End Chat" button, you'd need to trigger a clear/disconnect action behind the scenes to properly end the conversation.

If needed, this could also be handled via the Platform API (e.g., PATCH /api/v2/conversations/messages/{conversationId} to set the state to disconnected), but typically this logic should sit behind that button in your custom widget.

Hope this helps and someone might add more to this.

You are correct, this is the event used by the out of the box messenger 

I believe this can be interesting. As far as i understand, the custom widget should send something like this in order to terminate the conversation? Can someone verify that? If that is so, we do not need to invoke Platform API.

{
  "action": "onMessage",
  "message": {
    "type": "Event",
    "events": [
      {
        "eventType": "Presence",
        "presence": {
          "type": "Clear"
        }
      }
    ]
  },
  "tracingId": "11111111-1111-1111-1111-111111111111",
  "token": "0000000-0000-0000-0000-0000000000"
}

Hi Orestis,

From my understanding, closing a custom widget (or WebSocket) doesn't terminate the conversation, as web messaging is designed to be persistent.

When the user clicks your "End Chat" button, you'd need to trigger a clear/disconnect action behind the scenes to properly end the conversation.

You might find these helpful:

• Official doc (describes the end-user clear conversation event via Web Messaging API):
  https://developer.genesys.cloud/commdigital/digital/webmessaging/websocketapi#end-user-clear-conversation-event
• Community post (explains how the clear conversation behaviour disconnects the interaction):
  https://community.genesys.com/discussion/web-messaging-end-user-can-clear-the-conversation

These don't cover custom widget implementation directly, but they do explain the behaviour you'll need to replicate.

Hope someone from community has done this or might have a different approach to this.

Hello Phaneendra,

Thank you for the prompt response.

That can be a problem. Ideally, we would like to do that without using the Platform API. We were hoping that Web Message Guest API offers such a capability. Reviewing the relevant documentation and considering your update as well, it seems that this is not something we can accomplish.

Hi Orestis,

From my understanding, closing a custom widget (or WebSocket) doesn't terminate the conversation, as web messaging is designed to be persistent.

When the user clicks your "End Chat" button, you'd need to trigger a clear/disconnect action behind the scenes to properly end the conversation.

If needed, this could also be handled via the Platform API (e.g., PATCH /api/v2/conversations/messages/{conversationId} to set the state to disconnected), but typically this logic should sit behind that button in your custom widget.

Hope this helps and someone might add more to this.