調用addPersonToGroup接口將個體添加到個體組。
您可以將一個個體添加到一個或者多個個體組。如果您指定了一個不存在的個體組,則會自動創建該個體組。
說明 最多支持創建100個個體組。
QPS限制
本接口的單用戶QPS限制為10次/秒。超過限制,API調用會被限流,這可能會影響您的業務,請合理調用。
請求語法
POST /green/sface/person/groups/add HTTPS|HTTP
請求頭
該接口使用公共請求頭,無特殊請求頭。請參見公共請求頭。
請求參數
名稱 | 類型 | 是否必選 | 示例值 | 描述 |
clientInfo | JSONObject | 否 | {"userId":"120234234","userNick":"Mike","userType":"others"} | 客戶端信息,由ClientInfo結構體通過JSON序列化獲得,包含umid、imei等信息,具體結構描述,請參見ClientInfo。 |
RequestBody
RequestBody中還需要填入以下參數,用來指定個體和個體組信息。
名稱 | 類型 | 是否必選 | 示例值 | 描述 |
personId | String | 是 | person1 | 要操作的個體ID。 |
groupIds | StringArray | 是 | ["group1","group2"] | 個體要加入的個體組ID列表。 個體組ID僅支持使用英文字母、數字、下劃線(_)和中劃線(-),且不超過32個字符。 說明 如果您指定的個體組ID不存在,則會自動創建該個體組。 |
返回數據
所有請求均返回JSON格式的數據。關于返回數據中的公共字段,請參見公共返回參數。返回數據中的data字段表示與業務相關的數據,一般是一個JSON結構體或數組。
說明
響應出錯的情況下,data字段可能為空。
該接口返回的data字段包含以下參數。
名稱 | 類型 | 示例值 | 描述 |
code | Integer | 200 | 錯誤碼,和HTTP狀態碼一致。 更多信息,請參見公共錯誤碼。 |
personId | String | person1 | 個體ID。 |
groupIds | StringArray | ["group1","group2"] | 個體所屬的個體組ID列表。 |
示例
請求示例
POST /green/sface/person/groups/add 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"
]
}
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
文檔內容是否對您有幫助?