基础 qianmi.qmcs.groups.get(获取自定义用户分组列表)
获取自定义用户分组列表
用户授权类型
不需要授权
公共参数
请求地址:
系统级请求参数:
环境 | HTTP请求地址 | HTTPS请求地址 | 正式环境 | http://gw.api.qianmi.com/api | https://api.qianmi.com/api |
---|
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
method | String | 必须 | API接口名称 |
access_token | String | 可选 | 用户登录授权以后,QMOP颁发给应用的授权信息,详细介绍请点击这里,当前API的用户授权类型标明:"需要授权",则此参数必传,"不需要授权",则此参数不需要传。 |
format | String | 必须 | 指定响应格式,目前支持格式为json |
appKey | String | 必须 | 分配给应用的AppKey |
v | String | 必须 | API协议版本,当前可选值:1.1 |
sign | String | 必须 | API输入参数签名结果 |
timestamp | String | 必须 | 请求时间戳,时区为GMT+8(北京时间),格式:"yyyy-MM-dd HH:mm:ss",例如"2012-12-20 10:20:35",开放平台允许客户端请求的最大时间误差为10分钟 |
业务参数
名称 | 类型 | 是否必须 | 示例值 | 默认值 | 描述 |
---|---|---|---|---|---|
group_names | String | 可选 | vip,vip1,vip2 | 分组列表,不传代表查询所有分组信息,但不会返回组下面的用户信息。如果应用没有设置分组则返回空。组名不能以default开头,default开头是系统默认的组。 | |
page_no | Number | 可选 | 1 | 0 | 当前页码,从0开始,整数 |
page_size | Number | 可选 | 20 | 50 | 每页条数 |
请求示例
OpenClient client = new DefaultOpenClient(url, appKey, appSecret); QmcsGroupsGetRequest req = new QmcsGroupsGetRequest(); req.setGroupNames("group_names"); req.setPageNo(1); req.setPageSize(10); QmcsGroupsGetResponse response = client.execute(req, accessToken);
$client = new OpenClient; $client->appKey = appKey; $client->appSecret = appSecret; $req = new QmcsGroupsGetRequest; $req->setGroupNames("group_names"); $req->setPageNo(1); $req->setPageSize(10); $res = $client->execute($req, $accessToken);
IOpenClient client = new DefaultOpenClient(url, appKey, appSecret); QmcsGroupsGetRequest req = new QmcsGroupsGetRequest(); req.GroupNames = "group_names"; req.PageNo = 1; req.PageSize = 10; QmcsGroupsGetResponse response = client.Execute(req, accessToken);
响应参数
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
total_results | Number | 总条数 |
响应示例
异常示例
{ "errorToken": "@@$-ERROR_TOKEN$-@@", "code": "33", "message": "非法的参数", "solution": "请查看根据服务接口对参数格式的要求", "subErrors": { "subError": [{ "code": "isv.invalid-paramete:XXXX", "message": "参数XXXX无效,格式不对、非法值、越界等" }] }
错误码
API工具
FAQ