getGroupList 操作を呼び出して、すべての個別グループの ID をクエリできます。
QPS 制限
この操作は、アカウントごとに 1 秒あたり最大 20 回呼び出すことができます。1 秒あたりの呼び出し数が制限を超えると、速度制限がトリガーされます。その結果、ビジネスに影響が生じる可能性があります。この操作を呼び出す際は、制限に注意することをお勧めします。
リクエスト構文
POST /green/sface/groups HTTPS|HTTPリクエストヘッダー
この操作では、共通のリクエストヘッダーのみを使用します。詳細については、「共通リクエストヘッダー」をご参照ください。
リクエストパラメーター
パラメーター | タイプ | 必須 | 例 | 説明 |
clientInfo | JSONObject | いいえ | {"userId":"120234234","userNick":"Mike","userType":"others"} | JSON 形式の ClientInfo 構造からシリアル化されたクライアント情報。情報には、クライアントの一意識別子（UMID）と国際移動体装置識別子（IMEI）が含まれます。詳細については、「ClientInfo」をご参照ください。 |
リクエスト本文
リクエスト本文を設定する必要はありません。
レスポンスパラメーター
JSON 形式のデータがすべてのリクエストに対して返されます。共通レスポンスパラメーターの詳細については、「共通レスポンスパラメーター」をご参照ください。レスポンスの data パラメーターは、ビジネス関連データを返すために使用されます。一般に、このパラメーターの値は JSON 構造または配列です。
エラーが発生した場合、data パラメーターは空の場合があります。
次の表は、data フィールドで返されるパラメーターを示しています。
パラメーター | タイプ | 例 | 説明 |
code | Integer | 200 | 返された HTTP ステータスコード。 詳細については、「共通エラーコード」をご参照ください。 |
groupIds | StringArray | ["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"
]
}
}エラーコード
エラーコードのリストについては、サービスエラーコード を参照してください。