Создание личного чата (IM)
Метод и конечная точка
POST /im.create
Описание
Создает личный чат (instant message) с другим пользователем. Если чат уже существует, возвращает существующий. Является аналогом dm.create.
Параметры
Перечень параметров представлен в таблице.
| Название | Обязательный | Тип данных | Описание |
|---|---|---|---|
| usernames | нет* | string | Имя пользователя для создания чата |
| username | нет* | string | Имя пользователя для создания чата |
* Должен быть указан один из параметров: usernames или username.
Запрос
curl -X 'POST' \
'https://im-<ENV>.<DEFAULT_DOMAIN>/api/v1/im.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": "im_123456",
"rid": "im_123456",
"usernames": [
"john.doe",
"jane.smith"
],
"t": "d"
}