Главная > Документация uAPI > Модуль "Форум", Сообщения и опросы
 

[GET] Список сообщений


Расшифровка переменных

        topic – [Массив] – Информация о теме
    • closed – [Строка] – Закрыта ли тема для новых сообщений? (yes/no)
    • name – [Строка] – Новое название темы
    • author – [Строка] – Никнейм пользователя, который создал тему
    • description – [Строка] – Описание темы
    • url – [Строка] – Ссылка на тему
    • id – [Строка] – ID темы
    • ontop – [Строка] – Тема всегда сверху (yes/no)
    • firstontop – [Строка] – Первое сообщение темы сделать шапкой (показывать на всех страницах) (yes/no)
  • page – [Число] – Номер текущей страницы
  • pages_list – [Строка] – Список страниц с темами (переключатели)
  • per_page – [Число] – Количество тем на страницу
    •   posts – [Массив] – Сообщения темы
    • add_date – [Строка] – Дата добавления сообщения
    • message_id – [Строка] – ID сообщения
    • subscribe – [Строка] – Включена ли подписка на ответы в теме? (yes/no)
    • topic_id – [Строка] – ID темы, куда был добавлен материал
      •   user – [Массив] – Информация о пользователе, который добавил сообщение
      • avatar – [Строка] – Ссылка на аватар пользователя
      • state – [Строка] – Значение поля "Штаты"
      • msn – [Строка] – Значение поля "MSN"
      • email – [Строка] – Значение поля "Email пользователя"
      •   group – [Массив] – Информация о группе пользователя
      • city – [Строка] – Город пользователя
      • icq – [Строка] – Значение поля "ICQ"
      • gender – [Строка] – Пол пользователя
      • yahoo – [Строка] – Значение поля "Yahoo"
      • country – [Строка] – Страна пользователя
      • aol – [Строка] – Значение поля "AOL"
      • full_name – [Строка] – Имя пользователя
      • rankico – [Строка] – Ссылка на иконку ранка пользователя
      • forum_posts – [Строка] – Количество добавленных сообщений в модуле "Форум"
      • home_page – [Строка] – Значение поля "Домашняя страница (вебсайт)"
      • rank – [Строка] – Текущий ранк пользователя
    • message – [Строка] – Текст сообщения
  • total_posts – [Строка] – Общее количество сообщений в теме
<?php require 'uAPImodule.php'; $request = new Request(array( 'oauth_consumer_key' => 'Мой consumer_key', 'oauth_consumer_secret' => 'Мой consumer_secret', 'oauth_token' => 'Мой token', 'oauth_token_secret' => 'Мой token_secret' )); $response = $request->get('/forum/posts', array( 'id' => '9' )); print_r($response); //Получаем ответ curl -i -X GET -G --data-urlencode "oauth_consumer_key=ЗНАЧЕНИЕ" --data-urlencode "oauth_nonce=значение" --data-urlencode "oauth_signature_method=HMAC-SHA1" --data-urlencode "oauth_timestamp=значение" --data-urlencode "oauth_version=1.0" --data-urlencode "oauth_token=значение" --data-urlencode "auth_signature=значение" --data "id=9" http://yoursite.ucoz.ru/uapi/forum/posts
{ "topic":{ "closed":"yes", "name":"Название темы", "author":"Dmitry_DM", "description":"Описание темы", "url":"http://yoursite.ucoz.ru/forum/2-9-1", "id":9, "ontop":"yes", "firstontop":"yes" }, "page":1, "pages":"1", "per_page":"15", "posts":[ { "add_date":"2015-01-22 03:17", "message_id":11, "subscribe":"no", "topic_id":9, "user":{ "avatar":"http://2093175133.uid.me/avatar.jpg", "state":"Татарстан", "msn":"", "email":"dima@ucoz.net", "group":"Администраторы", "city":"Казань", "icq":"", "gender":null, "yahoo":"", "country":"Российская Федерация", "aol":"", "name":"Dmitry_DM", "full_name":"Dmitry Kiselev", "rankico":"http://s55558.ucoz.net/rnk/1/rank1.gif", "forum_posts":4, "home_page":"", "rank":"Рядовой" }, "message":"Текст сообщения" }, { //Сообщение 2 }, { //Сообщение 3 } ], "total_posts":3 } { "topic":{ "closed":"yes", "name":"Название темы", "author":"Dmitry_DM", "description":"Описание темы", "url":"http://yoursite.ucoz.ru/forum/2-9-1", "id":9, "ontop":"yes", "firstontop":"yes" }, "page":1, "pages":"1", "per_page":"15", "posts":[ { "add_date":"2015-01-22 03:17", "message_id":11, "subscribe":"no", "topic_id":9, "user":{ "avatar":"http://2093175133.uid.me/avatar.jpg", "state":"Татарстан", "msn":"", "email":"dima@ucoz.net", "group":"Администраторы", "city":"Казань", "icq":"", "gender":null, "yahoo":"", "country":"Российская Федерация", "aol":"", "name":"Dmitry_DM", "full_name":"Dmitry Kiselev", "rankico":"http://s55558.ucoz.net/rnk/1/rank1.gif", "forum_posts":4, "home_page":"", "rank":"Рядовой" }, "message":"Текст сообщения" }, { //Сообщение 2 }, { //Сообщение 3 } ], "total_posts":3 }
 

[POST] Добавить сообщение


 

[PUT] Редактировать сообщение


Расшифровка переменных

  • closed – [Строка] – Закрыта ли тема для новых сообщений? (yes/no)
  • name – [Строка] – Новое название темы
  • smiles – [Строка] – Разрешены ли смайлы в теме? (yes/no)
  • author – [Строка] – Никнейм пользователя, который создал тему
  • description – [Строка] – Описание темы
  • message – [Строка] – Текст сообщения
  • add_date – [Строка] – Дата добавления сообщения
  • end2br – [Строка] – Заменять переносы строки на html тег br (yes/no)
  • signature – [Строка] – Опция " Включить подпись" (yes/no)
  • id – [Строка] – ID темы
  • ontop – [Строка] – Тема всегда сверху (yes/no)
  • firstontop – [Строка] – Первое сообщение темы сделать шапкой (показывать на всех страницах) (yes/no)
  • includehtml – [Строка] – Разрешить HTML в сообщении (yes/no)
<?php require 'uAPImodule.php'; $request = new Request(array( 'oauth_consumer_key' => 'Мой consumer_key', 'oauth_consumer_secret' => 'Мой consumer_secret', 'oauth_token' => 'Мой token', 'oauth_token_secret' => 'Мой token_secret' )); $response = $request->put('/forum/posts', array( 'id' => '11', 'message' => 'Измененное сообщение из АПИ!' )); print_r($response); //Получаем ответ curl -i -X PUT --data-urlencode "oauth_consumer_key=ЗНАЧЕНИЕ" --data-urlencode "oauth_nonce=значение" --data-urlencode "oauth_signature_method=HMAC-SHA1" --data-urlencode "oauth_timestamp=значение" --data-urlencode "oauth_version=1.0" --data-urlencode "oauth_token=значение" --data-urlencode "auth_signature=значение" --data "id=11" --data-urlencode "message=Измененное сообщение из АПИ!" http://yoursite.ucoz.ru/uapi/forum/posts
{ "closed":"yes", "name":"Название темы", "smiles":"yes", "author":null, "description":"Описание темы", "message":"Измененное сообщение из АПИ!", "add_date":"2015-01-24 00:08", "end2br":"yes", "signature":"yes", "id":9, "ontop":"yes", "firstontop":"yes", "includehtml":"no" } { "closed":"yes", "name":"Название темы", "smiles":"yes", "author":null, "description":"Описание темы", "message":"Измененное сообщение из АПИ!", "add_date":"2015-01-24 00:08", "end2br":"yes", "signature":"yes", "id":9, "ontop":"yes", "firstontop":"yes", "includehtml":"no" }
 

[DELETE] Удалить сообщение


<?php require 'uAPImodule.php'; $request = new Request(array( 'oauth_consumer_key' => 'Мой consumer_key', 'oauth_consumer_secret' => 'Мой consumer_secret', 'oauth_token' => 'Мой token', 'oauth_token_secret' => 'Мой token_secret' )); $response = $request->delete('/forum/posts', array( 'id' => '2' )); print_r($response); //Получаем ответ curl -i -X DELETE -G --data-urlencode "oauth_consumer_key=ЗНАЧЕНИЕ" --data-urlencode "oauth_nonce=значение" --data-urlencode "oauth_signature_method=HMAC-SHA1" --data-urlencode "oauth_timestamp=значение" --data-urlencode "oauth_version=1.0" --data-urlencode "oauth_token=значение" --data-urlencode "auth_signature=значение" --data "id=2" http://yoursite.ucoz.ru/uapi/forum/posts
{ "success":{ "msg":"Сообщение удалено" } } { "success":{ "msg":"Сообщение удалено" } }
 

[GET] Опросы


Расшифровка переменных

       polls – [Массив] – Опросы
    • reads – [Число] – Количество просмотров опроса (темы)
    • subscribe – [Строка] – Включена ли подписка на ответы в теме? (yes/no)
    • forum_id – [Число] – ID форума, где создана тема
    • name – [Строка] – Название темы
    • author – [Строка] – Никнейм пользователя, который создал тему
    • description – [Строка] – Описание темы
    • question – [Строка] – Название вопроса
    • poll_id – [Строка] – ID опроса (темы)
    • url – [Строка] – Ссылка на тему
    • posts – [Число] – Количество сообщений в теме
    • votes_sum – [Число] – Количество пользователей прогосовавших в опросе
    • id – [Строка] – ID темы
    • firstontop – [Строка] – Первое сообщение темы сделать шапкой (показывать на всех страницах) (yes/no)
    • ontop – [Строка] – Тема всегда сверху (yes/no)
    • answers – [Массив] – Возможные варианты ответа в опросе (Ответ – количество голосов)
  • page – [Число] – Номер текущей страницы
  • pages_list – [Строка] – Список страниц с темами (переключатели)
  • per_page – [Число] – Количество тем на страницу
  • total_posts – [Строка] – Общее количество сообщений в теме
    •  forum – [Массив] – О форуме
          access – [Массив] – Доступ к форуму
      • reply – [Массив] – Какие группы имеют право добавлять ответы в темы
      • add – [Массив] – Какие группы имеют право создавать темы в темы форума
      • read – [Массив] – Какие группы имеют право читать темы форума
    • private – [Строка] – Установлен ли пароль для форума? (yes/no)
    • moderators – [Массив] – Массив никнеймов модераторов форума
    • name – [Строка] – Название форума
      •   rules – [Массив] – Правила форума
      • caption – [Строка] – Заголовок правил форума
      • description – [Строка] – Текст правил форума
    • description – [Строка] – Описание форума
    • state – [Строка] – Текущий статус форума (Активен/Закрыт/Отключен)
    • link2newmsg – [Строка] – URL адрес иконки "Есть новые сообщения"
    • noincrement – [Строка] – Не прибавлять пользователям количество сообщений (yes/no)
    • url – [Строка] – Ссылка на форум
    • noatall – [Строка] – Темы форума не должны выводиться в ленточном варианте форума (yes/no)
    • link2nomsg – [Строка] – URL адрес иконки "Нет новых сообщений"
    • id – [Строка] – ID форума
<?php require 'uAPImodule.php'; $request = new Request(array( 'oauth_consumer_key' => 'Мой consumer_key', 'oauth_consumer_secret' => 'Мой consumer_secret', 'oauth_token' => 'Мой token', 'oauth_token_secret' => 'Мой token_secret' )); $response = $request->get('/forum/poll', array( 'id' => '2' )); print_r($response); //Получаем ответ curl -i -X GET -G --data-urlencode "oauth_consumer_key=ЗНАЧЕНИЕ" --data-urlencode "oauth_nonce=значение" --data-urlencode "oauth_signature_method=HMAC-SHA1" --data-urlencode "oauth_timestamp=значение" --data-urlencode "oauth_version=1.0" --data-urlencode "oauth_token=значение" --data-urlencode "auth_signature=значение" --data "id=2" http://yoursite.ucoz.ru/uapi/forum/poll
{ "polls":[ { "reads":1, "subscribe":"no", "forum_id":2, "name":"Новый опрос", "author":"Dmitry_DM", "description":"Описание опроса", "question":"Вопрос", "poll_id":13, "url":"http://yoursite.ucoz.ru/forum/2-13-1", "posts":0, "votes_sum":0, "id":16, "firstontop":"no", "ontop":"no", "answers":[ { "Ответ 1":0 }, { "Ответ 2":0 }, { "Ответ 3":0 }, { "Ответ 4":0 } ] } ], "page":1, "pages":"1", "per_page":"25", "total_polls":1, "forum":{ "access":{ "reply":[ "Все группы" ], "add":[ "Все группы" ], "read":[ "Все группы" ] }, "private":"no", "moderators":[ "Dmitry_DM" ], "name":"Test forum", "rules":{ "caption":"ref", "description":"fdsf" }, "description":"Test forum description", "state":"Активен", "link2newmsg":"есть", "noincrement":"no", "url":"http://yoursite.ucoz.ru/forum/2", "noatall":"no", "link2nomsg":"есть", "id":2 } } { "polls":[ { "reads":1, "subscribe":"no", "forum_id":2, "name":"Новый опрос", "author":"Dmitry_DM", "description":"Описание опроса", "question":"Вопрос", "poll_id":13, "url":"http://yoursite.ucoz.ru/forum/2-13-1", "posts":0, "votes_sum":0, "id":16, "firstontop":"no", "ontop":"no", "answers":[ { "Ответ 1":0 }, { "Ответ 2":0 }, { "Ответ 3":0 }, { "Ответ 4":0 } ] } ], "page":1, "pages":"1", "per_page":"25", "total_polls":1, "forum":{ "access":{ "reply":[ "Все группы" ], "add":[ "Все группы" ], "read":[ "Все группы" ] }, "private":"no", "moderators":[ "Dmitry_DM" ], "name":"Test forum", "rules":{ "caption":"ref", "description":"fdsf" }, "description":"Test forum description", "state":"Активен", "link2newmsg":"есть", "noincrement":"no", "url":"http://yoursite.ucoz.ru/forum/2", "noatall":"no", "link2nomsg":"есть", "id":2 } }
 

[POST] Добавить опрос


Возможные параметры для передачи

  • forum_id – [Число] – ID форума, где необходимо создать опрос
  • name – [Строка] – Название опроса
  • message – [Строка] – Текст сообщения опроса
  • answers – [answers] – Ответы в опросе. Перечисление происходит через знак |
  • question – [Строка] – Вопрос опроса
<?php require 'uAPImodule.php'; $request = new Request(array( 'oauth_consumer_key' => 'Мой consumer_key', 'oauth_consumer_secret' => 'Мой consumer_secret', 'oauth_token' => 'Мой token', 'oauth_token_secret' => 'Мой token_secret' )); $response = $request->post('/forum/poll', array( 'forum_id' => '2', 'name' => 'Название опроса', 'message' => 'Мое сообщение', 'answers' => 'Первое|Второе|Третье', 'question' => 'Мой вопрос', )); print_r($response); //Получаем ответ curl -i -X PUT --data-urlencode "oauth_consumer_key=ЗНАЧЕНИЕ" --data-urlencode "oauth_nonce=значение" --data-urlencode "oauth_signature_method=HMAC-SHA1" --data-urlencode "oauth_timestamp=значение" --data-urlencode "oauth_version=1.0" --data-urlencode "oauth_token=значение" --data-urlencode "auth_signature=значение" --data "forum_id=2" --data-urlencode "name="Название опроса" --data-urlencode "message="Мое сообщение." --data-urlencode "answers=Первое|Второе|Третье" --data-urlencode "question=Мой вопрос" http://yoursite.ucoz.ru/uapi/forum/poll
{ "pollonly":"no", "author":"uAPI", "end2br":"yes", "add_date":"2015-02-15 23:32", "pollmulty":"no", "id":4, "ontop":"no", "answers":[ "Первое", "Второе", "Третье" ], "closed":"no", "name":"Название опроса", "smiles":"yes", "description":null, "polltime":"unlimited", "message":"Мое сообщение", "question":"Мой вопрос", "signature":"yes", "includehtml":"yes", "firstontop":"no" } { "pollonly":"no", "author":"uAPI", "end2br":"yes", "add_date":"2015-02-15 23:32", "pollmulty":"no", "id":4, "ontop":"no", "answers":[ "Первое", "Второе", "Третье" ], "closed":"no", "name":"Название опроса", "smiles":"yes", "description":null, "polltime":"unlimited", "message":"Мое сообщение", "question":"Мой вопрос", "signature":"yes", "includehtml":"yes", "firstontop":"no" }
 

[PUT] Изменить/Перенести опрос


Возможные параметры для передачи

  • poll_id – [Строка] – ID опроса (темы)
  • description – [Строка] – Новое описание темы
  • name – [Строка] – Новое название темы
  • newforum_id – [Число] – ID форума, куда необходимо перенести тему
<?php require 'uAPImodule.php'; $request = new Request(array( 'oauth_consumer_key' => 'Мой consumer_key', 'oauth_consumer_secret' => 'Мой consumer_secret', 'oauth_token' => 'Мой token', 'oauth_token_secret' => 'Мой token_secret' )); $response = $request->put('/forum/poll', array( 'poll_id' => '13', 'description' => 'Измененное описание', 'name' => 'Изменил название..', 'newforum_id' => '3' )); print_r($response); //Получаем ответ curl -i -X PUT --data-urlencode "oauth_consumer_key=ЗНАЧЕНИЕ" --data-urlencode "oauth_nonce=значение" --data-urlencode "oauth_signature_method=HMAC-SHA1" --data-urlencode "oauth_timestamp=значение" --data-urlencode "oauth_version=1.0" --data-urlencode "oauth_token=значение" --data-urlencode "auth_signature=значение" --data "post_id=13" --data-urlencode "description="Измененное описание" --data-urlencode "name="Изменил название.." --data-urlencode "newforum_id=3" http://yoursite.ucoz.ru/uapi/forum/poll
{ "success":{ "msg":"Опрос 'Новый опрос' перенесён в новый форум 'Test'" } } { "success":{ "msg":"Опрос 'Новый опрос' перенесён в новый форум 'Test'" } }
 

[DELETE] Удалить опрос


<?php require 'uAPImodule.php'; $request = new Request(array( 'oauth_consumer_key' => 'Мой consumer_key', 'oauth_consumer_secret' => 'Мой consumer_secret', 'oauth_token' => 'Мой token', 'oauth_token_secret' => 'Мой token_secret' )); $response = $request->delete('/forum/poll', array( 'poll_id' => '13' )); print_r($response); //Получаем ответ curl -i -X DELETE --data-urlencode "oauth_consumer_key=ЗНАЧЕНИЕ" --data-urlencode "oauth_nonce=значение" --data-urlencode "oauth_signature_method=HMAC-SHA1" --data-urlencode "oauth_timestamp=значение" --data-urlencode "oauth_version=1.0" --data-urlencode "oauth_token=значение" --data-urlencode "auth_signature=значение" --data "poll_id=13" http://yoursite.ucoz.ru/uapi/forum/poll
{ "success":{ "msg":"Тема удалена" } } { "success":{ "msg":"Тема удалена" } }
 

[GET] Результаты опроса


<?php require 'uAPImodule.php'; $request = new Request(array( 'oauth_consumer_key' => 'Мой consumer_key', 'oauth_consumer_secret' => 'Мой consumer_secret', 'oauth_token' => 'Мой token', 'oauth_token_secret' => 'Мой token_secret' )); $response = $request->get('/forum/poll/results', array( 'poll_id' => '15' )); print_r($response); //Получаем ответ curl -i -X GET -G ---data-urlencode "oauth_consumer_key=ЗНАЧЕНИЕ" --data-urlencode "oauth_nonce=значение" --data-urlencode "oauth_signature_method=HMAC-SHA1" --data-urlencode "oauth_timestamp=значение" --data-urlencode "oauth_version=1.0" --data-urlencode "oauth_token=значение" --data-urlencode "auth_signature=значение" --data "poll_id=15" http://yoursite.ucoz.ru/uapi/forum/poll/results
{ "question":null, "poll_id":15, "expired":"24.01.2015", "all_answers":0 } { "question":null, "poll_id":15, "expired":"24.01.2015", "all_answers":0 }

Яндекс.Метрика