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