Leave Session | Machani Robotics SDK

curl -X POST https://api.machanirobotics.com/v1/conversation/sessions/sessions/session:leave \
     -H "Content-Type: application/json" \
     -d '{
  "name": "robotics_team_alpha",
  "session": "user_johndoe"
}'

{
  "session": {
    "profile": "engineering_discussion",
    "displayName": "Robotics Team Alpha",
    "sessionType": 2,
    "owners": [
      "user_janedoe",
      "user_admin"
    ],
    "defaultChannels": [
      101,
      102
    ],
    "name": "robotics_team_alpha",
    "description": "Session for discussing robotics project milestones and updates.",
    "sessionId": "sess-8f14e45fceea167a5a36dedd4bea2543",
    "allowedUsers": [
      "user_johndoe",
      "user_marysmith",
      "user_boblee"
    ],
    "options": {
      "maxUsers": 50,
      "maxBytes": 10485760,
      "acknowledgement": false
    },
    "secretKey": "a1b2c3d4e5f67890abcdef1234567890",
    "createTime": "2024-01-15T09:30:00Z",
    "updateTime": "2024-04-20T14:45:00Z"
  }
}

LeaveSession allows a user to leave an active session.

Use this method to indicate that a user has left the session and will no longer participate in the conversation.

Request: LeaveSessionRequest (specify session name and username) Response: LeaveSessionResponse (indicates success and session state)

HTTP: POST /v1/conversation/sessions/{name}/leave

Path parameters

sessionstringRequired

The session id.

Request

This endpoint expects an object.

namestringRequired

name of the user leaving the session.

sessionstringRequired

Session is the session object to join.

Response

sessionobject

Session is the session object that the user has left.

Errors

400

Bad Request Error