board.getComments

Возвращает список сообщений в указанной теме.

Этот метод можно вызвать с ключом доступа пользователя.

Этот метод можно вызвать с сервисным ключом доступа.

Параметры

group_id

string

Идентификатор сообщества, информацию об обсуждениях которого нужно получить.

topic_id

string

Идентификатор обсуждения.

need_likes

string

1 — будет возвращено дополнительное поле likes. По умолчанию поле likes не возвращается.

start_comment_id

string

Идентификатор комментария, начиная с которого нужно вернуть список (подробности см. ниже).

offset

string

Смещение, необходимое для выборки определенного подмножества сообщений.

count

string

Количество сообщений, которое необходимо получить (но не более 100). По умолчанию — 20.

extended

string

Если указать в качестве этого параметра 1, то будет возвращена информация о пользователях, являющихся авторами сообщений. По умолчанию 0.

sort

string

Порядок сортировки комментариев:

•
asc — хронологический;
•
desc — антихронологический.

Если был передан параметр start_comment_id, будет найдена позиция комментария в списке (или ближайший к нему более ранний). Начиная с этой позиции будет возвращено count комментариев. Смещение offset в этом случае будет отсчитываться от этой позиции (оно может быть отрицательным).

Результат

В случае успеха возвращает объект, содержащий поле items, поле poll, если к теме прикреплен опрос, а также поле profiles (если был указан параметр extended).

Поле items представляет собой массив, содержащий объекты, описывающие комментарии.

Если к теме был прикреплен опрос, возвращается поле poll следующего вида:

•
owner_id — идентификатор владельца опроса;
•
poll_id — идентификатор опроса;
•
created — время создания опроса в формате unixtime;
•
is_closed — 1, если опрос закрыт (в нем больше нельзя принимать участие) или 0 в противном случае;
•
question — текст вопроса для опроса;
•
votes — общее количество ответивших пользователей;
•
answer_id — идентификатор ответа текущего пользователя (если текущий пользователь еще не отвечал в данном опросе, то содержит 0);
•
answers — массив, содержащий объекты с вариантами ответа на вопрос в опросе:
- •
  id — идентификатор ответа на вопрос;
- •
  text — текст ответа на вопрос;
- •
  votes — количество пользователей, проголосовавших за данный вариант ответа;
- •
  rate — рейтинг данного варианта ответа, выраженный в процентах.

В случае передачи параметра extended равным 1, поле profiles содержит массив объектов user с информацией о данных пользователей, являющихся авторами сообщений.

Если был передан параметр start_comment_id, будет также возвращено поле real_offset – итоговое смещение данного подмножества комментариев (оно может быть отрицательным, если был указан отрицательный offset).

Коды ошибок

В ходе выполнения могут произойти общие ошибки.