curl --request POST 'https://forum.arzguard.com/api/conversation-messages/123/' \
--header "XF-Api-Key: $FORUM_API_KEY" \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'message=Пример сообщения'
{
"success": true,
"message": {
"message_id": 123,
"conversation_id": 123,
"message": "Пример сообщения"
}
}
Личные диалоги
Изменить сообщение переписки
Обновляет текст или вложения доступного сообщения.
POST
/
api
/
conversation-messages
/
{id}
/
curl --request POST 'https://forum.arzguard.com/api/conversation-messages/123/' \
--header "XF-Api-Key: $FORUM_API_KEY" \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'message=Пример сообщения'
{
"success": true,
"message": {
"message_id": 123,
"conversation_id": 123,
"message": "Пример сообщения"
}
}
Обновляет текст или вложения доступного сообщения.
Для новых вложений ключ должен иметь тип
Тело запроса:
Ошибки возвращаются в общей структуре
Примеры сокращены и содержат только условные значения. Состав полей объектов зависит от прав, контекста и установленных дополнений.
conversation_message и context[message_id], равный ID изменяемого сообщения. Право на просмотр переписки не означает право редактировать любое её сообщение.
Доступ
ПередавайтеXF-Api-Key в заголовке каждого запроса. Типы ключей и выбор пользователя.
Требуемые scopes: conversation:write. Все перечисленные разрешения нужны одновременно.
Нужен контекст зарегистрированного пользователя. Для Super key укажите XF-Api-User; доступ к объектам и действиям проверяется отдельно от scopes.
Параметры
string
required
Секретный API-ключ. В примерах ключ берётся из серверной переменной
$FORUM_API_KEY.integer
required
Идентификатор сообщения.
application/x-www-form-urlencoded. Вложенные значения передавайте в форме с квадратными скобками в имени поля.
string
Текст сообщения. Поддерживаемая разметка и ограничения определяются настройками XenForo.
string
Секретный ключ заранее загруженных вложений. Он должен соответствовать типу и контексту создаваемого или изменяемого сообщения.
Ответ
HTTP200, JSON. Схемы объектов и условные поля.
true
Результат выполнения операции.
ConversationMessage
Объект сообщения личной переписки.
errors. Обрабатывайте поле code; текст message может меняться или переводиться. Формат ошибок.
curl --request POST 'https://forum.arzguard.com/api/conversation-messages/123/' \
--header "XF-Api-Key: $FORUM_API_KEY" \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'message=Пример сообщения'
{
"success": true,
"message": {
"message_id": 123,
"conversation_id": 123,
"message": "Пример сообщения"
}
}