移除個體組中個體
更新時(shí)間:
調(diào)用deletePersonFromGroup接口從個體組中移除個體。
QPS限制
本接口的單用戶QPS限制為10次/秒。超過限制,API調(diào)用會被限流,這可能會影響您的業(yè)務(wù),請合理調(diào)用。
請求語法
POST /green/sface/person/groups/delete HTTPS|HTTP
請求頭
該接口使用公共請求頭,無特殊請求頭。請參見公共請求頭。
請求參數(shù)
名稱 | 類型 | 是否必選 | 示例值 | 描述 |
clientInfo | JSONObject | 否 | {"userId":"120234234","userNick":"Mike","userType":"others"} | 客戶端信息,由ClientInfo結(jié)構(gòu)體通過JSON序列化獲得,包含umid、imei等信息,具體結(jié)構(gòu)描述,請參見ClientInfo。 |
RequestBody
RequestBody中還需要填入以下參數(shù),用來指定個體組和個體信息。
名稱 | 類型 | 是否必選 | 示例值 | 描述 |
personId | String | 是 | person1 | 要操作的個體ID。 |
groupIds | StringArray | 是 | ["group1","group2"] | 要將目標(biāo)個體從中移除的個體組ID列表。 |
返回?cái)?shù)據(jù)
所有請求均返回JSON格式的數(shù)據(jù)。關(guān)于返回?cái)?shù)據(jù)中的公共字段,請參見公共返回參數(shù)。返回?cái)?shù)據(jù)中的data字段表示與業(yè)務(wù)相關(guān)的數(shù)據(jù),一般是一個JSON結(jié)構(gòu)體或數(shù)組。
說明
響應(yīng)出錯的情況下,data字段可能為空。
該接口返回的data字段包含以下參數(shù)。
名稱 | 類型 | 示例值 | 描述 |
code | Integer | 200 | 錯誤碼,和HTTP狀態(tài)碼一致。 更多信息,請參見公共錯誤碼。 |
personId | String | person1 | 個體ID。 |
groupIds | StringArray | ["group1","group2"] | 個體組ID列表。目標(biāo)個體已從這些個體組中移除。 |
示例
請求示例
POST /green/sface/person/groups/delete HTTP/1.1
公共請求頭
{
"personId": "person1",
"groupIds": [
"group1",
"group2"
]
}
正常返回示例
{
"msg": "OK",
"code": 200,
"requestId": "36D384DA-8023-4E84-BCFD-0C5581352C16",
"data": {
"code": 200,
"personId": "person1",
"groupIds": [
"group1",
"group2"
]
}
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
文檔內(nèi)容是否對您有幫助?