Skip to main content

Создание личного чата (dm-create)

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

POST /dm.create

Описание​

Создает личный чат (direct message) с другим пользователем. Если чат уже существует, возвращает существующий.

Параметры​

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

НазваниеОбязательныйТип данныхОписание
usernamesнет*stringИмя пользователя для создания чата
usernameнет*stringИмя пользователя для создания чата

* Должен быть указан один из параметров: usernames или username.

Запрос​

curl -X 'POST' \
  'https://im-<ENV>.<DEFAULT_DOMAIN>/api/v1/dm.create' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'X-User-Id: <USER_ID>' \
  -H 'x-auth-token: <AUTH_TOKEN>' \
  -d '{ \
  "username": "<USERNAME>"
  }'

Где:

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

Ответ​

200 — Create a personal chat — Личный чат создан. Пример вывода:

{
  "success": true,
  "_id": "dm_123456",
  "rid": "dm_123456",
  "usernames": [
    "john.doe",
    "jane.smith"
  ],
  "t": "d"
}