文档

获取组列表

更新时间:

调用getGroupList接口查询所有的个体组ID。

QPS限制

本接口的单用户QPS限制为20次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。

请求语法

POST /green/sface/groups HTTPS|HTTP

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求头

请求参数

名称

类型

是否必选

示例值

描述

clientInfo

JSONObject

{"userId":"120234234","userNick":"Mike","userType":"others"}

客户端信息,由ClientInfo结构体通过JSON序列化获得,包含umid、imei等信息,具体结构描述,请参见ClientInfo

RequestBody

RequestBody无需设置。

返回数据

所有请求均返回JSON格式的数据。关于返回数据中的公共字段,请参见公共返回参数。返回数据中的data字段表示与业务相关的数据,一般是一个JSON结构体或数组。

说明

响应出错的情况下,data字段可能为空。

该接口返回的data字段包含以下参数。

名称类型示例值描述
codeInteger200

错误码,和HTTP状态码一致。

更多信息,请参见公共错误码

groupIdsStringArray["group1","group2"]所有已创建的个体组ID列表。

示例

请求示例

POST /green/sface/groups HTTP/1.1
公共请求头
正常返回示例
{
    "msg": "OK",
    "code": 200,
    "requestId": "36D384DA-8023-4E84-BCFD-0C5581352C16",
    "data": {
        "code": 200,
        "groupIds": [
            "group1",
            "group2"
        ]
    }
}

错误码

访问错误中心查看更多错误码。