OPEN-API / WIKI · Commits

Commit ec8dd1911dfd79cf92225fd6f9659ceec38ce3b5

Authored by 国亚奇
1 parent f93adcf4

add wiki

Inline Side-by-side
Showing 2 changed files with 247 additions and 0 deletions
05.互动云/10.8 二级评论-评论一条内容V2.md 0 → 100644
  View file @ec8dd19
  1 +/*
  2 + Title: 10.8 评论一条内容
  3 + Sort: 101
  4 +*/
  5 +#### 请求方式: POST
  6 +-----
  7 +#### 返回格式: JSON
  8 +-----
  9 +#### 请求参数说明:
  10 +<table class="table table-bordered table-striped table-condensed">
  11 + <tr>
  12 + <th>参数</th>
  13 + <th>必选</th>
  14 + <th>类型</th>
  15 + <th>说明</th>
  16 + </tr>
  17 + <tr>
  18 + <td>appId</td>
  19 + <td>true</td>
  20 + <td>string</td>
  21 + <td>应用ID即</td>
  22 + </tr>
  23 + <tr>
  24 + <td>topicId</td>
  25 + <td>true</td>
  26 + <td>string</td>
  27 + <td>内容ID</td>
  28 + </tr>
  29 + <tr>
  30 + <td>sid</td>
  31 + <td>true</td>
  32 + <td>string</td>
  33 + <td>用户ID</td>
  34 + </tr>
  35 + <tr>
  36 + <td>comment</td>
  37 + <td>true</td>
  38 + <td>string</td>
  39 + <td>评论内容</td>
  40 + </tr>
  41 + <tr>
  42 + <td>plat</td>
  43 + <td>true</td>
  44 + <td>string</td>
  45 + <td>客户端平台[i：IOS客户端，a：Android客户端]</td>
  46 + </tr>
  47 + <tr>
  48 + <td>sign</td>
  49 + <td>true</td>
  50 + <td>string</td>
  51 + <td>签名</td>
  52 + </tr>
  53 +</table>
  54 +-----
  55 +#### 返回格式说明:
  56 +```
  57 +{
  58 + "errorCode": "0",
  59 + "errorMessage": "评论成功",
  60 + "data": {
  61 + "comment": {
  62 + "commentId": "4294",
  63 + "topicId": "12",
  64 + "uid": "10514228",
  65 + "nick": "马亚鑫",
  66 + "facepath": "http://yweb0.cnliveimg.com/images/headImg/2019/1129/1575022593286.jpg",
  67 + "content": "冰雪世界哦哦哦",
  68 + "created_at": "2020-01-13 14:27",
  69 + "plat": "a"
  70 + }
  71 + }
  72 +}
  73 +{
  74 + "errorCode": "4",
  75 + "errorMessage": "该用户已被禁言"
  76 +}
  77 +{
  78 + "errorCode": "51002",
  79 + "errorMessage": "该话题已被屏蔽或删除"
  80 +}
  81 +{
  82 + "errorCode": "5",
  83 + "errorMessage": "评论内容审核异常"
  84 +}
  85 +{
  86 + "errorCode": "6",
  87 + "errorMessage": "评论内容不合规"
  88 +}
  89 +{
  90 + errorCode:"xxx", //错误代码(非0）
  91 + errorMsg:"失败" //错误信息
  92 +}
05.互动云/10.9 二级评论-加载评论列表V2.md 0 → 100644
  View file @ec8dd19
  1 +/*
  2 + Title: 10.9 加载评论列表
  3 + Sort: 103
  4 +*/
  5 +#### 请求方式: get
  6 +-----
  7 +#### 返回格式: JSON
  8 +-----
  9 +#### 请求参数说明:
  10 +<table class="table table-bordered table-striped table-condensed">
  11 + <tr>
  12 + <th>参数</th>
  13 + <th>必选</th>
  14 + <th>类型</th>
  15 + <th>说明</th>
  16 + </tr>
  17 + <tr>
  18 + <td>appId</td>
  19 + <td>true</td>
  20 + <td>string</td>
  21 + <td>应用ID</td>
  22 + </tr>
  23 + <tr>
  24 + <td>topicId</td>
  25 + <td>true</td>
  26 + <td>string</td>
  27 + <td>话题ID</td>
  28 + </tr>
  29 + <tr>
  30 + <td>seqId</td>
  31 + <td>true</td>
  32 + <td>string</td>
  33 + <td>顺序ID(第一页传0)</td>
  34 + </tr>
  35 + <tr>
  36 + <td>count</td>
  37 + <td>true</td>
  38 + <td>string</td>
  39 + <td>每页显示条数</td>
  40 + </tr>
  41 + <tr>
  42 + <td>plat</td>
  43 + <td>true</td>
  44 + <td>string</td>
  45 + <td>客户端平台[i：IOS客户端，a：Android客户端]</td>
  46 + </tr>
  47 + <tr>
  48 + <td>sign</td>
  49 + <td>true</td>
  50 + <td>string</td>
  51 + <td>签名</td>
  52 + </tr>
  53 +</table>
  54 +-----
  55 +#### 返回格式说明:
  56 +```
  57 +{
  58 + errorCode: "0",
  59 + errorMessage: "成功",
  60 + data: {
  61 + total_columns: "5",
  62 + hasNext: "false",
  63 + comments: [
  64 + {
  65 + comment: {
  66 + commentId: "5",
  67 + topicId: "51",
  68 + uid: "10514228",
  69 + nick: "马小马",
  70 + facepath: "http://yweb0.cnliveimg.com/images/headImg/2020/0529/1590744775043.jpg",
  71 + content: "电闪雷鸣4",
  72 + created_at: "2020-06-10 11:31",
  73 + plat: "a",
  74 + seqId: "15917598979870",
  75 + isBestComment: "true"
  76 + },
  77 + replyData: {
  78 + replyCount: "0"
  79 + }
  80 + },
  81 + {
  82 + comment: {
  83 + commentId: "4",
  84 + topicId: "51",
  85 + uid: "10514228",
  86 + nick: "马小马",
  87 + facepath: "http://yweb0.cnliveimg.com/images/headImg/2020/0529/1590744775043.jpg",
  88 + content: "电闪雷鸣3",
  89 + created_at: "2020-06-10 11:31",
  90 + plat: "a",
  91 + seqId: "15917598918980",
  92 + isBestComment: "true"
  93 + },
  94 + replyData: {
  95 + replyCount: "0"
  96 + }
  97 + },
  98 + {
  99 + comment: {
  100 + commentId: "3",
  101 + topicId: "51",
  102 + uid: "10514228",
  103 + nick: "马小马",
  104 + facepath: "http://yweb0.cnliveimg.com/images/headImg/2020/0529/1590744775043.jpg",
  105 + content: "电闪雷鸣2",
  106 + created_at: "2020-06-10 11:31",
  107 + plat: "a",
  108 + seqId: "15917598846620",
  109 + isBestComment: "true"
  110 + },
  111 + replyData: {
  112 + replyCount: "0"
  113 + }
  114 + },
  115 + {
  116 + comment: {
  117 + commentId: "7",
  118 + topicId: "51",
  119 + uid: "10514228",
  120 + nick: "马小马",
  121 + facepath: "http://yweb0.cnliveimg.com/images/headImg/2020/0529/1590744775043.jpg",
  122 + content: "熊猫胖砸",
  123 + created_at: "2020-06-10 14:24",
  124 + plat: "a",
  125 + seqId: "1591770276808",
  126 + isBestComment: "false"
  127 + },
  128 + replyData: {
  129 + replyCount: "0"
  130 + }
  131 + },
  132 + {
  133 + comment: {
  134 + commentId: "6",
  135 + topicId: "51",
  136 + uid: "10514228",
  137 + nick: "马小马",
  138 + facepath: "http://yweb0.cnliveimg.com/images/headImg/2020/0529/1590744775043.jpg",
  139 + content: "啦啦啦",
  140 + created_at: "2020-06-10 11:48",
  141 + plat: "a",
  142 + seqId: "1591760890409",
  143 + isBestComment: "false"
  144 + },
  145 + replyData: {
  146 + replyCount: "0"
  147 + }
  148 + }
  149 + ]
  150 + }
  151 +}
  152 +{
  153 + errorCode:"xxx", //错误代码(非0）
  154 + errorMsg:"失败" //错误信息
  155 +}