Справочник API

Сообщения

Закрепить / открепить сообщение

Закрепляет или открепляет одно сообщение внутри беседы. Идентификаторы берутся из webhook-события message.received: conversation_id = data.conversation.id, message_id = data.message.id, sender_id = data.sender.id. sender_id необязателен и по умолчанию равен самому аккаунту. pinned=true закрепляет (опционально на duration_seconds), pinned=false открепляет.

POSThttps://api.unifyport.ai/v1/messages/pin

Перед вызовом

Используйте X-Api-Key нужного рабочего пространства на сервере. Перед запуском замените все заполнители.

Параметры запроса

Заголовки

X-Api-Key
stringобязательно

API-ключ рабочей области. Рабочая область определяется по этому заголовку.

Content-Type
stringобязательно

Используйте application/json при отправке JSON-тела запроса.

Тело запроса

account_id
stringобязательно

Аккаунт, выполняющий действие.

conversation_id
stringобязательно

Идентификатор целевой беседы.

message_id
stringобязательно

Идентификатор целевого сообщения.

sender_id
string

Идентификатор исходного отправителя; можно не указывать только для собственного сообщения аккаунта.

pinned
booleanобязательно

true закрепляет сообщение, false снимает закрепление.

duration_seconds
integer

Необязательная длительность закрепления в секундах.

format: uint32

Как понять результат

Следуйте описанию полей и HTTP-статуса. Успешный 204 не содержит тела; для диагностики используйте X-Request-Id. Следующий шаг указан в связанных операциях.

Ответ 200 OK

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "ok": true
  }
}

Тело ответа

ok
boolean

Всегда true при успешном выполнении операции; при ошибках вместо этого возвращается статус не из диапазона 2xx.

Ответы

200

200 OK

Запрос выполнен. См. пример тела ответа.

400

Bad Request

Тело запроса, путь или параметры некорректны.

401

Unauthorized

Заголовок X-Api-Key отсутствует или недействителен.

409

Conflict

Запрошенная операция конфликтует с существующим аккаунтом провайдера или ресурсом.

500

Internal Server Error

Сервис столкнулся с неожиданной ошибкой.

501

Not Implemented

Выбранный провайдер не реализует эту операцию.

502

Bad Gateway

Адаптер или вышестоящий провайдер не смог завершить операцию.

При ошибке запроса

Проверьте HTTP и error.code/numeric_code, сохраните request_id. Исправьте параметры, завершите авторизацию или проверьте runtime. До повторной отправки или записи выясните результат предыдущей попытки. Справочник ошибок

invalid_request · 10000 · 400
Проверьте обязательные поля, форматы и условия канала, затем исправьте запрос.
invalid_api_key · 11001 · 401
Проверьте X-Api-Key и активность рабочего пространства.