野象新媒体接口文档

新媒体对外接口文档


用户列表

<p>[TOC]</p> <h5>简要描述</h5> <ul> <li>采用游标分页方式获取用户列表</li> <li>用户列表按用户创建时间倒序排列</li> </ul> <p>[游标分页请求代码示例](<a href="https://www.showdoc.com.cn/gatewaypartnerv1/10914997007617396">https://www.showdoc.com.cn/gatewaypartnerv1/10914997007617396</a> &quot;游标分页请求代码示例&quot;)</p> <h5>请求URL</h5> <ul> <li><code>/member/list</code></li> </ul> <h5>请求方式</h5> <ul> <li>GET</li> </ul> <h5>参数</h5> <table> <thead> <tr> <th style="text-align: left;">参数名            </th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型    </th> <th>说明                                            </th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">appId              </td> <td style="text-align: left;">是  </td> <td style="text-align: left;">Long  </td> <td>应用 ID                                        </td> </tr> <tr> <td style="text-align: left;">memberId          </td> <td style="text-align: left;">否  </td> <td style="text-align: left;">Long    </td> <td>用户 ID                                        </td> </tr> <tr> <td style="text-align: left;">beginDate          </td> <td style="text-align: left;">否  </td> <td style="text-align: left;">string  </td> <td>注册开始时间,时间格式为&quot;yyyy-MM-dd HH:mm:ss&quot;    </td> </tr> <tr> <td style="text-align: left;">endDate            </td> <td style="text-align: left;">否  </td> <td style="text-align: left;">string  </td> <td>注册结束时间,时间格式为&quot;yyyy-MM-dd HH:mm:ss&quot;    </td> </tr> <tr> <td style="text-align: left;">updateBeginDate          </td> <td style="text-align: left;">否  </td> <td style="text-align: left;">string  </td> <td>用户信息更新时间开始时间,时间格式为&quot;yyyy-MM-dd HH:mm:ss&quot;    </td> </tr> <tr> <td style="text-align: left;">updateEndDate            </td> <td style="text-align: left;">否  </td> <td style="text-align: left;">string  </td> <td>用户信息更新时间结束时间,时间格式为&quot;yyyy-MM-dd HH:mm:ss&quot;    </td> </tr> <tr> <td style="text-align: left;">lastLoginBeginDate</td> <td style="text-align: left;">否  </td> <td style="text-align: left;">string  </td> <td>最后登录开始时间,时间格式为&quot;yyyy-MM-dd HH:mm:ss&quot;</td> </tr> <tr> <td style="text-align: left;">lastLoginEndDate  </td> <td style="text-align: left;">否  </td> <td style="text-align: left;">string  </td> <td>最后登录结束时间,时间格式为&quot;yyyy-MM-dd HH:mm:ss&quot;</td> </tr> <tr> <td style="text-align: left;">cursor            </td> <td style="text-align: left;">否  </td> <td style="text-align: left;">string  </td> <td>游标(初始为 null,后续请求附带上次翻页的游标)</td> </tr> <tr> <td style="text-align: left;">size              </td> <td style="text-align: left;">是  </td> <td style="text-align: left;">Integer</td> <td>页大小范围:[1, 100],即最小值为1,最大值为100  </td> </tr> </tbody> </table> <h5>返回示例</h5> <pre><code>{     &amp;quot;code&amp;quot;: 0,     &amp;quot;data&amp;quot;: {         &amp;quot;cursor&amp;quot;: &amp;quot;15525059981479936&amp;quot;,         &amp;quot;isLast&amp;quot;: false,         &amp;quot;list&amp;quot;: [             {                 &amp;quot;appId&amp;quot;: 1000,                 &amp;quot;code&amp;quot;: 8,                 &amp;quot;createDateTime&amp;quot;: &amp;quot;2023-07-24 14:21:20&amp;quot;,                 &amp;quot;headImgUrl&amp;quot;: &amp;quot;&amp;quot;,                 &amp;quot;id&amp;quot;: 276416865004294144, &amp;quot;ip&amp;quot;: &amp;quot;101.40.83.18&amp;quot;,                 &amp;quot;lastLoginTime&amp;quot;: &amp;quot;0001-01-01 00:00:00&amp;quot;,                 &amp;quot;loginCount&amp;quot;: 0,                 &amp;quot;memberName&amp;quot;: &amp;quot;游客&amp;quot;,                 &amp;quot;mobile&amp;quot;: &amp;quot;&amp;quot;,                 &amp;quot;partnerId&amp;quot;: 1001,                 &amp;quot;promotionId&amp;quot;: 0,                 &amp;quot;promotionKeywords&amp;quot;: &amp;quot;xxx&amp;quot;,                 &amp;quot;state&amp;quot;: 1,                 &amp;quot;ua&amp;quot;: &amp;quot;Mozilla/5.0 (Linux; Android 12; ANA-AN00 Build/HUAWEIANA-AN00; wv) ...&amp;quot;,                 &amp;quot;adChannelType&amp;quot;: 1,                 &amp;quot;adId&amp;quot;: &amp;quot;xxx&amp;quot;,                 &amp;quot;advertiserId&amp;quot;: &amp;quot;xxx&amp;quot;,                 &amp;quot;updateDateTime&amp;quot;: &amp;quot;2023-07-24 14:21:20&amp;quot;, &amp;quot;openId&amp;quot;: &amp;quot;oTvie6TUIXsvR8WOmf2yE8PTpQik&amp;quot;             },             {                 &amp;quot;appId&amp;quot;: 1000,                 &amp;quot;code&amp;quot;: 10045,                 &amp;quot;createDateTime&amp;quot;: &amp;quot;2023-07-27 20:11:03&amp;quot;,                 &amp;quot;headImgUrl&amp;quot;: null,                 &amp;quot;id&amp;quot;: 15525059981479936, &amp;quot;ip&amp;quot;: &amp;quot;101.40.83.18&amp;quot;,                 &amp;quot;lastLoginTime&amp;quot;: null,                 &amp;quot;loginCount&amp;quot;: null,                 &amp;quot;memberName&amp;quot;: &amp;quot;游客&amp;quot;,                 &amp;quot;mobile&amp;quot;: null,                 &amp;quot;partnerId&amp;quot;: 10703379290656768,                 &amp;quot;promotionKeywords&amp;quot;: &amp;quot;xxx&amp;quot;,                 &amp;quot;promotionId&amp;quot;: null,                 &amp;quot;state&amp;quot;: null, &amp;quot;ua&amp;quot;: &amp;quot;Mozilla/5.0 (Linux; Android 12; ANA-AN00 Build/HUAWEIANA-AN00; wv) ...&amp;quot;,                 &amp;quot;adChannelType&amp;quot;: 1,                 &amp;quot;adId&amp;quot;: &amp;quot;xxx&amp;quot;,                 &amp;quot;advertiserId&amp;quot;: &amp;quot;xxx&amp;quot;,                 &amp;quot;updateDateTime&amp;quot;: &amp;quot;2023-07-27 20:11:03&amp;quot;, &amp;quot;openId&amp;quot;: &amp;quot;tTvie6TUIXsvR8WOmf2yE8PTpQiq&amp;quot;             }         ]     },     &amp;quot;msg&amp;quot;: &amp;quot;OK&amp;quot;,     &amp;quot;traceId&amp;quot;: &amp;quot;08111592-4add-4cbf-b0a1-15f66ed74604&amp;quot; }</code></pre> <h5>返回参数说明</h5> <table> <thead> <tr> <th style="text-align: left;">参数名    </th> <th style="text-align: left;">类型      </th> <th>说明                      </th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">code      </td> <td style="text-align: left;">Integer  </td> <td>返回码                    </td> </tr> <tr> <td style="text-align: left;">msg      </td> <td style="text-align: left;">String    </td> <td>返回消息                  </td> </tr> <tr> <td style="text-align: left;">traceId  </td> <td style="text-align: left;">String    </td> <td>链路追踪 ID                </td> </tr> <tr> <td style="text-align: left;">data      </td> <td style="text-align: left;">Object    </td> <td>游标分页返回数据列表响应  </td> </tr> </tbody> </table> <h6>游标分页返回数据列表响应结构</h6> <table> <thead> <tr> <th style="text-align: left;">参数名  </th> <th style="text-align: left;">类型    </th> <th>说明                      </th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">cursor  </td> <td style="text-align: left;">String  </td> <td>游标(下次翻页带上该参数)</td> </tr> <tr> <td style="text-align: left;">isLast  </td> <td style="text-align: left;">Boolean  </td> <td>是否最后一页              </td> </tr> <tr> <td style="text-align: left;">list    </td> <td style="text-align: left;">List    </td> <td>数据列表                  </td> </tr> </tbody> </table> <h6>数据列表项响应结构</h6> <table> <thead> <tr> <th style="text-align: left;">参数名              </th> <th style="text-align: left;">类型    </th> <th>说明                </th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">id                  </td> <td style="text-align: left;">Long    </td> <td>用户 ID              </td> </tr> <tr> <td style="text-align: left;">memberName          </td> <td style="text-align: left;">String  </td> <td>用户名称            </td> </tr> <tr> <td style="text-align: left;">createDateTime      </td> <td style="text-align: left;">DateTime</td> <td>创建时间            </td> </tr> <tr> <td style="text-align: left;">updateDateTime      </td> <td style="text-align: left;">DateTime</td> <td>更新时间            </td> </tr> <tr> <td style="text-align: left;">headImgUrl          </td> <td style="text-align: left;">String  </td> <td>头像                </td> </tr> <tr> <td style="text-align: left;">mobile              </td> <td style="text-align: left;">String  </td> <td>绑定手机号          </td> </tr> <tr> <td style="text-align: left;">partnerId          </td> <td style="text-align: left;">Long    </td> <td>所属子分销商 ID      </td> </tr> <tr> <td style="text-align: left;">appId              </td> <td style="text-align: left;">Long    </td> <td>归属应用 ID          </td> </tr> <tr> <td style="text-align: left;">promotionId        </td> <td style="text-align: left;">Long    </td> <td>推广 ID              </td> </tr> <tr> <td style="text-align: left;">promotionKeywords</td> <td style="text-align: left;">String</td> <td>推广链接口令</td> </tr> <tr> <td style="text-align: left;">loginCount          </td> <td style="text-align: left;">Integer  </td> <td>登录次数            </td> </tr> <tr> <td style="text-align: left;">lastLoginTime      </td> <td style="text-align: left;">DateTime</td> <td>最近登录时间        </td> </tr> <tr> <td style="text-align: left;">code                </td> <td style="text-align: left;">Long    </td> <td>用户 code            </td> </tr> <tr> <td style="text-align: left;">state              </td> <td style="text-align: left;">Integer  </td> <td>状态:1-正常;2-隐藏</td> </tr> <tr> <td style="text-align: left;">ip</td> <td style="text-align: left;">String</td> <td>IP</td> </tr> <tr> <td style="text-align: left;">ua</td> <td style="text-align: left;">String</td> <td>UA</td> </tr> <tr> <td style="text-align: left;">adChannelType</td> <td style="text-align: left;">Integer</td> <td>广告媒体渠道类型:&lt;/br&gt;1-巨量;&lt;/br&gt;2-腾讯MP;&lt;/br&gt;3-腾讯ADQ;&lt;/br&gt;4-快手;&lt;/br&gt;5-百度;&lt;/br&gt;6-其它;&lt;/br&gt;7-UC;&lt;/br&gt;8-VIVO;&lt;/br&gt;9-OPPO;&lt;/br&gt;10-HUAWEI;&lt;/br&gt;11-HONOR;&lt;/br&gt;12-小米</td> </tr> <tr> <td style="text-align: left;">advertiserId</td> <td style="text-align: left;">String</td> <td>广告账户 ID</td> </tr> <tr> <td style="text-align: left;">adId</td> <td style="text-align: left;">String</td> <td>广告计划 ID</td> </tr> <tr> <td style="text-align: left;">openId</td> <td style="text-align: left;">String</td> <td>用户在小程序或公众号的 openid</td> </tr> </tbody> </table> <h5>备注</h5> <ul> <li>返回错误代码请查看[错误响应](<a href="https://www.showdoc.com.cn/gatewaypartnerv1/10903560257841502">https://www.showdoc.com.cn/gatewaypartnerv1/10903560257841502</a> &quot;错误响应&quot;)页面描述</li> </ul>

页面列表

ITEM_HTML