List Sessions | Machani Robotics SDK

curl https://api.machanirobotics.com/v1/conversation/sessions/session \
     -H "Content-Type: application/json"

{
  "sessions": [
    {
      "profile": "default-user-profile",
      "displayName": "Weekly Team Sync",
      "sessionType": 2,
      "owners": [
        "user:jane.doe@example.com"
      ],
      "defaultChannels": [
        3
      ],
      "name": "sessions/abc123xyz",
      "description": "A recurring session for the weekly team synchronization meeting.",
      "sessionId": "session-987654321",
      "allowedUsers": [
        "user:john.smith@example.com",
        "user:alice.jones@example.com"
      ],
      "options": {
        "maxUsers": 25,
        "maxBytes": 10485760,
        "acknowledgement": false
      },
      "secretKey": "s3cr3tK3yForSession!",
      "createTime": "2024-01-15T09:30:00Z",
      "updateTime": "2024-04-10T14:45:00Z"
    }
  ],
  "nextPageToken": "eyJwYWdlIjoxfQ=="
}

ListSessions retrieves all available sessions under the parent scope.

Use this method to get a paginated list of sessions belonging to the specified parent.

Request: ListSessionsRequest Response: ListSessionsResponse

HTTP: GET /v1/conversation/sessions

Path parameters

sessionstringRequired

The session id.

Query parameters

pageSizeintegerOptional

page_size specifies the maximum number of Session resources to return.

pageTokenstringOptional

page_token is used to retrieve the next page of results.

Response

sessionslist of objectsRead-only

Sessions is the list of Session resources.

nextPageTokenstring

next_page_token is the token for retrieving the next page of results.

Errors

400

Bad Request Error