Join Session | Machani Robotics SDK

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

{
  "session": {
    "profile": "engineering_team",
    "displayName": "Robotics Lab Collaboration",
    "sessionType": 2,
    "owners": [
      "alice_smith",
      "bob_jones"
    ],
    "defaultChannels": [
      101,
      102
    ],
    "name": "robotics_lab_session",
    "description": "Session for the engineering team to collaborate on robotics projects.",
    "sessionId": "sess-8f14e45fceea167a5a36dedd4bea2543",
    "allowedUsers": [
      "john_doe",
      "carol_white",
      "dave_black"
    ],
    "options": {
      "maxUsers": 50,
      "maxBytes": 10485760,
      "acknowledgement": false
    },
    "secretKey": "a1b2c3d4e5f67890abcdef1234567890",
    "createTime": "2024-01-15T09:30:00Z",
    "updateTime": "2024-04-20T14:45:00Z"
  }
}

JoinSession allows a user to join an active session.

Use this method to indicate that a user has joined a session and is participating in the conversation.

Request: JoinSessionRequest (specify session name and username) Response: JoinSessionResponse (indicates success and session state)

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

Path parameters

sessionstringRequired

The session id.

Request

This endpoint expects an object.

namestringRequired

name of the user joining the session.

sessionstringRequired

Session is the session object to join.

Response

sessionobject

Session is the session object that the user has joined.

Errors

400

Bad Request Error