OPEN-API / WIKI · Commits

Commit be5be67e78b682b6cea456d2212482a668aafda3

Authored by 马亚鑫
1 parent e951250b

add中食展评论接口

Inline Side-by-side
Showing 4 changed files with 474 additions and 0 deletions
05.互动云/10.11 三级评论一条内容.md 0 → 100644
  View file @be5be67
  1 +/*
  2 + Title: 10.11 评论一条内容
  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>toSid</td>
  31 + <td>true</td>
  32 + <td>string</td>
  33 + <td>内容发布者用户ID</td>
  34 + </tr>
  35 + <tr>
  36 + <td>fromSid</td>
  37 + <td>true</td>
  38 + <td>string</td>
  39 + <td>评论者用户ID</td>
  40 + </tr>
  41 + <tr>
  42 + <td>comment</td>
  43 + <td>true</td>
  44 + <td>string</td>
  45 + <td>评论内容</td>
  46 + </tr>
  47 + <tr>
  48 + <td>plat</td>
  49 + <td>true</td>
  50 + <td>string</td>
  51 + <td>客户端平台[i：IOS客户端，a：Android客户端]</td>
  52 + </tr>
  53 + <tr>
  54 + <td>sign</td>
  55 + <td>true</td>
  56 + <td>string</td>
  57 + <td>签名</td>
  58 + </tr>
  59 +</table>
  60 +-----
  61 +#### 返回格式说明:
  62 +```
  63 +{
  64 + "errorCode": "0",
  65 + "errorMessage": "评论成功",
  66 + "data": {
  67 + "comment": {
  68 + "commentId": "4294",
  69 + "topicId": "12",
  70 + "uid": "10514228",
  71 + "nick": "马亚鑫",
  72 + "facepath": "http://yweb0.cnliveimg.com/images/headImg/2019/1129/1575022593286.jpg",
  73 + "content": "冰雪世界哦哦哦",
  74 + "created_at": "2020-01-13 14:27",
  75 + "plat": "a"
  76 + }
  77 + }
  78 +}
  79 +{
  80 + "errorCode": "4",
  81 + "errorMessage": "该用户已被禁言"
  82 +}
  83 +{
  84 + "errorCode": "6",
  85 + "errorMessage": "评论内容不合规"
  86 +}
  87 +{
  88 + errorCode:"xxx", //错误代码(非0）
  89 + errorMsg:"失败" //错误信息
  90 +}
05.互动云/10.12 三级评论-回复一条评论.md 0 → 100644
  View file @be5be67
  1 +/*
  2 + Title: 10.12 回复一条评论
  3 + Sort: 104
  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>commentId</td>
  25 + <td>true</td>
  26 + <td>string</td>
  27 + <td>评论ID</td>
  28 + </tr>
  29 + <tr>
  30 + <td>fromSid</td>
  31 + <td>true</td>
  32 + <td>string</td>
  33 + <td>回复者ID</td>
  34 + </tr>
  35 + <tr>
  36 + <td>toSid</td>
  37 + <td>true</td>
  38 + <td>string</td>
  39 + <td>被回复者ID</td>
  40 + </tr>
  41 + <tr>
  42 + <td>comment</td>
  43 + <td>true</td>
  44 + <td>string</td>
  45 + <td>回复内容</td>
  46 + </tr>
  47 + <tr>
  48 + <td>plat</td>
  49 + <td>true</td>
  50 + <td>string</td>
  51 + <td>客户端平台[i：IOS客户端，a：Android客户端]</td>
  52 + </tr>
  53 + <tr>
  54 + <td>sign</td>
  55 + <td>true</td>
  56 + <td>string</td>
  57 + <td>签名</td>
  58 + </tr>
  59 +</table>
  60 +-----
  61 +#### 返回格式说明:
  62 +```
  63 +{
  64 + "errorCode": "0",
  65 + "errorMessage": "评论成功",
  66 + "data": {
  67 + "reply": {
  68 + "replyId": "4289",
  69 + "commentId": "4288",
  70 + "fromSid": "10514228",
  71 + "fromNick": "马亚鑫",
  72 + "fromFace": "http://yweb0.cnliveimg.com/images/headImg/2019/1129/1575022593286.jpg",
  73 + "toSid": "10514228",
  74 + "toNick": "马亚鑫",
  75 + "toFace": "http://yweb0.cnliveimg.com/images/headImg/2019/1129/1575022593286.jpg",
  76 + "content": "好噢噢噢噢啊啊",
  77 + "created_at": "2020-01-13 14:22",
  78 + "plat": "a"
  79 + }
  80 + }
  81 +}
  82 +{
  83 + "errorCode": "4",
  84 + "errorMessage": "该用户已被禁言"
  85 +}
  86 +{
  87 + "errorCode": "51001",
  88 + "errorMessage": "该评论已被删除"
  89 +}
  90 +{
  91 + "errorCode": "51002",
  92 + "errorMessage": "该话题已被屏蔽或删除"
  93 +}
  94 +{
  95 + "errorCode": "5",
  96 + "errorMessage": "评论内容审核异常"
  97 +}
  98 +{
  99 + "errorCode": "6",
  100 + "errorMessage": "评论内容不合规"
  101 +}
  102 +{
  103 + errorCode:"xxx", //错误代码(非0）
  104 + errorMsg:"失败" //错误信息
  105 +}
05.互动云/10.13 三级评论-加载回复列表.md 0 → 100644
  View file @be5be67
  1 +/*
  2 + Title: 10.13 加载回复列表
  3 + Sort: 106
  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>commentId</td>
  25 + <td>true</td>
  26 + <td>string</td>
  27 + <td>评论ID</td>
  28 + </tr>
  29 + <tr>
  30 + <td>replyId</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 + "comment": {
  62 + "commentId": "18",
  63 + "topicId": "1111",
  64 + "uid": "10514228",
  65 + "nick": "mayaxin",
  66 + "facepath": "http://yweb0.cnliveimg.com/images/headImg/2019/1129/1575022593286.jpg",
  67 + "content": "话题的第5条评论",
  68 + "created_at": "2019-12-24 09:24",
  69 + "plat": "a"
  70 + },
  71 + "replyData": {
  72 + "replys": [
  73 + {
  74 + "replyId": "21",
  75 + "commentId": "18",
  76 + "fromSid": "10514228",
  77 + "fromNick": "mayaxin",
  78 + "fromFace": "http://yweb0.cnliveimg.com/images/headImg/2019/1129/1575022593286.jpg",
  79 + "toSid": "145680",
  80 + "toNick": "国亚奇",
  81 + "toFace": "http://yweb0.cnliveimg.com/images/headImg/2019/1120/1574240741728.jpg",
  82 + "content": "回复第3条",
  83 + "created_at": "2019-12-24 09:26",
  84 + "plat": "a"
  85 + },
  86 + {
  87 + "replyId": "19",
  88 + "commentId": "18",
  89 + "fromSid": "145680",
  90 + "fromNick": "国亚奇",
  91 + "fromFace": "http://yweb0.cnliveimg.com/images/headImg/2019/1120/1574240741728.jpg",
  92 + "toSid": "10514228",
  93 + "toNick": "mayaxin",
  94 + "toFace": "http://yweb0.cnliveimg.com/images/headImg/2019/1129/1575022593286.jpg",
  95 + "content": "回复第1条",
  96 + "created_at": "2019-12-24 09:26",
  97 + "plat": "a"
  98 + }
  99 + ],
  100 + "total_columns": "2",
  101 + "hasNext": "false"
  102 + }
  103 + }
  104 +}
  105 +{
  106 + "errorCode": "51001",
  107 + "errorMessage": "该评论已被删除"
  108 +}
  109 +{
  110 + errorCode:"xxx", //错误代码(非0）
  111 + errorMsg:"失败" //错误信息
  112 +}
05.互动云/10.14 三级评论-加载评论列表.md 0 → 100644
  View file @be5be67
  1 +/*
  2 + Title: 10.14 加载评论列表
  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>fromSid</td>
  31 + <td>true</td>
  32 + <td>string</td>
  33 + <td>读取人ID</td>
  34 + </tr>
  35 + <tr>
  36 + <td>sid</td>
  37 + <td>true</td>
  38 + <td>string</td>
  39 + <td>内容发布者ID</td>
  40 + </tr>
  41 + <tr>
  42 + <td>seqId</td>
  43 + <td>true</td>
  44 + <td>string</td>
  45 + <td>顺序ID(第一页传0)</td>
  46 + </tr>
  47 + <tr>
  48 + <td>count</td>
  49 + <td>true</td>
  50 + <td>string</td>
  51 + <td>每页显示条数</td>
  52 + </tr>
  53 + <tr>
  54 + <td>plat</td>
  55 + <td>true</td>
  56 + <td>string</td>
  57 + <td>客户端平台[i：IOS客户端，a：Android客户端]</td>
  58 + </tr>
  59 + <tr>
  60 + <td>sign</td>
  61 + <td>true</td>
  62 + <td>string</td>
  63 + <td>签名</td>
  64 + </tr>
  65 +</table>
  66 +-----
  67 +#### 返回格式说明:
  68 +```
  69 +{
  70 + errorCode: "0",
  71 + errorMessage: "成功",
  72 + data: {
  73 + total_columns: "5",
  74 + hasNext: "false",
  75 + comments: [
  76 + {
  77 + comment: {
  78 + commentId: "5",
  79 + topicId: "51",
  80 + uid: "10514228",
  81 + nick: "马小马",
  82 + facepath: "http://yweb0.cnliveimg.com/images/headImg/2020/0529/1590744775043.jpg",
  83 + content: "电闪雷鸣4",
  84 + created_at: "2020-06-10 11:31",
  85 + plat: "a",
  86 + seqId: "15917598979870",
  87 + isBestComment: "true"
  88 + },
  89 + replyData: {
  90 + replyCount: "0"
  91 + }
  92 + },
  93 + {
  94 + comment: {
  95 + commentId: "4",
  96 + topicId: "51",
  97 + uid: "10514228",
  98 + nick: "马小马",
  99 + facepath: "http://yweb0.cnliveimg.com/images/headImg/2020/0529/1590744775043.jpg",
  100 + content: "电闪雷鸣3",
  101 + created_at: "2020-06-10 11:31",
  102 + plat: "a",
  103 + seqId: "15917598918980",
  104 + isBestComment: "true"
  105 + },
  106 + replyData: {
  107 + replyCount: "0"
  108 + }
  109 + },
  110 + {
  111 + comment: {
  112 + commentId: "3",
  113 + topicId: "51",
  114 + uid: "10514228",
  115 + nick: "马小马",
  116 + facepath: "http://yweb0.cnliveimg.com/images/headImg/2020/0529/1590744775043.jpg",
  117 + content: "电闪雷鸣2",
  118 + created_at: "2020-06-10 11:31",
  119 + plat: "a",
  120 + seqId: "15917598846620",
  121 + isBestComment: "true"
  122 + },
  123 + replyData: {
  124 + replyCount: "0"
  125 + }
  126 + },
  127 + {
  128 + comment: {
  129 + commentId: "7",
  130 + topicId: "51",
  131 + uid: "10514228",
  132 + nick: "马小马",
  133 + facepath: "http://yweb0.cnliveimg.com/images/headImg/2020/0529/1590744775043.jpg",
  134 + content: "熊猫胖砸",
  135 + created_at: "2020-06-10 14:24",
  136 + plat: "a",
  137 + seqId: "1591770276808",
  138 + isBestComment: "false"
  139 + },
  140 + replyData: {
  141 + replyCount: "0"
  142 + }
  143 + },
  144 + {
  145 + comment: {
  146 + commentId: "6",
  147 + topicId: "51",
  148 + uid: "10514228",
  149 + nick: "马小马",
  150 + facepath: "http://yweb0.cnliveimg.com/images/headImg/2020/0529/1590744775043.jpg",
  151 + content: "啦啦啦",
  152 + created_at: "2020-06-10 11:48",
  153 + plat: "a",
  154 + seqId: "1591760890409",
  155 + isBestComment: "false"
  156 + },
  157 + replyData: {
  158 + replyCount: "0"
  159 + }
  160 + }
  161 + ]
  162 + }
  163 +}
  164 +{
  165 + errorCode:"xxx", //错误代码(非0）
  166 + errorMsg:"失败" //错误信息
  167 +}