Автозаполнение имен пользователей

Метод и конечная точка

GET /users.autocomplete

Описание

Возвращает список пользователей, чьи имена соответствуют заданному шаблону. Используется для функции автозаполнения в интерфейсе.

Параметры

Перечень параметров представлен в таблице.

Название	Обязательный	Тип данных	Описание
selector	да	string	Шаблон для поиска (часть имени пользователя)
limit	нет	number	Максимальное количество результатов (по умолчанию: 10)

Запрос

curl -X 'GET' \
  'https://im-<ENV>.<DEFAULT_DOMAIN>/api/v1/users.autocomplete?selector=<SEARCH_TEXT>&limit=10' \
  -H 'accept: application/json' \
  -H 'X-User-Id: <USER_ID>' \
  -H 'x-auth-token: <AUTH_TOKEN>'

Где:

• <ENV> — окружение, на котором выполняется запрос;
• <DEFAULT_DOMAIN> — домен сервера Squadus;
• <USER_ID> — идентификатор пользователя, от имени которого выполняется запрос;
• <AUTH_TOKEN> — токен аутентификации пользователя;
• <SEARCH_TEXT> — текст для поиска.

Ответ

200 — List of users — Список пользователей. Пример вывода:

{
  "success": true,
  "items": [
    {
      "_id": "7w9BMr9r78W4RNe8x",
      "name": "John Doe",
      "username": "john.doe",
      "status": "online"
    },
    {
      "_id": "8x9CNSs0s89X5SOf9y",
      "name": "Jane Smith",
      "username": "jane.smith",
      "status": "away"
    }
  ]
}