User Search API

1.   / 
2. API   / 
3. User   / 
4. Search

---

Overview

wss user_search

The user_search request returns users matched with the specified parameters.

Request Parameters

Name	Type	Description
keyword	string	Key phrase for search
limit	number	Maximum number of objects
updated_at.gt	timestamp	Time reference point
ignore_ids	array[string]	Array of users that will be ignored

Response Fields

Name	Type	Description
users	array[object]	Array of user objects

Example

Request

{
  "request": {
    "user_search": {
      "keyword": "sam",
      "limit": 100,
      "updated_at": {
        "gt": timestamp_in_ms,
      },
      "ignore_ids": [ "63077ad836b78c3d82af0866", "63077ad836b78c3d82af0868" ]
    },
    "id": "RequestId"
  }
}

Response

{
  "response": {
    "id": "RequestId",
    "users": [...]
  }
}

See Also

SAMA chat server API: Users All messengers and services that use instant messaging require minimal user identification in the system. We have developed a universal API...

DataBase Records Collection of complete objects stored in the database.