Skip to content

Чаты REST

REST-эндпоинты модуля мессенджера для получения диалогов и сообщений.

Operations

Получить диалог по id

Request

Возвращает диалог по идентификатору, если:

  • диалог существует
  • текущий пользователь имеет к нему доступ

Требования:

  • требуется JWT
Security
bearerAuth or jwtCookie
Path
idinteger, (int64), >= 1required

Идентификатор диалога

curl -i -X GET \
  'https://felmee.com/api/dialogs/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Диалог успешно получен

Bodyapplication/json
codeErrorstring or nullrequired

Устаревший camelCase-alias поля error_code; при ошибке оба поля содержат одинаковое значение.

successbooleanrequired

Флаг успешного выполнения запроса

messagestringrequired

Человекочитаемое описание результата

error_codestring or null(ERROR_CODE)required

Код ошибки. Для успешных ответов всегда null.

Enum:"invalid_body""unauthorized""not_found""conflict""object_modified_by_another_thread""action_too_late""too_many_request""code_is_gone""forbidden""user_blocked"
dataobject or null(dtoDialog)required

Полезная нагрузка. Может быть объектом, массивом или null.

Response
{
  "success": true,
  "message": "Dialog received successfully",
  "error_code": null,
  "data": {
    "id": 10,
    "chat_interlocutor": { … },
    "message_ids": [ … ],
    "last_message": { … },
    "unread_count": 2,
    "is_online": true
  }
}