Search Rooms

Search for rooms, querying name, description, and specified keywords.

Search rooms according to the specified criteria.

post

Query parameters

skipintegerOptional

No. of results to skip.

limitintegerOptional

Max no. of results to return. If no value is provided, 50 is the default. Must be a positive integer and must not exceed 100

includeNonDiscoverablebooleanOptional

Whether the non discoverable rooms should be returned. false by default. Parameter introduced in sbe-25.5.0

Header parameters

sessionTokenstringRequired

Session authentication token.

Body

application/json

Room Query Object. Used to specify the parameters for room search.

and

Responses

200

OK

application/json

A list of search results and counts per search parameter.

countinteger · int64Optional

The total number of rooms matched by the search.

Example: 2

skipintegerOptional

The number of skipped results.

limitintegerOptional

The number of returned results.

Example: 10

400

Client error, see response body for further details.

application/json

401

Unauthorized: Invalid session token.

application/json

403

Forbidden: Caller lacks necessary entitlement.

application/json

500

Server error, see response body for further details.

application/json

post

/v3/room/search

HTTPcURLJavaScriptPython

POST /pod/v3/room/search HTTP/1.1
Host: yourpodURL.symphony.com
sessionToken: text
Content-Type: application/json
Accept: */*
Content-Length: 275

{
  "query": "automobile",
  "labels": [
    "industry"
  ],
  "searchFields": [
    "name",
    "description",
    "keywords_key",
    "keywords_value"
  ],
  "active": true,
  "private": true,
  "owner": {
    "id": 7215545058313
  },
  "creator": {
    "id": 7215545058313
  },
  "member": {
    "id": 7215545058313
  },
  "sortOrder": "RELEVANCE",
  "subType": "EMAIL"
}

{
  "count": 2,
  "skip": 0,
  "limit": 10,
  "query": {
    "query": "automobile",
    "labels": [
      "industry"
    ],
    "searchFields": [
      "name",
      "description",
      "keywords_key",
      "keywords_value"
    ],
    "active": true,
    "private": true,
    "owner": {
      "id": 7215545058313
    },
    "creator": {
      "id": 7215545058313
    },
    "member": {
      "id": 7215545058313
    },
    "sortOrder": "RELEVANCE",
    "subType": "EMAIL"
  },
  "rooms": [
    {
      "roomAttributes": {
        "name": "Automobile Industry Room",
        "description": "Room to discuss car companies",
        "membersCanInvite": true,
        "readOnly": false,
        "copyProtected": false,
        "crossPod": false,
        "viewHistory": false,
        "public": false,
        "multiLateralRoom": false
      },
      "roomSystemInfo": {
        "id": "tzwvAZIdDMG3ZPRxv+xsgH///qr+JJkWdA==",
        "creationDate": 1464615003895,
        "createdByUserId": 7696581411197,
        "active": true
      }
    },
    {
      "roomAttributes": {
        "name": "Tesla Room",
        "keywords": [
          {
            "key": "industry",
            "value": "automobile"
          }
        ],
        "description": "Discussions on TSLA",
        "membersCanInvite": true,
        "readOnly": false,
        "copyProtected": false,
        "crossPod": false,
        "viewHistory": false,
        "public": false,
        "multiLateralRoom": false
      },
      "roomSystemInfo": {
        "id": "o6UkQ1TEmU0Tf/DHUlZrCH///qr+JQowdA==",
        "creationDate": 1464614974947,
        "createdByUserId": 7696581411197,
        "active": true
      }
    }
  ],
  "facetedMatchCount": [
    {
      "facet": "industry",
      "count": 1
    }
  ]
}

📘 Room Search Scope

Room search is performed on the set of:

• All rooms that the calling user is a member of (private or public, active or inactive)

• All active public rooms

• Private rooms that the calling user is not a member of, where the room is set to be visible in search, is active and the room does not contain any user with whom the calling user has an information barrier

Note: visit Overview for an overview of streams.

🚧 Room Description Search

The description is only searched for hashtags and cashtags containing the search query. For example if query were foo and the description of a room contained "foo", this room would not be returned in the search results; however, if the description contained "#foo", this room would be returned in the search results.