OPEN-API / WIKI · Commits

Commit 6e89ee0a71e2be7f6829aa1272147b21b681f753

Authored by 国亚奇
1 parent eaa86f50

ugc评论api

Inline Side-by-side
Showing 6 changed files with 531 additions and 0 deletions
05.互动云/10.21 ugc评论-评论一条内容.md 0 → 100644
  View file @6e89ee0
  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>isAuthor</td>
  49 + <td>true</td>
  50 + <td>string</td>
  51 + <td>是否是作者 true:是 false:否</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 +}
  67 +{
  68 + "errorCode": "4",
  69 + "errorMessage": "该用户已被禁言"
  70 +}
  71 +{
  72 + "errorCode": "51002",
  73 + "errorMessage": "该话题已被屏蔽或删除"
  74 +}
  75 +{
  76 + "errorCode": "5",
  77 + "errorMessage": "评论内容审核异常"
  78 +}
  79 +{
  80 + "errorCode": "6",
  81 + "errorMessage": "评论内容不合规"
  82 +}
  83 +{
  84 + errorCode:"xxx", //错误代码(非0）
  85 + errorMsg:"失败" //错误信息
  86 +}
05.互动云/10.22 ugc评论-回复一条评论.md 0 → 100644
  View file @6e89ee0
  1 +/*
  2 + Title: 10.4 回复一条评论
  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 +}
  67 +{
  68 + "errorCode": "4",
  69 + "errorMessage": "该用户已被禁言"
  70 +}
  71 +{
  72 + "errorCode": "51001",
  73 + "errorMessage": "该评论已被删除"
  74 +}
  75 +{
  76 + "errorCode": "5",
  77 + "errorMessage": "评论内容审核异常"
  78 +}
  79 +{
  80 + "errorCode": "6",
  81 + "errorMessage": "评论内容不合规"
  82 +}
  83 +{
  84 + errorCode:"xxx", //错误代码(非0）
  85 + errorMsg:"失败" //错误信息
  86 +}
05.互动云/10.23 ugc评论-删除评论.md 0 → 100644
  View file @6e89ee0
  1 +/*
  2 + Title: 10.2 删除评论
  3 + Sort: 102
  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>commentId</td>
  31 + <td>true</td>
  32 + <td>string</td>
  33 + <td>评论ID</td>
  34 + </tr>
  35 + <tr>
  36 + <td>plat</td>
  37 + <td>true</td>
  38 + <td>string</td>
  39 + <td>客户端平台[i：IOS客户端，a：Android客户端]</td>
  40 + </tr>
  41 + <tr>
  42 + <td>sign</td>
  43 + <td>true</td>
  44 + <td>string</td>
  45 + <td>签名</td>
  46 + </tr>
  47 +</table>
  48 +-----
  49 +#### 返回格式说明:
  50 +```
  51 +{
  52 + errorCode:"0",
  53 + errorMsg:"删除评论成功"
  54 +}
  55 +{
  56 + errorCode:"xxx", //错误代码(非0）
  57 + errorMsg:"失败" //错误信息
  58 +}
05.互动云/10.24 ugc评论-删除回复.md 0 → 100644
  View file @6e89ee0
  1 +/*
  2 + Title: 10.5 删除回复
  3 + Sort: 105
  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>replyId</td>
  31 + <td>true</td>
  32 + <td>string</td>
  33 + <td>回复ID</td>
  34 + </tr>
  35 + <tr>
  36 + <td>plat</td>
  37 + <td>true</td>
  38 + <td>string</td>
  39 + <td>客户端平台[i：IOS客户端，a：Android客户端]</td>
  40 + </tr>
  41 + <tr>
  42 + <td>sign</td>
  43 + <td>true</td>
  44 + <td>string</td>
  45 + <td>签名</td>
  46 + </tr>
  47 +</table>
  48 +-----
  49 +#### 返回格式说明:
  50 +```
  51 +{
  52 + errorCode:"0",
  53 + errorMsg:"删除回复成功"
  54 +}
  55 +{
  56 + errorCode:"xxx", //错误代码(非0）
  57 + errorMsg:"失败" //错误信息
  58 +}
05.互动云/10.25 ugc评论-加载评论列表.md 0 → 100644
  View file @6e89ee0
  1 +/*
  2 + Title: 10.3 加载评论列表
  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>sid</td>
  49 + <td>true</td>
  50 + <td>string</td>
  51 + <td>用户id</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 + "total_columns": "4",
  68 + "hasNext": "true",
  69 + "comments": [
  70 + {
  71 + "comment": {
  72 + "commentId": "7",
  73 + "topicId": "1",
  74 + "uid": "xxx",
  75 + "nick": "asd",
  76 + "facepath": "http://xxx",
  77 + "content": "我不是楼主2",
  78 + "created_at": "2022-08-04 11:51",
  79 + "plat": "a",
  80 + "seqId": "1659585066201",
  81 + "praiseCount": "0",
  82 + "isPraised": "false"
  83 + },
  84 + "replyData": {
  85 + "replyCount": "0"
  86 + }
  87 + },
  88 + {
  89 + "comment": {
  90 + "commentId": "6",
  91 + "topicId": "1",
  92 + "uid": "xxx",
  93 + "nick": "asd",
  94 + "facepath": "http://xxx",
  95 + "content": "我不是楼主",
  96 + "created_at": "2022-08-04 11:40",
  97 + "plat": "a",
  98 + "seqId": "1659584455471",
  99 + "praiseCount": "0",
  100 + "isPraised": "false"
  101 + },
  102 + "replyData": {
  103 + "replyCount": "1",
  104 +"replys": [
  105 + {
  106 + "replyId": "4",
  107 + "commentId": "1",
  108 + "fromSid": "xxx",
  109 + "fromNick": "asd",
  110 + "fromFace": "http://xxx",
  111 + "toSid": "xxx",
  112 + "toNick": "asd",
  113 + "toFace": "http://xxx",
  114 + "content": "789额",
  115 + "created_at": "2022-08-04 11:39",
  116 + "plat": "a",
  117 + "praiseCount": "0",
  118 + "isPraised": "false",
  119 + "seqId": "1659584349971"
  120 + }]
  121 + }
  122 + }
  123 + ]
  124 + }
  125 +}
  126 +{
  127 + errorCode:"xxx", //错误代码(非0）
  128 + errorMsg:"失败" //错误信息
  129 +}
05.互动云/10.26 ugc评论-加载回复列表.md 0 → 100644
  View file @6e89ee0
  1 +/*
  2 + Title: 10.6 加载回复列表
  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>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>sid</td>
  49 + <td>true</td>
  50 + <td>string</td>
  51 + <td>用户id</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 + "replyData": {
  68 + "replys": [
  69 + {
  70 + "replyId": "4",
  71 + "commentId": "1",
  72 + "fromSid": "xxx",
  73 + "fromNick": "asd",
  74 + "fromFace": "http://xxxxx",
  75 + "toSid": "xxx",
  76 + "toNick": "asd",
  77 + "toFace": "http://xxx",
  78 + "content": "789额",
  79 + "created_at": "2022-08-04 11:39",
  80 + "plat": "a",
  81 + "praiseCount": "0",
  82 + "isPraised": "false",
  83 + "seqId": "1659584349971"
  84 + },
  85 + {
  86 + "replyId": "2",
  87 + "commentId": "1",
  88 + "fromSid": "xxx",
  89 + "fromNick": "asd",
  90 + "fromFace": "http://xxx",
  91 + "toSid": "xxx",
  92 + "toNick": "asd",
  93 + "toFace": "http://xxx",
  94 + "content": "456哈",
  95 + "created_at": "2022-08-02 17:28",
  96 + "plat": "a",
  97 + "praiseCount": "0",
  98 + "isPraised": "false",
  99 + "seqId": "2"
  100 + }
  101 + ],
  102 + "total_columns": "2",
  103 + "hasNext": "false"
  104 + }
  105 + }
  106 +}
  107 +{
  108 + "errorCode": "51001",
  109 + "errorMessage": "该评论已被删除"
  110 +}
  111 +{
  112 + errorCode:"xxx", //错误代码(非0）
  113 + errorMsg:"失败" //错误信息
  114 +}