Web Messaging API: How to close guest session from backend?

NICE CXone API & Integrations
1

Need to kill a web messaging session from our backend service. The guest API doesn’t seem to have a close method. Tried POST /api/v2/conversations/messaging/{id} with action ‘close’, but it just throws a 400 Bad Request. What’s the correct payload?

{
 "action": "close",
 "reason": "admin_closed"
}

Nothing works. Stuck.

2

Are you using the conversation ID or the participant ID? The endpoint needs the specific participant ID to close that side. Here is the correct structure.

POST /api/v2/conversations/messaging/{conversationId}/participants/{participantId}
{
 "status": "offline"
}

Status offline triggers the close event. action: close is for internal state only.

3

are you using the platformClient SDK or raw HTTP for this?

  • check that your participant ID matches the guest side, not the agent.
  • set status to offline in the body, just like the post above says.