comments/list
Возвращает сортированный список комментариев страницы.
Доступен для всех тарифных планов.
URL
http://c1api.hypercomments.com/1.0/comments/list
Проверка авторизации пользователя
Нет
Формат ответа
JSON, JSONP
Параметры запроса
| Параметр |
Описание |
обязательный
body
|
JSON строка с параметрами запроса.
обязательный
widget_id
|
int |
ID виджета для которого выполняется запрос |
обязательный
link
|
string |
URL страницы, комментарии которой необходимо получить |
обязательный
sort
|
string [all|new|popular] |
Сортировка комментариев:
all - древовидная структураnew - последние комментарииpopular - самые популярные комментарии
|
обязательный
limit
|
int [1 - 20] |
Количество комментариев, которое необходимо получить
Для сортировки all - количество комментариев у которых нет родительских сообщений (комментарии верхнего уровня)
|
обязательный
offset
|
int |
Смещение, необходимое для выборки определенного подмножества комментариев |
xid
|
string |
Идентификатор страницы, к которому привязаны комментарии |
|
обязательный
signature
|
Подпись запроса. Правила формирования подписи |
callback |
Необязательный параметр, необходимый для кроссдоменных клиент-сервер запросов
с использованием технологии JSONP. В значении параметра передается название callback функции
в которую будет передан результат выполнения запроса
|
Параметры ответа
| Параметр |
Описание |
обязательный
result
|
Результат выполнения запроса
success - успешное выполнение запросаerror - ошибка выполнения запроса
|
обязательный
data
|
Массив объектов результата запроса
time
|
Время создания комментария |
id
|
ID комментария |
parent_id
|
ID родительского комментария |
root_id
|
ID первого комментария ветки по отношению к текущему комментарию |
text
|
Текст комментария
|
files
|
JSON строка с массивом медиа вложений
type |
Тип медиа вложения [images|video|presentation] |
service |
Сервис через который отправлено медиа вложение |
href |
Путь к ресурсу |
id |
ID медиа вложения (для type = video) |
preview |
Путь к картинке предварительного просмотра видео |
|
parent
|
JSON строка с информацией о родительском комментарии
time |
Время создания родительского комментария |
text |
Текст родительского комментария |
files |
медиа вложения комментария |
parent_id |
ID родительского комментария |
acc_id |
ID пользователя |
t |
Флаг гиперкомментария |
nick |
Имя пользователя |
avatar |
Ссылка на аватар анонимного пользователя или пользователя SSO. |
|
cm2
|
Общее количество комментариев |
nick
|
Имя пользователя |
md5email
|
md5 хэш от email анонимного пользователя (для сервиса Gravatar) |
acc_id
|
ID пользователя |
vote_up
|
Количество положительных голосов за комментарий |
vote_dn
|
Количество отрицательных голосов за комментарий |
children
|
Количество дочерних комментариев |
hc_comment
|
Флаг true - гиперкомментарий; false - комментарий |
avatar
|
Ссылка на аватар анонимного пользователя или пользователя SSO.
Для остальных путь к аватару определяется как
https://static.hypercomments.com/data/avatars/{acc_id}/avatar
|
category
|
ID категории комментария |
quote_id
|
ID цитаты к которой привязан комментарий |
|
Пример ответа
{
"result" : "success",
"data" : [
{
"time" : "Thu, 04 Dec 2014 11:16:27 GMT",
"id" : "1417691787280674",
"parent_id" : "1417691787280672",
"root_id" : "1417691787280670",
"text" : "Comment Text",
"files" : "[
{
\"type\" : \"images\",
\"service\" : \"internet\",
\"href\" : \"http://path.to/image\"
},
{
\"type\" : \"video\",
\"service\" : \"youtube\",
\"href\" : \"https:\/\/www.youtube.com\/watch?v=Zelg\",
\"id\" : \"Zelg"\,
\"preview"\ : \"http:\/\/img.youtube.com\/vi\/Zelg\/1.jpg\"
},
{
\"type\" : \"presentation\",
\"service\" : \"google\",
\"href\" : \"https://docs.google.com\/presentation/embed?id=1r9H-lUALqGfEDDQtBub7AzVSjrc3zmVi\"
}
]",
"parent" : "{
\"time\" : \"Thu, 04 Dec 2014 10:23:13 GMT\",
\"text\" : \"Parent text comment\",
\"files\" : null,
\"parent_id\" : null,
\"acc_id\" : 455517,
\"t\" : false,
\"nick\" : \"nick\",
\"avatar\" : \"http:\/\/path.to\/avatar\",
\"category\" : null
}",
"nick" : "Test Nick",
"md5email" : null,
"acc_id" : 1,
"vote_up" : 1,
"vote_dn" : 3,
"children" : 3,
"hc_comment" : false,
"avatar" : "http://path.to/avatar",
"category" : null,
"quote_id" : null
}
]
}