addPersonToGroup 操作を呼び出して、個人を個人のグループに追加できます。
QPS 制限
この操作は、アカウントごとに 1 秒あたり最大 10 回呼び出すことができます。1 秒あたりの呼び出し数が制限を超えると、速度制限がトリガーされます。その結果、ビジネスに影響が生じる可能性があります。この操作を呼び出す際は、制限に注意することをお勧めします。
個人を 1 つ以上の個人のグループに追加できます。存在しない個人のグループを指定すると、個人のグループが自動的に作成されます。
最大 100 個の個人のグループを作成できます。
リクエスト構文
POST /green/sface/person/groups/add HTTPS|HTTPリクエストヘッダー
この操作では、共通のリクエストヘッダーのみを使用します。詳細については、「共通リクエストヘッダー」をご参照ください。
リクエストパラメーター
パラメーター | タイプ | 必須 | 例 | 説明 |
clientInfo | JSONObject | いいえ | {"userId":"120234234","userNick":"Mike","userType":"others"} | JSON 形式の ClientInfo 構造からシリアル化されたクライアント情報。情報には、クライアントの UMID（Unique Machine Identifier）と IMEI（International Mobile Equipment Identity）が含まれます。詳細については、「ClientInfo」をご参照ください。 |
リクエスト本文
リクエスト本文で以下のパラメーターを指定して、個人と個人のグループに関する情報を指定する必要があります。
パラメーター | タイプ | 必須 | 例 | 説明 |
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"
]
}
}エラーコード
エラーコードの一覧については、サービスエラーコード を参照してください。