uhead
Перейти к материалам

Мессенджер

Основные методы

МетодМаршрут относительно https://openapi.uhead.ru/prod/external/v1
GET / POST/messenger/conversations — список / создание личной беседы
GET/messenger/unread-count — непрочитанные
GET / POST/messenger/conversations/{id}/messages — история / отправка
PUT/messenger/conversations/{id}/read — отметка прочтения
PATCH / DELETE/messenger/messages/{id} — изменение / удаление
POST / DELETE/messenger/blocks/{user_id} — блокировка / разблокировка

Создайте личную беседу

POST /messenger/conversations принимает обязательный user_id и необязательные vacancy_id, vacancy_response_id. Групповые беседы во внешнем API не поддерживаются.

Для списка бесед используйте page и limit. Для истории сообщений — before_id или after_id и limit от 1 до 100; по умолчанию возвращается до 50 сообщений.

Отправьте сообщение

Замените 123 на ID беседы, полученный из API. Запрос создаёт сообщение от имени владельца компании.

bash
curl --request POST \
  'https://openapi.uhead.ru/prod/external/v1/messenger/conversations/123/messages' \
  --header "Authorization: Bearer $UHEAD_API_TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{"message_text":"Здравствуйте! Когда вам удобно обсудить вакансию?"}'

Отметьте прочтение

В PUT /messenger/conversations/{conversation_id}/read передайте query-параметр last_read_message_id — ID последнего прочитанного сообщения.

При удалении сообщения параметр for_all по умолчанию равен true. Уточняйте его явно, если сообщение нужно удалить только у отправителя. Полные схемы запросов и ответов смотрите в справочнике Open API.

Методы и параметры описаны по публичной спецификации Open API uhead. Открыть справочник Open API